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

#include <itkHypersphereKernelMeanShiftModeSeeker.h>

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

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

[legend]List of all members.

---

Detailed Description

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

Evolves the mode using a hyperspherical kernel defined by a radius (which is set by SetRadius) method.

Recent API changes The static const macro MeasurementVectorSize has been removed to allow the length of the measurementvector to be determined at run time. It is now obtained from the sample set as input. The typedef for MeasurementVectorSumType has changed from FixedArray to Array.

See also:

MeanShiftModeSeekerBase

Definition at line 43 of file itkHypersphereKernelMeanShiftModeSeeker.h.

Public Types
typedef MeanShiftModeCacheMethod< MeasurementVectorType >	CacheMethodType
typedef SmartPointer< const Self >	ConstPointer
typedef TSample::InstanceIdentifier	InstanceIdentifier
typedef Superclass::MeasurementType	MeasurementType
typedef TSample::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef Array< RealMeasurementType >	MeasurementVectorSumType
typedef Superclass::MeasurementVectorType	MeasurementVectorType
typedef SmartPointer< Self >	Pointer
typedef double	RealMeasurementType
typedef Superclass::SearchResultVectorType	SearchResultVectorType
typedef HypersphereKernelMeanShiftModeSeeker	Self
typedef MeanShiftModeSeekerBase< TSample >	Superclass
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
MeasurementVectorType	Evolve (MeasurementVectorType instance)
CacheMethodType *	GetCacheMethod ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
const TSample *	GetInputSample () const
unsigned int	GetMaximumIteration ()
Get the length of a measurement vector *virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
Standard Macros *virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
double	GetSearchRadius ()
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
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	SetCacheMethod (CacheMethodType *method)
void	SetDebug (bool debugFlag) const
void	SetInputSample (const TSample *sample)
void	SetMaximumIteration (unsigned int number)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
void	SetSearchRadius (double radius)
virtual void	UnRegister () const
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
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 unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Protected Member Functions
bool	ComputeMode (MeasurementVectorType queryPoint, MeasurementVectorType &newPoint)
	HypersphereKernelMeanShiftModeSeeker ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~HypersphereKernelMeanShiftModeSeeker ()
Protected Attributes
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Methods invoked by virtual 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.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

---

Member Typedef Documentation

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

Definition at line 80 of file itkMeanShiftModeSeekerBase.h.

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

Reimplemented from itk::Statistics::MeanShiftModeSeekerBase< TSample >. Definition at line 51 of file itkHypersphereKernelMeanShiftModeSeeker.h.

template<class TSample> typedef TSample::InstanceIdentifier itk::Statistics::MeanShiftModeSeekerBase< TSample >::InstanceIdentifier [inherited]

Definition at line 77 of file itkMeanShiftModeSeekerBase.h.

template<class TSample> typedef Superclass::MeasurementType itk::Statistics::HypersphereKernelMeanShiftModeSeeker< TSample >::MeasurementType

Reimplemented from itk::Statistics::MeanShiftModeSeekerBase< TSample >. Definition at line 62 of file itkHypersphereKernelMeanShiftModeSeeker.h.

template<class TSample> typedef TSample::MeasurementVectorSizeType itk::Statistics::MeanShiftModeSeekerBase< TSample >::MeasurementVectorSizeType [inherited]

Definition at line 75 of file itkMeanShiftModeSeekerBase.h.

template<class TSample> typedef Array< RealMeasurementType > itk::Statistics::HypersphereKernelMeanShiftModeSeeker< TSample >::MeasurementVectorSumType

Type fot the sum of measurement vectors used in computing the new mode Definition at line 69 of file itkHypersphereKernelMeanShiftModeSeeker.h.

template<class TSample> typedef Superclass::MeasurementVectorType itk::Statistics::HypersphereKernelMeanShiftModeSeeker< TSample >::MeasurementVectorType

Typedefs from the superclass Reimplemented from itk::Statistics::MeanShiftModeSeekerBase< TSample >. Definition at line 56 of file itkHypersphereKernelMeanShiftModeSeeker.h.

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

Reimplemented from itk::Statistics::MeanShiftModeSeekerBase< TSample >. Definition at line 50 of file itkHypersphereKernelMeanShiftModeSeeker.h.

template<class TSample> typedef double itk::Statistics::HypersphereKernelMeanShiftModeSeeker< TSample >::RealMeasurementType

Type for the sum of measurements Definition at line 65 of file itkHypersphereKernelMeanShiftModeSeeker.h.

template<class TSample> typedef Superclass::SearchResultVectorType itk::Statistics::HypersphereKernelMeanShiftModeSeeker< TSample >::SearchResultVectorType

Reimplemented from itk::Statistics::MeanShiftModeSeekerBase< TSample >. Definition at line 61 of file itkHypersphereKernelMeanShiftModeSeeker.h.

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

Standard class typedefs. Reimplemented from itk::Statistics::MeanShiftModeSeekerBase< TSample >. Definition at line 48 of file itkHypersphereKernelMeanShiftModeSeeker.h.

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

Reimplemented from itk::Statistics::MeanShiftModeSeekerBase< TSample >. Definition at line 49 of file itkHypersphereKernelMeanShiftModeSeeker.h.

---

Constructor & Destructor Documentation

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

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

---

Member Function Documentation

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

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

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

Computes the new mode with the given query point (queryPoint). The new mode will be stored in the newPoint Implements itk::Statistics::MeanShiftModeSeekerBase< TSample >.

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 TSample> MeasurementVectorType itk::Statistics::HypersphereKernelMeanShiftModeSeeker< TSample >::Evolve (  MeasurementVectorType  instance  )

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

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

Definition at line 95 of file itkMeanShiftModeSeekerBase.h.

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 TSample> const TSample* itk::Statistics::MeanShiftModeSeekerBase< TSample >::GetInputSample (   )  const [inline, inherited]

Definition at line 84 of file itkMeanShiftModeSeekerBase.h.

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

Definition at line 90 of file itkMeanShiftModeSeekerBase.h.

template<class TSample> Get the length of a measurement vector* virtual MeasurementVectorSizeType itk::Statistics::MeanShiftModeSeekerBase< TSample >::GetMeasurementVectorSize (   )  const [inline, virtual, inherited]

Definition at line 102 of file itkMeanShiftModeSeekerBase.h.

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::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

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

Standard Macros Reimplemented from itk::Statistics::MeanShiftModeSeekerBase< TSample >.

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

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

template<class TSample> double itk::Statistics::HypersphereKernelMeanShiftModeSeeker< TSample >::GetSearchRadius (   )  [inline]

Gets the radius of the kernel Definition at line 75 of file itkHypersphereKernelMeanShiftModeSeeker.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.

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. Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), 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< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TSample> static Pointer itk::Statistics::HypersphereKernelMeanShiftModeSeeker< TSample >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

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

Cause the object to print itself out.

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

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

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.

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

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

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

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

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

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

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

Definition at line 87 of file itkMeanShiftModeSeekerBase.h.

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.

template<class TSample> void itk::Statistics::HypersphereKernelMeanShiftModeSeeker< TSample >::SetSearchRadius (  double  radius  )

Sets the radius of the kernel

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

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

---

Member Data Documentation

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 unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

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.

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

---

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

• itkHypersphereKernelMeanShiftModeSeeker.h

---