#include <itkMeanSampleFilter.h>

Inheritance diagram for itk::Statistics::MeanSampleFilter< TSample >:

Collaboration diagram for itk::Statistics::MeanSampleFilter< TSample >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef NumericTraits < MeasurementType >::RealType	MeasurementRealType
typedef TSample::MeasurementType	MeasurementType
typedef SimpleDataObjectDecorator < MeasurementVectorRealType >	MeasurementVectorDecoratedType
typedef NumericTraits < MeasurementVectorType > ::RealType	MeasurementVectorRealType
typedef unsigned int	MeasurementVectorSizeType
typedef TSample::MeasurementVectorType	MeasurementVectorType
typedef MeasurementVectorDecoratedType	OutputType
typedef SmartPointer< Self >	Pointer
typedef TSample	SampleType
typedef MeanSampleFilter	Self
typedef ProcessObject	Superclass
Public Types inherited from itk::ProcessObject
typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef std::vector < DataObjectIdentifierType >	NameArray
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
const SampleType *	GetInput () const
const MeasurementVectorRealType	GetMean () const
MeasurementVectorSizeType	GetMeasurementVectorSize () const
const MeasurementVectorDecoratedType *	GetOutput () const
void	SetInput (const SampleType *sample)
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Protected Types
typedef DataObject::Pointer	DataObjectPointer
typedef ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType

Protected Member Functions
void	GenerateData ()
virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)
	MeanSampleFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~MeanSampleFilter ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType	MakeNameFromIndex (DataObjectPointerArraySizeType) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyInputInformation ()
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
virtual void	PushBackInput (const DataObject *input)
virtual void	PopBackInput ()
virtual void	PushFrontInput (const DataObject *input)
virtual void	PopFrontInput ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Member Functions
	MeanSampleFilter (const Self &)
void	operator= (const Self &)
virtual const char *	GetNameOfClass () const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
static Pointer	New ()

Additional Inherited Members
Protected Attributes inherited from itk::ProcessObject
bool	m_Updating
TimeStamp	m_OutputInformationMTime

Detailed Description

template<class TSample>
class itk::Statistics::MeanSampleFilter< TSample >

Given a sample, this filter computes the sample mean.

The sample is plugged in using SetSample method. Then invoke update() method to compute the sample mean.

The sample mean is computed as follows $= \frac{1}{n}\sum^{n}_{i=1}x_{i}$ where $n$ is the number of measurement vectors in the target

Recent API changes: The static const macro to get the length of a measurement vector, 'MeasurementVectorSize' has been removed to allow the length of a measurement vector to be specified at run time. It is now obtained from the input sample. Please use the function GetMeasurementVectorSize() to obtain the length.

Definition at line 48 of file itkMeanSampleFilter.h.

Member Typedef Documentation

template<class TSample >

typedef SmartPointer< const Self > itk::Statistics::MeanSampleFilter< TSample >::ConstPointer

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::WeightedMeanSampleFilter< TSample >.

Definition at line 55 of file itkMeanSampleFilter.h.

template<class TSample >

typedef DataObject::Pointer itk::Statistics::MeanSampleFilter< TSample >::DataObjectPointer

protected

DataObject pointer

Reimplemented from itk::ProcessObject.

Definition at line 95 of file itkMeanSampleFilter.h.

template<class TSample >

typedef ProcessObject::DataObjectPointerArraySizeType itk::Statistics::MeanSampleFilter< TSample >::DataObjectPointerArraySizeType

protected

Reimplemented from itk::ProcessObject.

Definition at line 97 of file itkMeanSampleFilter.h.

template<class TSample >

typedef NumericTraits< MeasurementType >::RealType itk::Statistics::MeanSampleFilter< TSample >::MeasurementRealType

Reimplemented in itk::Statistics::WeightedMeanSampleFilter< TSample >.

Definition at line 67 of file itkMeanSampleFilter.h.

template<class TSample >

typedef TSample::MeasurementType itk::Statistics::MeanSampleFilter< TSample >::MeasurementType

Reimplemented in itk::Statistics::WeightedMeanSampleFilter< TSample >.

Definition at line 66 of file itkMeanSampleFilter.h.

template<class TSample >

typedef SimpleDataObjectDecorator< MeasurementVectorRealType > itk::Statistics::MeanSampleFilter< TSample >::MeasurementVectorDecoratedType

MeasurementVector is not a DataObject, we need to decorate it to push it down a ProcessObject's pipeline

Reimplemented in itk::Statistics::WeightedMeanSampleFilter< TSample >.

Definition at line 78 of file itkMeanSampleFilter.h.

template<class TSample >

typedef NumericTraits< MeasurementVectorType >::RealType itk::Statistics::MeanSampleFilter< TSample >::MeasurementVectorRealType

Reimplemented in itk::Statistics::WeightedMeanSampleFilter< TSample >.

Definition at line 68 of file itkMeanSampleFilter.h.

template<class TSample >

typedef unsigned int itk::Statistics::MeanSampleFilter< TSample >::MeasurementVectorSizeType

Length of a measurement vector

Reimplemented in itk::Statistics::WeightedMeanSampleFilter< TSample >.

Definition at line 60 of file itkMeanSampleFilter.h.

template<class TSample >

typedef TSample::MeasurementVectorType itk::Statistics::MeanSampleFilter< TSample >::MeasurementVectorType

Reimplemented in itk::Statistics::WeightedMeanSampleFilter< TSample >.

Definition at line 65 of file itkMeanSampleFilter.h.

template<class TSample >

typedef MeasurementVectorDecoratedType itk::Statistics::MeanSampleFilter< TSample >::OutputType

Reimplemented in itk::Statistics::WeightedMeanSampleFilter< TSample >.

Definition at line 80 of file itkMeanSampleFilter.h.

template<class TSample >

typedef SmartPointer< Self > itk::Statistics::MeanSampleFilter< TSample >::Pointer

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::WeightedMeanSampleFilter< TSample >.

Definition at line 54 of file itkMeanSampleFilter.h.

template<class TSample >

typedef TSample itk::Statistics::MeanSampleFilter< TSample >::SampleType

Reimplemented in itk::Statistics::WeightedMeanSampleFilter< TSample >.

Definition at line 56 of file itkMeanSampleFilter.h.

template<class TSample >

typedef MeanSampleFilter itk::Statistics::MeanSampleFilter< TSample >::Self

Standard class typedefs.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::WeightedMeanSampleFilter< TSample >.

Definition at line 52 of file itkMeanSampleFilter.h.

template<class TSample >

typedef ProcessObject itk::Statistics::MeanSampleFilter< TSample >::Superclass

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::WeightedMeanSampleFilter< TSample >.

Definition at line 53 of file itkMeanSampleFilter.h.

Constructor & Destructor Documentation

template<class TSample >

itk::Statistics::MeanSampleFilter< TSample >::MeanSampleFilter ( )

protected

template<class TSample >

virtual itk::Statistics::MeanSampleFilter< TSample >::~MeanSampleFilter ( )

protectedvirtual

template<class TSample >

itk::Statistics::MeanSampleFilter< TSample >::MeanSampleFilter ( const Self & )

private

Member Function Documentation

template<class TSample >

virtual::itk::LightObject::Pointer itk::Statistics::MeanSampleFilter< TSample >::CreateAnother ( void ) const

virtual

Standard Macros

Reimplemented from itk::Object.

Reimplemented in itk::Statistics::WeightedMeanSampleFilter< TSample >.

template<class TSample >

void itk::Statistics::MeanSampleFilter< TSample >::GenerateData ( void )

protectedvirtual

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::WeightedMeanSampleFilter< TSample >.

template<class TSample >

const SampleType* itk::Statistics::MeanSampleFilter< TSample >::GetInput ( ) const

template<class TSample >

const MeasurementVectorRealType itk::Statistics::MeanSampleFilter< TSample >::GetMean ( ) const

template<class TSample >

MeasurementVectorSizeType itk::Statistics::MeanSampleFilter< TSample >::GetMeasurementVectorSize ( ) const

template<class TSample >

virtual const char* itk::Statistics::MeanSampleFilter< TSample >::GetNameOfClass ( ) const

virtual

Standard Macros

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::WeightedMeanSampleFilter< TSample >.

template<class TSample >

const MeasurementVectorDecoratedType* itk::Statistics::MeanSampleFilter< TSample >::GetOutput ( ) const

Get the mean measurement vector

template<class TSample >

virtual DataObjectPointer itk::Statistics::MeanSampleFilter< TSample >::MakeOutput ( DataObjectPointerArraySizeType idx )

protectedvirtual

Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a itkSmartPointer to a DataObject. ImageSource and MeshSource override this method to create the correct type of image and mesh respectively. If a filter has multiple outputs of different types, then that filter must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

template<class TSample >

static Pointer itk::Statistics::MeanSampleFilter< TSample >::New ( )

static

Standard Macros

Reimplemented from itk::Object.

Reimplemented in itk::Statistics::WeightedMeanSampleFilter< TSample >.

template<class TSample >

void itk::Statistics::MeanSampleFilter< TSample >::operator= ( const Self & )

private

Time when GenerateOutputInformation was last called.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::WeightedMeanSampleFilter< TSample >.

template<class TSample >

void itk::Statistics::MeanSampleFilter< TSample >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::Statistics::WeightedMeanSampleFilter< TSample >.

template<class TSample >

void itk::Statistics::MeanSampleFilter< TSample >::SetInput ( const SampleType * sample )

The documentation for this class was generated from the following file:

itkMeanSampleFilter.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

template<class TSample> class itk::Statistics::MeanSampleFilter< TSample >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<class TSample>
class itk::Statistics::MeanSampleFilter< TSample >