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

Evolves the mode. This is the base class for any mean shift mode seeking algorithm classes. More...

#include <itkMeanShiftModeSeekerBase.h>

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

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

[legend]List of all members.

Public Types
typedef MeanShiftModeSeekerBase	Self
typedef Object	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TSample::MeasurementVectorType	MeasurementVectorType
typedef TSample::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef TSample::MeasurementType	MeasurementType
typedef TSample::InstanceIdentifier	InstanceIdentifier
typedef std::vector< InstanceIdentifier >	SearchResultVectorType
typedef MeanShiftModeCacheMethod< MeasurementVectorType >	CacheMethodType
Public Member Functions
virtual const char *	GetNameOfClass () const
void	SetInputSample (const TSample *sample)
const TSample *	GetInputSample () const
void	SetMaximumIteration (unsigned int number)
unsigned int	GetMaximumIteration ()
void	SetCacheMethod (CacheMethodType *method)
CacheMethodType *	GetCacheMethod ()
MeasurementVectorType	Evolve (MeasurementVectorType instance)
virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const
Protected Member Functions
	MeanShiftModeSeekerBase ()
virtual	~MeanShiftModeSeekerBase ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual bool	ComputeMode (MeasurementVectorType queryPoint, MeasurementVectorType &newPoint)=0

---

Detailed Description

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

Evolves the mode. This is the base class for any mean shift mode seeking algorithm classes.

Any subclass of this class should implement the ComputeMode method. That is the only one requirement. To use this class, user should plug in the input sample using SetInputSample, then call Evolve function with a measurement vector (query point).

There are some operational options. Users can set a cache method to accelates the evolving process. If the cache method already has a pair of a query point and its new mode point, the ComputeMode uses the cached value insteady recalculating the mode. By setting the maximum iteration number (SetMaximumIteration method), when the evolving process exceedes, the process will stop and return the current mode point as the result. With this option turned off (by setting it to 0 or leave it alone after instantiating this class), the evolving process runs until it converges.

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 at run time from the sample set as input.

See also:

MeanShiftModeCacheMethod, SampleMeanShiftBlurringFilter, SampleSelectiveMeanShiftBlurringFilter, SampleMeanShiftClusteringFilter

Definition at line 60 of file itkMeanShiftModeSeekerBase.h.

---

Member Typedef Documentation

template<class TSample> typedef MeanShiftModeCacheMethod< MeasurementVectorType > itk::Statistics::MeanShiftModeSeekerBase< TSample >::CacheMethodType

Definition at line 80 of file itkMeanShiftModeSeekerBase.h. Referenced by itk::Statistics::MeanShiftModeSeekerBase< TSample >::GetCacheMethod().

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

Reimplemented from itk::Object. Reimplemented in itk::Statistics::HypersphereKernelMeanShiftModeSeeker< TSample >. Definition at line 68 of file itkMeanShiftModeSeekerBase.h.

template<class TSample> typedef TSample::InstanceIdentifier itk::Statistics::MeanShiftModeSeekerBase< TSample >::InstanceIdentifier

Definition at line 77 of file itkMeanShiftModeSeekerBase.h.

template<class TSample> typedef TSample::MeasurementType itk::Statistics::MeanShiftModeSeekerBase< TSample >::MeasurementType

Reimplemented in itk::Statistics::HypersphereKernelMeanShiftModeSeeker< TSample >. Definition at line 76 of file itkMeanShiftModeSeekerBase.h.

template<class TSample> typedef TSample::MeasurementVectorSizeType itk::Statistics::MeanShiftModeSeekerBase< TSample >::MeasurementVectorSizeType

Definition at line 75 of file itkMeanShiftModeSeekerBase.h. Referenced by itk::Statistics::MeanShiftModeSeekerBase< TSample >::GetMeasurementVectorSize().

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

Typedefs from the TSample template argument Reimplemented in itk::Statistics::HypersphereKernelMeanShiftModeSeeker< TSample >. Definition at line 74 of file itkMeanShiftModeSeekerBase.h.

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

Reimplemented from itk::Object. Reimplemented in itk::Statistics::HypersphereKernelMeanShiftModeSeeker< TSample >. Definition at line 67 of file itkMeanShiftModeSeekerBase.h.

template<class TSample> typedef std::vector< InstanceIdentifier > itk::Statistics::MeanShiftModeSeekerBase< TSample >::SearchResultVectorType

Reimplemented in itk::Statistics::HypersphereKernelMeanShiftModeSeeker< TSample >. Definition at line 79 of file itkMeanShiftModeSeekerBase.h.

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

Standard class typedefs. Reimplemented from itk::Object. Reimplemented in itk::Statistics::HypersphereKernelMeanShiftModeSeeker< TSample >. Definition at line 65 of file itkMeanShiftModeSeekerBase.h.

template<class TSample> typedef Object itk::Statistics::MeanShiftModeSeekerBase< TSample >::Superclass

Reimplemented from itk::Object. Reimplemented in itk::Statistics::HypersphereKernelMeanShiftModeSeeker< TSample >. Definition at line 66 of file itkMeanShiftModeSeekerBase.h.

---

Constructor & Destructor Documentation

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

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

---

Member Function Documentation

template<class TSample> virtual bool itk::Statistics::MeanShiftModeSeekerBase< TSample >::ComputeMode (  MeasurementVectorType  queryPoint, MeasurementVectorType &  newPoint )  [protected, pure virtual]

Implemented in itk::Statistics::HypersphereKernelMeanShiftModeSeeker< TSample >.

template<class TSample> MeasurementVectorType itk::Statistics::MeanShiftModeSeekerBase< TSample >::Evolve (  MeasurementVectorType  instance  )

Returns the covariance matrix of the target sample data Reimplemented in itk::Statistics::HypersphereKernelMeanShiftModeSeeker< TSample >.

template<class TSample> CacheMethodType* itk::Statistics::MeanShiftModeSeekerBase< TSample >::GetCacheMethod (   )  [inline]

Definition at line 95 of file itkMeanShiftModeSeekerBase.h. References itk::Statistics::MeanShiftModeSeekerBase< TSample >::CacheMethodType.

template<class TSample> const TSample* itk::Statistics::MeanShiftModeSeekerBase< TSample >::GetInputSample (   )  const [inline]

Definition at line 84 of file itkMeanShiftModeSeekerBase.h.

template<class TSample> unsigned int itk::Statistics::MeanShiftModeSeekerBase< TSample >::GetMaximumIteration (   )  [inline]

Definition at line 90 of file itkMeanShiftModeSeekerBase.h.

template<class TSample> virtual MeasurementVectorSizeType itk::Statistics::MeanShiftModeSeekerBase< TSample >::GetMeasurementVectorSize (   )  const [inline, virtual]

Get the length of a measurement vector Definition at line 102 of file itkMeanShiftModeSeekerBase.h. References itk::Statistics::MeanShiftModeSeekerBase< TSample >::MeasurementVectorSizeType.

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

Standard Macros Reimplemented from itk::Object. Reimplemented in itk::Statistics::HypersphereKernelMeanShiftModeSeeker< TSample >.

template<class TSample> void itk::Statistics::MeanShiftModeSeekerBase< 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::Object. Reimplemented in itk::Statistics::HypersphereKernelMeanShiftModeSeeker< TSample >.

template<class TSample> void itk::Statistics::MeanShiftModeSeekerBase< TSample >::SetCacheMethod (  CacheMethodType *  method  )

template<class TSample> void itk::Statistics::MeanShiftModeSeekerBase< TSample >::SetInputSample (  const TSample *  sample  )

template<class TSample> void itk::Statistics::MeanShiftModeSeekerBase< TSample >::SetMaximumIteration (  unsigned int  number  )  [inline]

Definition at line 87 of file itkMeanShiftModeSeekerBase.h.

---

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

• itkMeanShiftModeSeekerBase.h

---