ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Private Member Functions
itk::Statistics::MeanSampleFilter< TSample > Class Template Reference

Given a sample, this filter computes the sample mean. More...

#include <itkMeanSampleFilter.h>

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

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
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< SelfPointer
typedef TSample SampleType
typedef MeanSampleFilter Self
typedef ProcessObject Superclass

Public Member Functions

const SampleTypeGetInput () const
const MeasurementVectorRealType GetMean () const
MeasurementVectorSizeType GetMeasurementVectorSize () const
const
MeasurementVectorDecoratedType
GetOutput () const
void SetInput (const SampleType *sample)

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 ()

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 ()

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.

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.

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

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

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 [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::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: