itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector > Class Template Reference

This class stores mappings between a query point and its resulting mode point. More...

#include <itkMeanShiftModeCacheMethod.h>

Inheritance diagram for itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector >:

[legend]Collaboration diagram for itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector >:

[legend]List of all members.

[NOHEADER]
virtual const char *	GetNameOfClass () const
Pointer	New ()
Public Types
typedef MeanShiftModeCacheMethod	Self
typedef Object	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TMeasurementVector	MeasurementVectorType
typedef std::map< MeasurementVectorType, MeasurementVectorType, LessMeasurementVector >	CacheTableType
Public Member Functions
void	SetMaximumConsecutiveFailures (unsigned int number)
unsigned int	GetMaximumConsecutiveFailures ()
void	SetHitRatioThreshold (float threshold)
void	SetMaximumEntries (unsigned int number)
unsigned int	GetMaximumEntries ()
bool	SetMeasurementVector (MeasurementVectorType &source, MeasurementVectorType &target)
bool	GetMeasurementVector (MeasurementVectorType &source, MeasurementVectorType &target)
bool	IsFull ()
void	DestroyCacheTable ()
Protected Member Functions
	MeanShiftModeCacheMethod ()
virtual	~MeanShiftModeCacheMethod ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

template<class TMeasurementVector>
class itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector >

This class stores mappings between a query point and its resulting mode point.

To increase the mean shift mode search performance, this class stores mappings between a query point (starting position of search) and the result so that if there is a mapping stored for a specific query point, mode seeker can return the resulting mode point stored in this class.

You can specify how many mappings stored in this class using the SetMaximumEntries method. The cache is destroyed and the rebuild starts when the hit ratio (the number of successful mapping found divided by the number of failure) is below the hit ratio threshold set by the SetHitRatioThreshold method or the number of consecutive failure exceeds the limit set by the SetMaximumConsecutiveFailures method.

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 measurement vectors.

See also:

MeanShiftModeSeekerBase

Definition at line 57 of file itkMeanShiftModeCacheMethod.h.

---

Member Typedef Documentation

template<class TMeasurementVector> typedef std::map< MeasurementVectorType, MeasurementVectorType, LessMeasurementVector > itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector >::CacheTableType

Definition at line 94 of file itkMeanShiftModeCacheMethod.h.

template<class TMeasurementVector> typedef SmartPointer<const Self> itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector >::ConstPointer

Reimplemented from itk::Object. Definition at line 65 of file itkMeanShiftModeCacheMethod.h.

template<class TMeasurementVector> typedef TMeasurementVector itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector >::MeasurementVectorType

Definition at line 72 of file itkMeanShiftModeCacheMethod.h. Referenced by itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector >::LessMeasurementVector::operator()().

template<class TMeasurementVector> typedef SmartPointer<Self> itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector >::Pointer

Reimplemented from itk::Object. Definition at line 64 of file itkMeanShiftModeCacheMethod.h.

template<class TMeasurementVector> typedef MeanShiftModeCacheMethod itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector >::Self

Standard class typedefs. Reimplemented from itk::Object. Definition at line 62 of file itkMeanShiftModeCacheMethod.h.

template<class TMeasurementVector> typedef Object itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector >::Superclass

Reimplemented from itk::Object. Definition at line 63 of file itkMeanShiftModeCacheMethod.h.

---

Constructor & Destructor Documentation

template<class TMeasurementVector> itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector >::MeanShiftModeCacheMethod (   )  [protected]

template<class TMeasurementVector> virtual itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector >::~MeanShiftModeCacheMethod (   )  [protected, virtual]

---

Member Function Documentation

template<class TMeasurementVector> void itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector >::DestroyCacheTable (   )

template<class TMeasurementVector> unsigned int itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector >::GetMaximumConsecutiveFailures (   )  [inline]

Definition at line 99 of file itkMeanShiftModeCacheMethod.h.

template<class TMeasurementVector> unsigned int itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector >::GetMaximumEntries (   )  [inline]

Definition at line 108 of file itkMeanShiftModeCacheMethod.h.

template<class TMeasurementVector> bool itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector >::GetMeasurementVector (  MeasurementVectorType &  source, MeasurementVectorType &  target )

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

Standard Macros Reimplemented from itk::Object.

template<class TMeasurementVector> bool itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector >::IsFull (   )

template<class TMeasurementVector> Pointer itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector >::New (   )  [static]

Standard Macros Reimplemented from itk::Object.

template<class TMeasurementVector> void itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector >::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.

template<class TMeasurementVector> void itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector >::SetHitRatioThreshold (  float  threshold  )  [inline]

Definition at line 102 of file itkMeanShiftModeCacheMethod.h.

template<class TMeasurementVector> void itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector >::SetMaximumConsecutiveFailures (  unsigned int  number  )  [inline]

Definition at line 96 of file itkMeanShiftModeCacheMethod.h.

template<class TMeasurementVector> void itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector >::SetMaximumEntries (  unsigned int  number  )  [inline]

Definition at line 105 of file itkMeanShiftModeCacheMethod.h.

template<class TMeasurementVector> bool itk::Statistics::MeanShiftModeCacheMethod< TMeasurementVector >::SetMeasurementVector (  MeasurementVectorType &  source, MeasurementVectorType &  target )

---

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

• itkMeanShiftModeCacheMethod.h

---