itk::Statistics::SampleAlgorithmBase< TInputSample > Class Template Reference

This class is a base class for algorithms that operate on Sample data. The class is templated over the SampleType, which it takes as input using the SetInputSample() method. Derived classes that operate or calculate statistics on this input sample data and can access it using the GetInputSample() method. More...

#include <itkSampleAlgorithmBase.h>

Inheritance diagram for itk::Statistics::SampleAlgorithmBase< TInputSample >:

[legend]Collaboration diagram for itk::Statistics::SampleAlgorithmBase< TInputSample >:

[legend]List of all members.

[NOHEADER]
virtual const char *	GetNameOfClass () const
Pointer	New ()
Public Types
typedef SampleAlgorithmBase	Self
typedef Object	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef unsigned int	MeasurementVectorSizeType
typedef TInputSample	InputSampleType
typedef InputSampleType::MeasurementVectorType	MeasurementVectorType
Public Member Functions
virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const
virtual void	SetMeasurementVectorSize (MeasurementVectorSizeType _arg)
const TInputSample *	GetInputSample () const
void	Update ()
void	SetInputSample (const TInputSample *sample)
Protected Member Functions
	SampleAlgorithmBase ()
virtual	~SampleAlgorithmBase ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	GenerateData ()

---

Detailed Description

template<class TInputSample>
class itk::Statistics::SampleAlgorithmBase< TInputSample >

This class is a base class for algorithms that operate on Sample data. The class is templated over the SampleType, which it takes as input using the SetInputSample() method. Derived classes that operate or calculate statistics on this input sample data and can access it using the GetInputSample() method.

Definition at line 41 of file itkSampleAlgorithmBase.h.

---

Member Typedef Documentation

template<class TInputSample> typedef SmartPointer< const Self > itk::Statistics::SampleAlgorithmBase< TInputSample >::ConstPointer

Reimplemented from itk::Object. Reimplemented in itk::Statistics::CovarianceCalculator< TSample >, itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >, itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >, itk::Statistics::MeanCalculator< TSample >, itk::Statistics::NeighborhoodSampler< TSample >, itk::Statistics::SampleMeanShiftBlurringFilter< TSample >, itk::Statistics::SampleMeanShiftClusteringFilter< TSample >, itk::Statistics::SampleSelectiveMeanShiftBlurringFilter< TSample >, itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >, itk::Statistics::WeightedCovarianceCalculator< TSample >, itk::Statistics::WeightedMeanCalculator< TSample >, and itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >. Definition at line 48 of file itkSampleAlgorithmBase.h.

template<class TInputSample> typedef TInputSample itk::Statistics::SampleAlgorithmBase< TInputSample >::InputSampleType

Sample typedefs alias Reimplemented in itk::Statistics::NeighborhoodSampler< TSample >, itk::Statistics::SampleMeanShiftBlurringFilter< TSample >, and itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >. Definition at line 59 of file itkSampleAlgorithmBase.h.

template<class TInputSample> typedef unsigned int itk::Statistics::SampleAlgorithmBase< TInputSample >::MeasurementVectorSizeType

Length of a measurement vector Reimplemented in itk::Statistics::CovarianceCalculator< TSample >, itk::Statistics::MeanCalculator< TSample >, itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >, itk::Statistics::WeightedCovarianceCalculator< TSample >, and itk::Statistics::WeightedMeanCalculator< TSample >. Definition at line 56 of file itkSampleAlgorithmBase.h.

template<class TInputSample> typedef InputSampleType::MeasurementVectorType itk::Statistics::SampleAlgorithmBase< TInputSample >::MeasurementVectorType

Reimplemented in itk::Statistics::CovarianceCalculator< TSample >, itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >, itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >, itk::Statistics::MeanCalculator< TSample >, itk::Statistics::NeighborhoodSampler< TSample >, itk::Statistics::SampleMeanShiftBlurringFilter< TSample >, itk::Statistics::SampleMeanShiftClusteringFilter< TSample >, itk::Statistics::SampleSelectiveMeanShiftBlurringFilter< TSample >, itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >, itk::Statistics::WeightedCovarianceCalculator< TSample >, itk::Statistics::WeightedMeanCalculator< TSample >, and itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >. Definition at line 60 of file itkSampleAlgorithmBase.h.

template<class TInputSample> typedef SmartPointer< Self > itk::Statistics::SampleAlgorithmBase< TInputSample >::Pointer

Reimplemented from itk::Object. Reimplemented in itk::Statistics::CovarianceCalculator< TSample >, itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >, itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >, itk::Statistics::MeanCalculator< TSample >, itk::Statistics::NeighborhoodSampler< TSample >, itk::Statistics::SampleMeanShiftBlurringFilter< TSample >, itk::Statistics::SampleMeanShiftClusteringFilter< TSample >, itk::Statistics::SampleSelectiveMeanShiftBlurringFilter< TSample >, itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >, itk::Statistics::WeightedCovarianceCalculator< TSample >, itk::Statistics::WeightedMeanCalculator< TSample >, and itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >. Definition at line 47 of file itkSampleAlgorithmBase.h.

template<class TInputSample> typedef SampleAlgorithmBase itk::Statistics::SampleAlgorithmBase< TInputSample >::Self

Standard class typedefs. Reimplemented from itk::Object. Reimplemented in itk::Statistics::CovarianceCalculator< TSample >, itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >, itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >, itk::Statistics::MeanCalculator< TSample >, itk::Statistics::NeighborhoodSampler< TSample >, itk::Statistics::SampleMeanShiftBlurringFilter< TSample >, itk::Statistics::SampleMeanShiftClusteringFilter< TSample >, itk::Statistics::SampleSelectiveMeanShiftBlurringFilter< TSample >, itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >, itk::Statistics::WeightedCovarianceCalculator< TSample >, itk::Statistics::WeightedMeanCalculator< TSample >, and itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >. Definition at line 45 of file itkSampleAlgorithmBase.h.

template<class TInputSample> typedef Object itk::Statistics::SampleAlgorithmBase< TInputSample >::Superclass

Reimplemented from itk::Object. Reimplemented in itk::Statistics::CovarianceCalculator< TSample >, itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >, itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >, itk::Statistics::MeanCalculator< TSample >, itk::Statistics::NeighborhoodSampler< TSample >, itk::Statistics::SampleMeanShiftBlurringFilter< TSample >, itk::Statistics::SampleMeanShiftClusteringFilter< TSample >, itk::Statistics::SampleSelectiveMeanShiftBlurringFilter< TSample >, itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >, itk::Statistics::WeightedCovarianceCalculator< TSample >, itk::Statistics::WeightedMeanCalculator< TSample >, and itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >. Definition at line 46 of file itkSampleAlgorithmBase.h.

---

Constructor & Destructor Documentation

template<class TInputSample> itk::Statistics::SampleAlgorithmBase< TInputSample >::SampleAlgorithmBase (   )  [protected]

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

Definition at line 93 of file itkSampleAlgorithmBase.h.

---

Member Function Documentation

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

Calculates the mean and save it Reimplemented in itk::Statistics::CovarianceCalculator< TSample >, itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >, itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >, itk::Statistics::MeanCalculator< TSample >, itk::Statistics::NeighborhoodSampler< TSample >, itk::Statistics::SampleMeanShiftBlurringFilter< TSample >, itk::Statistics::SampleMeanShiftClusteringFilter< TSample >, itk::Statistics::SampleSelectiveMeanShiftBlurringFilter< TSample >, itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >, itk::Statistics::WeightedCovarianceCalculator< TSample >, itk::Statistics::WeightedMeanCalculator< TSample >, and itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >.

template<class TInputSample> const TInputSample* itk::Statistics::SampleAlgorithmBase< TInputSample >::GetInputSample (   )  const [inline]

Definition at line 82 of file itkSampleAlgorithmBase.h.

template<class TInputSample> virtual MeasurementVectorSizeType itk::Statistics::SampleAlgorithmBase< TInputSample >::GetMeasurementVectorSize (   )  const [virtual]

Get Macro to get the length of a measurement vector. This is equal to the length of each measurement vector contained in the samples that are plugged in as input to this class. GetMeasurementVectorSize() will return zero until the SetInputSample() method has been called

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

Standard Macros Reimplemented from itk::Object. Reimplemented in itk::Statistics::CovarianceCalculator< TSample >, itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >, itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >, itk::Statistics::MeanCalculator< TSample >, itk::Statistics::NeighborhoodSampler< TSample >, itk::Statistics::SampleMeanShiftBlurringFilter< TSample >, itk::Statistics::SampleMeanShiftClusteringFilter< TSample >, itk::Statistics::SampleSelectiveMeanShiftBlurringFilter< TSample >, itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >, itk::Statistics::WeightedCovarianceCalculator< TSample >, itk::Statistics::WeightedMeanCalculator< TSample >, and itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >.

template<class TInputSample> Pointer itk::Statistics::SampleAlgorithmBase< TInputSample >::New (   )  [static]

Standard Macros Reimplemented from itk::Object. Reimplemented in itk::Statistics::CovarianceCalculator< TSample >, itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >, itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >, itk::Statistics::MeanCalculator< TSample >, itk::Statistics::NeighborhoodSampler< TSample >, itk::Statistics::SampleMeanShiftBlurringFilter< TSample >, itk::Statistics::SampleMeanShiftClusteringFilter< TSample >, itk::Statistics::SampleSelectiveMeanShiftBlurringFilter< TSample >, itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >, itk::Statistics::WeightedCovarianceCalculator< TSample >, itk::Statistics::WeightedMeanCalculator< TSample >, and itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >.

template<class TInputSample> void itk::Statistics::SampleAlgorithmBase< TInputSample >::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::Object. Reimplemented in itk::Statistics::CovarianceCalculator< TSample >, itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >, itk::Statistics::MeanCalculator< TSample >, itk::Statistics::NeighborhoodSampler< TSample >, itk::Statistics::SampleMeanShiftBlurringFilter< TSample >, itk::Statistics::SampleMeanShiftClusteringFilter< TSample >, itk::Statistics::SampleSelectiveMeanShiftBlurringFilter< TSample >, itk::Statistics::SampleToHistogramProjectionFilter< TInputSample, THistogramMeasurement >, itk::Statistics::WeightedCovarianceCalculator< TSample >, itk::Statistics::WeightedMeanCalculator< TSample >, and itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >.

template<class TInputSample> void itk::Statistics::SampleAlgorithmBase< TInputSample >::SetInputSample (  const TInputSample *  sample  )  [inline]

Stores the sample pointer Definition at line 63 of file itkSampleAlgorithmBase.h.

template<class TInputSample> virtual void itk::Statistics::SampleAlgorithmBase< TInputSample >::SetMeasurementVectorSize (  MeasurementVectorSizeType  _arg  )  [virtual]

template<class TInputSample> void itk::Statistics::SampleAlgorithmBase< TInputSample >::Update (  void   )  [inline]

dummy function that calls the GenerateData() function to generate output. It exists for future compatibility with ProcessObject without streaming Definition at line 88 of file itkSampleAlgorithmBase.h.

---

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

• itkSampleAlgorithmBase.h

---