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

calculates sample mean More...

#include <itkMeanCalculator.h>

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

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

[legend]List of all members.

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

---

Detailed Description

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

calculates sample mean

You plug in the target sample data using SetSample method. Then call the GenerateData method to run the alogithm.

The return value that the GetOutput method where 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. The mean output is an Array rather than a Vector.

Definition at line 47 of file itkMeanCalculator.h.

---

Member Typedef Documentation

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

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

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

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

template<class TSample> typedef Superclass::MeasurementVectorType itk::Statistics::MeanCalculator< TSample >::MeasurementVectorType

Measurement vector type Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >. Definition at line 66 of file itkMeanCalculator.h.

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

Typedef for the mean output Definition at line 69 of file itkMeanCalculator.h. Referenced by itk::Statistics::MeanCalculator< TSample >::~MeanCalculator().

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

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

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

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

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

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

---

Constructor & Destructor Documentation

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

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

Definition at line 76 of file itkMeanCalculator.h. References itk::Statistics::MeanCalculator< TSample >::OutputType.

---

Member Function Documentation

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

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

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

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

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

Returns the mean vector

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

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

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

---

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

• itkMeanCalculator.h

---