itk::Statistics::WeightedMeanSampleFilter< TSample > Class Template Reference

#include <itkWeightedMeanSampleFilter.h>

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

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

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SimpleDataObjectDecorator < WeightArrayType >	InputWeightArrayObjectType
typedef DataObjectDecorator < WeightingFunctionType >	InputWeightingFunctionObjectType
typedef Superclass::MeasurementRealType	MeasurementRealType
typedef Superclass::MeasurementType	MeasurementType
typedef Superclass::MeasurementVectorDecoratedType	MeasurementVectorDecoratedType
typedef Superclass::MeasurementVectorRealType	MeasurementVectorRealType
typedef Superclass::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef Superclass::MeasurementVectorType	MeasurementVectorType
typedef Superclass::OutputType	OutputType
typedef SmartPointer< Self >	Pointer
typedef Superclass::SampleType	SampleType
typedef WeightedMeanSampleFilter	Self
typedef MeanSampleFilter< TSample >	Superclass
typedef Array< double >	WeightArrayType
typedef FunctionBase < MeasurementVectorType, double >	WeightingFunctionType
Public Types inherited from itk::Statistics::MeanSampleFilter< TSample >
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
	itkSetGetDecoratedInputMacro (Weights, WeightArrayType)
	itkSetGetDecoratedObjectInputMacro (WeightingFunction, WeightingFunctionType)
Public Member Functions inherited from itk::Statistics::MeanSampleFilter< TSample >
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 Member Functions
void	ComputeMeanWithWeightingFunction ()
void	ComputeMeanWithWeights ()
void	GenerateData ()
void	PrintSelf (std::ostream &os, Indent indent) const
	WeightedMeanSampleFilter ()
virtual	~WeightedMeanSampleFilter ()
Protected Member Functions inherited from itk::Statistics::MeanSampleFilter< TSample >
virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)
	MeanSampleFilter ()
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
void	operator= (const Self &)
	WeightedMeanSampleFilter (const Self &)
virtual const char *	GetNameOfClass () const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
static Pointer	New ()

Additional Inherited Members
Protected Types inherited from itk::Statistics::MeanSampleFilter< TSample >
typedef DataObject::Pointer	DataObjectPointer
typedef ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType

---

Detailed Description

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

Given a sample where each measurement vector has associated weight value, this filter computes the sample mean.

To run this algorithm, you have plug in the target sample data using SetInput method and provides weight by an array or function. . Then call the Update method to run the alogithm.

See also:

MeanSampleFilter

Definition at line 42 of file itkWeightedMeanSampleFilter.h.

---

Member Typedef Documentation

template<class TSample >

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

Reimplemented from itk::Statistics::MeanSampleFilter< TSample >.

Definition at line 49 of file itkWeightedMeanSampleFilter.h.

template<class TSample >

typedef SimpleDataObjectDecorator< WeightArrayType > itk::Statistics::WeightedMeanSampleFilter< TSample >::InputWeightArrayObjectType

Type of DataObjects to use for the weight array type

Definition at line 70 of file itkWeightedMeanSampleFilter.h.

template<class TSample >

typedef DataObjectDecorator< WeightingFunctionType > itk::Statistics::WeightedMeanSampleFilter< TSample >::InputWeightingFunctionObjectType

Type of DataObjects to use for Weight function

Definition at line 79 of file itkWeightedMeanSampleFilter.h.

template<class TSample >

typedef Superclass::MeasurementRealType itk::Statistics::WeightedMeanSampleFilter< TSample >::MeasurementRealType

Reimplemented from itk::Statistics::MeanSampleFilter< TSample >.

Definition at line 63 of file itkWeightedMeanSampleFilter.h.

template<class TSample >

typedef Superclass::MeasurementType itk::Statistics::WeightedMeanSampleFilter< TSample >::MeasurementType

Reimplemented from itk::Statistics::MeanSampleFilter< TSample >.

Definition at line 58 of file itkWeightedMeanSampleFilter.h.

template<class TSample >

typedef Superclass::MeasurementVectorDecoratedType itk::Statistics::WeightedMeanSampleFilter< TSample >::MeasurementVectorDecoratedType

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

Reimplemented from itk::Statistics::MeanSampleFilter< TSample >.

Definition at line 61 of file itkWeightedMeanSampleFilter.h.

template<class TSample >

typedef Superclass::MeasurementVectorRealType itk::Statistics::WeightedMeanSampleFilter< TSample >::MeasurementVectorRealType

Reimplemented from itk::Statistics::MeanSampleFilter< TSample >.

Definition at line 64 of file itkWeightedMeanSampleFilter.h.

template<class TSample >

typedef Superclass::MeasurementVectorSizeType itk::Statistics::WeightedMeanSampleFilter< TSample >::MeasurementVectorSizeType

Length of a measurement vector

Reimplemented from itk::Statistics::MeanSampleFilter< TSample >.

Definition at line 60 of file itkWeightedMeanSampleFilter.h.

template<class TSample >

typedef Superclass::MeasurementVectorType itk::Statistics::WeightedMeanSampleFilter< TSample >::MeasurementVectorType

Reimplemented from itk::Statistics::MeanSampleFilter< TSample >.

Definition at line 59 of file itkWeightedMeanSampleFilter.h.

template<class TSample >

typedef Superclass::OutputType itk::Statistics::WeightedMeanSampleFilter< TSample >::OutputType

Reimplemented from itk::Statistics::MeanSampleFilter< TSample >.

Definition at line 62 of file itkWeightedMeanSampleFilter.h.

template<class TSample >

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

Reimplemented from itk::Statistics::MeanSampleFilter< TSample >.

Definition at line 48 of file itkWeightedMeanSampleFilter.h.

template<class TSample >

typedef Superclass::SampleType itk::Statistics::WeightedMeanSampleFilter< TSample >::SampleType

Traits derived from the base class

Reimplemented from itk::Statistics::MeanSampleFilter< TSample >.

Definition at line 53 of file itkWeightedMeanSampleFilter.h.

template<class TSample >

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

Standard class typedefs.

Reimplemented from itk::Statistics::MeanSampleFilter< TSample >.

Definition at line 46 of file itkWeightedMeanSampleFilter.h.

template<class TSample >

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

Reimplemented from itk::Statistics::MeanSampleFilter< TSample >.

Definition at line 47 of file itkWeightedMeanSampleFilter.h.

template<class TSample >

typedef Array< double > itk::Statistics::WeightedMeanSampleFilter< TSample >::WeightArrayType

Array typedef for weights

Definition at line 67 of file itkWeightedMeanSampleFilter.h.

template<class TSample >

typedef FunctionBase< MeasurementVectorType, double > itk::Statistics::WeightedMeanSampleFilter< TSample >::WeightingFunctionType

Weight calculation function typedef

Definition at line 76 of file itkWeightedMeanSampleFilter.h.

---

Constructor & Destructor Documentation

template<class TSample >

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

protected

template<class TSample >

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

protectedvirtual

template<class TSample >

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

private

---

Member Function Documentation

template<class TSample >

void itk::Statistics::WeightedMeanSampleFilter< TSample >::ComputeMeanWithWeightingFunction ( )

protected

template<class TSample >

void itk::Statistics::WeightedMeanSampleFilter< TSample >::ComputeMeanWithWeights ( )

protected

template<class TSample >

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

virtual

Standard Macros

Reimplemented from itk::Statistics::MeanSampleFilter< TSample >.

template<class TSample >

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

protectedvirtual

This method causes the filter to generate its output.

Reimplemented from itk::Statistics::MeanSampleFilter< TSample >.

template<class TSample >

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

virtual

Standard Macros

Reimplemented from itk::Statistics::MeanSampleFilter< TSample >.

template<class TSample >

itk::Statistics::WeightedMeanSampleFilter< TSample >::itkSetGetDecoratedInputMacro	(	Weights	,
		WeightArrayType
	)

Method to set the input value of the weight array

template<class TSample >

itk::Statistics::WeightedMeanSampleFilter< TSample >::itkSetGetDecoratedObjectInputMacro	(	WeightingFunction	,
		WeightingFunctionType
	)

Method to set the weighting function

template<class TSample >

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

static

Standard Macros

Reimplemented from itk::Statistics::MeanSampleFilter< TSample >.

template<class TSample >

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

private

Time when GenerateOutputInformation was last called.

Reimplemented from itk::Statistics::MeanSampleFilter< TSample >.

template<class TSample >

void itk::Statistics::WeightedMeanSampleFilter< 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::Statistics::MeanSampleFilter< TSample >.

---

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

• itkWeightedMeanSampleFilter.h