Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

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

#include <itkMeanShiftModeCacheMethod.h>

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

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

Collaboration graph
[legend]
List of all members.

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.
virtual const char * GetNameOfClass () const
static Pointer New ()

Public Types

typedef std::map< MeasurementVectorType,
MeasurementVectorType, LessMeasurementVector
CacheTableType
typedef SmartPointer< const
Self
ConstPointer
typedef TMeasurementVector MeasurementVectorType
typedef SmartPointer< SelfPointer
typedef MeanShiftModeCacheMethod Self
typedef Object Superclass

Public Member Functions

virtual LightObject::Pointer CreateAnother () const
virtual void DebugOff () const
virtual void DebugOn () const
virtual void Delete ()
void DestroyCacheTable ()
CommandGetCommand (unsigned long tag)
bool GetDebug () const
unsigned int GetMaximumConsecutiveFailures ()
unsigned int GetMaximumEntries ()
bool GetMeasurementVector (MeasurementVectorType &source, MeasurementVectorType &target)
const MetaDataDictionaryGetMetaDataDictionary (void) const
MetaDataDictionaryGetMetaDataDictionary (void)
virtual unsigned long GetMTime () const
virtual int GetReferenceCount () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &) const
void InvokeEvent (const EventObject &)
bool IsFull ()
virtual void Modified () const
void Print (std::ostream &os, Indent indent=0) const
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetHitRatioThreshold (float threshold)
void SetMaximumConsecutiveFailures (unsigned int number)
void SetMaximumEntries (unsigned int number)
bool SetMeasurementVector (MeasurementVectorType &source, MeasurementVectorType &target)
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () const
unsigned long AddObserver (const EventObject &event, Command *) const
unsigned long AddObserver (const EventObject &event, Command *)

Static Public Member Functions

static void BreakOnError ()
static bool GetGlobalWarningDisplay ()
static void GlobalWarningDisplayOff ()
static void GlobalWarningDisplayOn ()
static void SetGlobalWarningDisplay (bool flag)

Protected Member Functions

 MeanShiftModeCacheMethod ()
bool PrintObservers (std::ostream &os, Indent indent) const
void PrintSelf (std::ostream &os, Indent indent) const
virtual ~MeanShiftModeCacheMethod ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const

Protected Attributes

int m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock

Classes

struct  LessMeasurementVector


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 69 of file itkMeanShiftModeCacheMethod.h.

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

unsigned long itk::Object::AddObserver ( const EventObject event,
Command  
) const [inherited]

unsigned long itk::Object::AddObserver ( const EventObject event,
Command  
) [inherited]

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

static void itk::LightObject::BreakOnError (  )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual LightObject::Pointer itk::Object::CreateAnother (  )  const [virtual, inherited]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightObject.

virtual void itk::Object::DebugOff (  )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (  )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (  )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

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

Command* itk::Object::GetCommand ( unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug (  )  const [inherited]

Get the value of the debug flag.

static bool itk::Object::GetGlobalWarningDisplay (  )  [static, inherited]

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 
)

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void   )  const [inherited]

Returns:
A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void   )  [inherited]

Returns:
A reference to this objects MetaDataDictionary.
Warning:
This reference may be changed.

virtual unsigned long itk::Object::GetMTime (  )  const [virtual, inherited]

Return this objects modified time.

Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >, itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >, itk::PointSetToImageRegistrationMethod< TFixedPointSet, TMovingImage >, itk::PointSetToPointSetRegistrationMethod< TFixedPointSet, TMovingPointSet >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::ImageAdaptor< TImage, TAccessor >, itk::ImageSpatialObject< TDimension, TPixelType >, itk::MeshSpatialObject< TMesh >, itk::SceneSpatialObject< TSpaceDimension >, itk::SpatialObject< TDimension >, itk::ImageAdaptor< TImage, itk::Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageAdaptor< itk::VectorImage< TPixelType, Dimension >, itk::Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, itk::PixelAccessor< TInternalType, TExternalType > >, itk::ImageAdaptor< TImage, itk::Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, itk::Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageSpatialObject< TDimension, unsigned char >, itk::SpatialObject< 3 >, and itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

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

Standard Macros

Reimplemented from itk::Object.

virtual int itk::LightObject::GetReferenceCount (  )  const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 98 of file itkLightObject.h.

static void itk::Object::GlobalWarningDisplayOff (  )  [inline, static, inherited]

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (  )  [inline, static, inherited]

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject event  )  const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent ( const EventObject  )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent ( const EventObject  )  [inherited]

Call Execute on all the Commands observing this event id.

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

virtual void itk::Object::Modified (  )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Reimplemented in itk::NormalizeImageFilter< TInputImage, TOutputImage >, itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, itk::Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageAdaptor< itk::VectorImage< TPixelType, Dimension >, itk::Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, itk::PixelAccessor< TInternalType, TExternalType > >, itk::ImageAdaptor< TImage, itk::Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, itk::Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, and itk::ImageAdaptor< TImage, itk::Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

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

Standard Macros

Reimplemented from itk::Object.

void itk::LightObject::Print ( std::ostream &  os,
Indent  indent = 0 
) const [inherited]

Cause the object to print itself out.

Referenced by itk::WeakPointer< itk::ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader ( std::ostream &  os,
Indent  indent 
) const [protected, virtual, inherited]

bool itk::Object::PrintObservers ( std::ostream &  os,
Indent  indent 
) const [protected, inherited]

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.

virtual void itk::LightObject::PrintTrailer ( std::ostream &  os,
Indent  indent 
) const [protected, virtual, inherited]

virtual void itk::Object::Register (  )  const [virtual, inherited]

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (  )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

void itk::Object::SetDebug ( bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

static void itk::Object::SetGlobalWarningDisplay ( bool  flag  )  [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

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 
)

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary rhs  )  [inherited]

Returns:
Set the MetaDataDictionary

virtual void itk::Object::SetReferenceCount ( int   )  [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

virtual void itk::Object::UnRegister (  )  const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.


Member Data Documentation

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 122 of file itkLightObject.h.


The documentation for this class was generated from the following file:
Generated at Mon Mar 12 12:04:52 2007 for ITK by doxygen 1.5.1 written by Dimitri van Heesch, © 1997-2000