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

#include <itkSampleSelectiveMeanShiftBlurringFilter.h>

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

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

[legend]List of all members.

---

Detailed Description

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

This filter blurs the input sample data using mean shift algorithm selectively.

The blurring process is identical to that of the SampleMeanShiftBlurringFilter except that users can specify which components of a measurement vector is affected by the blurring. The mean mode seeking behavior is not changed. The component selection affects only the generation of the final mode point. To specify the components to be blurred, users use the SetComponentSelections method. The size of the selection vector should be same as the size of a measurement vector. Only the components of the selection vector whose flag value is true will be blurred.

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. Please use the function GetMeasurementVectorSize() instead. It is now obtained at run time from the sample set as input. The typedef for ComponentSelectionsType has changed from FixedArray to std::vector.

See also:

MeanModeSeekerBase, SampleMeanShiftBlurringFilter

Definition at line 55 of file itkSampleSelectiveMeanShiftBlurringFilter.h.

Public Types
typedef std::vector< bool >	ComponentSelectionsType
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InputSampleType	InputSampleType
typedef Superclass::MeanShiftModeSeekerType	MeanShiftModeSeekerType
typedef unsigned int	MeasurementVectorSizeType
typedef Superclass::MeasurementVectorType	MeasurementVectorType
typedef Superclass::OutputType	OutputType
typedef SmartPointer< Self >	Pointer
typedef SampleSelectiveMeanShiftBlurringFilter	Self
typedef SampleMeanShiftBlurringFilter< TSample >	Superclass
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
void	GetComponentSelections ()
bool	GetDebug () const
const TSample *	GetInputSample () const
MeanShiftModeSeekerType *	GetMeanShiftModeSeeker ()
virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
Standard Macros *virtual const char *	GetNameOfClass () const
OutputType *	GetOutput ()
virtual int	GetReferenceCount () const
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)
Set Gets the vector of flags that indicate which components *are selected for blurring *void	SetComponentSelections (ComponentSelectionsType selections)
void	SetDebug (bool debugFlag) const
Stores the sample pointer *void	SetInputSample (const TSample *sample)
Set Gets the mean shift evolving function *void	SetMeanShiftModeSeeker (MeanShiftModeSeekerType *function)
virtual void	SetMeasurementVectorSize (MeasurementVectorSizeType _arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
void	Update ()
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
void	GenerateData ()
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
	SampleAlgorithmBase ()
	SampleSelectiveMeanShiftBlurringFilter ()
virtual	~SampleSelectiveMeanShiftBlurringFilter ()
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 std::vector< bool > itk::Statistics::SampleSelectiveMeanShiftBlurringFilter< TSample >::ComponentSelectionsType

Typedef for selecting components to be blurred Definition at line 78 of file itkSampleSelectiveMeanShiftBlurringFilter.h.

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

Reimplemented from itk::Statistics::SampleMeanShiftBlurringFilter< TSample >. Definition at line 63 of file itkSampleSelectiveMeanShiftBlurringFilter.h.

template<class TSample> typedef Superclass::InputSampleType itk::Statistics::SampleMeanShiftBlurringFilter< TSample >::InputSampleType [inherited]

Sample typedefs alias Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >. Definition at line 64 of file itkSampleMeanShiftBlurringFilter.h.

template<class TSample> typedef Superclass::MeanShiftModeSeekerType itk::Statistics::SampleSelectiveMeanShiftBlurringFilter< TSample >::MeanShiftModeSeekerType

Reimplemented from itk::Statistics::SampleMeanShiftBlurringFilter< TSample >. Definition at line 74 of file itkSampleSelectiveMeanShiftBlurringFilter.h.

typedef unsigned int itk::Statistics::SampleAlgorithmBase< TSample >::MeasurementVectorSizeType [inherited]

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

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

Reimplemented from itk::Statistics::SampleMeanShiftBlurringFilter< TSample >. Definition at line 68 of file itkSampleSelectiveMeanShiftBlurringFilter.h.

template<class TSample> typedef Superclass::OutputType itk::Statistics::SampleSelectiveMeanShiftBlurringFilter< TSample >::OutputType

Reimplemented from itk::Statistics::SampleMeanShiftBlurringFilter< TSample >. Definition at line 72 of file itkSampleSelectiveMeanShiftBlurringFilter.h.

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

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

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

Standard class typedefs. Reimplemented from itk::Statistics::SampleMeanShiftBlurringFilter< TSample >. Definition at line 60 of file itkSampleSelectiveMeanShiftBlurringFilter.h.

template<class TSample> typedef SampleMeanShiftBlurringFilter< TSample > itk::Statistics::SampleSelectiveMeanShiftBlurringFilter< TSample >::Superclass

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

---

Constructor & Destructor Documentation

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

template<class TSample> virtual itk::Statistics::SampleSelectiveMeanShiftBlurringFilter< TSample >::~SampleSelectiveMeanShiftBlurringFilter (   )  [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.

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> void itk::Statistics::SampleSelectiveMeanShiftBlurringFilter< TSample >::GenerateData (   )  [protected, virtual]

Blurring the input sample and creates a ListSample with blurred data Reimplemented from itk::Statistics::SampleMeanShiftBlurringFilter< TSample >.

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.

template<class TSample> void itk::Statistics::SampleSelectiveMeanShiftBlurringFilter< TSample >::GetComponentSelections (   )  [inline]

Definition at line 83 of file itkSampleSelectiveMeanShiftBlurringFilter.h.

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

Get the value of the debug flag.

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

const TSample * itk::Statistics::SampleAlgorithmBase< TSample >::GetInputSample (   )  const [inline, inherited]

Definition at line 82 of file itkSampleAlgorithmBase.h.

template<class TSample> MeanShiftModeSeekerType* itk::Statistics::SampleMeanShiftBlurringFilter< TSample >::GetMeanShiftModeSeeker (   )  [inline, inherited]

Definition at line 70 of file itkSampleMeanShiftBlurringFilter.h.

virtual MeasurementVectorSizeType itk::Statistics::SampleAlgorithmBase< TSample >::GetMeasurementVectorSize (   )  const [virtual, inherited]

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

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::SampleSelectiveMeanShiftBlurringFilter< TSample >::GetNameOfClass (   )  const [virtual]

Standard part of all itk objects. Reimplemented from itk::Statistics::SampleMeanShiftBlurringFilter< TSample >.

template<class TSample> OutputType* itk::Statistics::SampleMeanShiftBlurringFilter< TSample >::GetOutput (   )  [inherited]

Returns the blurred sample data in a ListSample 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.

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::SampleSelectiveMeanShiftBlurringFilter< TSample >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Statistics::SampleMeanShiftBlurringFilter< TSample >.

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::SampleSelectiveMeanShiftBlurringFilter< 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::SampleMeanShiftBlurringFilter< 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.

itk::Statistics::SampleAlgorithmBase< TSample >::SampleAlgorithmBase (   )  [protected, inherited]

template<class TSample> Set Gets the vector of flags that indicate which components* are selected for blurring* void itk::Statistics::SampleSelectiveMeanShiftBlurringFilter< TSample >::SetComponentSelections (  ComponentSelectionsType  selections  )

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().

Stores the sample pointer* void itk::Statistics::SampleAlgorithmBase< TSample >::SetInputSample (  const TSample *  sample  )  [inline, inherited]

Definition at line 63 of file itkSampleAlgorithmBase.h.

template<class TSample> Set Gets the mean shift evolving function* void itk::Statistics::SampleMeanShiftBlurringFilter< TSample >::SetMeanShiftModeSeeker (  MeanShiftModeSeekerType *  function  )  [inherited]

virtual void itk::Statistics::SampleAlgorithmBase< TSample >::SetMeasurementVectorSize (  MeasurementVectorSizeType  _arg  )  [virtual, inherited]

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.

void itk::Statistics::SampleAlgorithmBase< TSample >::Update (  void   )  [inline, inherited]

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.

---

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:

• itkSampleSelectiveMeanShiftBlurringFilter.h

---