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 Member Functions
	itkSetGetDecoratedInputMacro (Weights, WeightArrayType)
	itkSetGetDecoratedObjectInputMacro (WeightingFunction, WeightingFunctionType)
Protected Member Functions
void	ComputeMeanWithWeightingFunction ()
void	ComputeMeanWithWeights ()
void	GenerateData ()
void	PrintSelf (std::ostream &os, Indent indent) const
	WeightedMeanSampleFilter ()
virtual	~WeightedMeanSampleFilter ()
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 ()

---

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

(

)

[protected, virtual]

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

)

[protected, virtual]

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 [protected, virtual]

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