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

calculates sample mean where each measurement vector has associated weight value More...

#include <itkWeightedMeanCalculator.h>

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

[legend]Collaboration diagram for itk::Statistics::WeightedMeanCalculator< TSample >:

[legend]List of all members.

[NOHEADER]
virtual const char *	GetNameOfClass () const
Pointer	New ()
Public Types
typedef WeightedMeanCalculator	Self
typedef SampleAlgorithmBase< TSample >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef TSample::MeasurementVectorType	MeasurementVectorType
typedef Array< double >	OutputType
typedef Array< double >	WeightArrayType
typedef FunctionBase< MeasurementVectorType, double >	WeightFunctionType
Public Member Functions
void	SetWeights (WeightArrayType *array)
WeightArrayType *	GetWeights ()
void	SetWeightFunction (WeightFunctionType *func)
WeightFunctionType *	GetWeightFunction ()
OutputType *	GetOutput ()
Protected Member Functions
	WeightedMeanCalculator ()
virtual	~WeightedMeanCalculator ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	GenerateData ()

---

Detailed Description

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

calculates sample mean where each measurement vector has associated weight value

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

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. The mean output is an Array rather than a Vector.

See also:

MeanCalculator SampleAlgorithmBase

Definition at line 50 of file itkWeightedMeanCalculator.h.

---

Member Typedef Documentation

template<class TSample> typedef SmartPointer<const Self> itk::Statistics::WeightedMeanCalculator< TSample >::ConstPointer

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >. Definition at line 58 of file itkWeightedMeanCalculator.h.

template<class TSample> typedef Superclass::MeasurementVectorSizeType itk::Statistics::WeightedMeanCalculator< TSample >::MeasurementVectorSizeType

Length of a measurement vector Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >. Definition at line 66 of file itkWeightedMeanCalculator.h.

template<class TSample> typedef TSample::MeasurementVectorType itk::Statistics::WeightedMeanCalculator< TSample >::MeasurementVectorType

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >. Definition at line 68 of file itkWeightedMeanCalculator.h.

template<class TSample> typedef Array< double > itk::Statistics::WeightedMeanCalculator< TSample >::OutputType

Typedef for the mean output Definition at line 71 of file itkWeightedMeanCalculator.h. Referenced by itk::Statistics::WeightedMeanCalculator< TSample >::~WeightedMeanCalculator().

template<class TSample> typedef SmartPointer<Self> itk::Statistics::WeightedMeanCalculator< TSample >::Pointer

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >. Definition at line 57 of file itkWeightedMeanCalculator.h.

template<class TSample> typedef WeightedMeanCalculator itk::Statistics::WeightedMeanCalculator< TSample >::Self

Standard class typedefs. Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >. Definition at line 55 of file itkWeightedMeanCalculator.h.

template<class TSample> typedef SampleAlgorithmBase< TSample > itk::Statistics::WeightedMeanCalculator< TSample >::Superclass

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >. Definition at line 56 of file itkWeightedMeanCalculator.h.

template<class TSample> typedef Array< double > itk::Statistics::WeightedMeanCalculator< TSample >::WeightArrayType

Array typedef for weights Definition at line 74 of file itkWeightedMeanCalculator.h. Referenced by itk::Statistics::WeightedMeanCalculator< TSample >::~WeightedMeanCalculator().

template<class TSample> typedef FunctionBase< MeasurementVectorType, double > itk::Statistics::WeightedMeanCalculator< TSample >::WeightFunctionType

Weight calculation function typedef Definition at line 83 of file itkWeightedMeanCalculator.h. Referenced by itk::Statistics::WeightedMeanCalculator< TSample >::~WeightedMeanCalculator().

---

Constructor & Destructor Documentation

template<class TSample> itk::Statistics::WeightedMeanCalculator< TSample >::WeightedMeanCalculator (   )  [protected]

template<class TSample> virtual itk::Statistics::WeightedMeanCalculator< TSample >::~WeightedMeanCalculator (   )  [inline, protected, virtual]

Definition at line 98 of file itkWeightedMeanCalculator.h. References itk::Statistics::WeightedMeanCalculator< TSample >::OutputType, itk::Statistics::WeightedMeanCalculator< TSample >::WeightArrayType, and itk::Statistics::WeightedMeanCalculator< TSample >::WeightFunctionType.

---

Member Function Documentation

template<class TSample> void itk::Statistics::WeightedMeanCalculator< TSample >::GenerateData (   )  [protected, virtual]

Calculates the mean and save it Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

template<class TSample> virtual const char* itk::Statistics::WeightedMeanCalculator< TSample >::GetNameOfClass (   )  const [virtual]

Standard Macros Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

template<class TSample> OutputType* itk::Statistics::WeightedMeanCalculator< TSample >::GetOutput (   )

Returns the mean vector as the result

template<class TSample> WeightFunctionType* itk::Statistics::WeightedMeanCalculator< TSample >::GetWeightFunction (   )

Gets the weight function

template<class TSample> WeightArrayType* itk::Statistics::WeightedMeanCalculator< TSample >::GetWeights (   )

Gets the weights array

template<class TSample> Pointer itk::Statistics::WeightedMeanCalculator< TSample >::New (   )  [static]

Standard Macros Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

template<class TSample> void itk::Statistics::WeightedMeanCalculator< 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::SampleAlgorithmBase< TSample >.

template<class TSample> void itk::Statistics::WeightedMeanCalculator< TSample >::SetWeightFunction (  WeightFunctionType *  func  )

Sets the wiehts using an function the function should have a method, Evaluate(MeasurementVectorType&)

template<class TSample> void itk::Statistics::WeightedMeanCalculator< TSample >::SetWeights (  WeightArrayType *  array  )

Sets the weights using an array

---

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

• itkWeightedMeanCalculator.h

---