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

#include <itkWeightedCentroidKdTreeGenerator.h>

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

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

[legend]List of all members.

---

Detailed Description

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

This class generates a KdTree object with centroid information.

The KdTree object stores measurment vectors in a k-d tree structure that is a binary tree. The partition value is the median value of one of the k dimension (partition dimension). The partition dimension is determined by the spread of measurement values in each dimension. The partition dimension is the dimension has the widest spread. Our implementation of k-d tree doesn't have any construction or insertion logic. Users should use this class or the KdTreeGenerator class.

This class is derived from the KdTreeGenerator class. The only difference between this class and the KdTreeGenerator class is that the nonterminal node type of this class is KdTreeWeightedCentroidNonterminalNode and that of the KdTreeGenerator is KdTreeNonterminalNode. Therefore, the public interface is identical to each other. The nonterminal node generation routines differ.

To run this generator, users should provides the bucket size (SetBucketSize method) and the input sample (SetSample method). The Update method will run this generator. To get the resulting KdTree object, call the GetOutput 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 from the sample set as input. You may query this length using the function GetMeasurementVectorSize().

See also:

KdTree, KdTreeNode, KdTreeWeightedCentroidNonterminalNode, KdTreeTerminalNode, KdTreeGenerator

Definition at line 66 of file itkWeightedCentroidKdTreeGenerator.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::KdTreeNodeType	KdTreeNodeType
typedef Superclass::KdTreeType	KdTreeType
typedef Superclass::MeasurementType	MeasurementType
typedef unsigned int	MeasurementVectorSizeType
typedef Superclass::MeasurementVectorType	MeasurementVectorType
typedef KdTreeType::Pointer	OutputPointer
typedef KdTreeType	OutputType
typedef SmartPointer< Self >	Pointer
typedef WeightedCentroidKdTreeGenerator	Self
typedef Superclass::SubsamplePointer	SubsamplePointer
typedef Superclass::SubsampleType	SubsampleType
typedef KdTreeGenerator< TSample >	Superclass
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
void	GenerateData ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual unsigned int	GetMeasurementVectorSize () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
OutputPointer	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)
void	SetBucketSize (int size)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
void	SetSample (TSample *sample)
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
unsigned int	TotalInstance
Protected Member Functions
virtual KdTreeNodeType *	GenerateNonterminalNode (int beginIndex, int endIndex, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound, int level)
KdTreeNodeType *	GenerateTreeLoop (int beginIndex, int endIndex, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound, int level)
SubsamplePointer	GetSubsample ()
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
	WeightedCentroidKdTreeGenerator ()
virtual	~WeightedCentroidKdTreeGenerator ()
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 SmartPointer<const Self> itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::ConstPointer

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

template<class TSample> typedef Superclass::KdTreeNodeType itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::KdTreeNodeType

Typedef for the k-d tree node type Reimplemented from itk::Statistics::KdTreeGenerator< TSample >. Definition at line 88 of file itkWeightedCentroidKdTreeGenerator.h.

template<class TSample> typedef Superclass::KdTreeType itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::KdTreeType

Typedef for the k-d tree Reimplemented from itk::Statistics::KdTreeGenerator< TSample >. Definition at line 87 of file itkWeightedCentroidKdTreeGenerator.h.

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

Reimplemented from itk::Statistics::KdTreeGenerator< TSample >. Definition at line 84 of file itkWeightedCentroidKdTreeGenerator.h.

template<class TSample> typedef unsigned int itk::Statistics::KdTreeGenerator< TSample >::MeasurementVectorSizeType [inherited]

Typedef for the length of each measurement vector Definition at line 89 of file itkKdTreeGenerator.h.

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

typedef alias for the source data container Reimplemented from itk::Statistics::KdTreeGenerator< TSample >. Definition at line 80 of file itkWeightedCentroidKdTreeGenerator.h.

template<class TSample> typedef KdTreeType::Pointer itk::Statistics::KdTreeGenerator< TSample >::OutputPointer [inherited]

Typedef for the smart pointer to the k-d tree Definition at line 98 of file itkKdTreeGenerator.h.

template<class TSample> typedef KdTreeType itk::Statistics::KdTreeGenerator< TSample >::OutputType [inherited]

Type alias for the k-d tree type Definition at line 95 of file itkKdTreeGenerator.h.

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

Reimplemented from itk::Statistics::KdTreeGenerator< TSample >. Definition at line 73 of file itkWeightedCentroidKdTreeGenerator.h.

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

Standard class typedefs Reimplemented from itk::Statistics::KdTreeGenerator< TSample >. Definition at line 71 of file itkWeightedCentroidKdTreeGenerator.h.

template<class TSample> typedef Superclass::SubsamplePointer itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::SubsamplePointer

Typedef for the smart pointer to the Subsample Reimplemented from itk::Statistics::KdTreeGenerator< TSample >. Definition at line 86 of file itkWeightedCentroidKdTreeGenerator.h.

template<class TSample> typedef Superclass::SubsampleType itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::SubsampleType

Typedef for the internal Subsample Reimplemented from itk::Statistics::KdTreeGenerator< TSample >. Definition at line 85 of file itkWeightedCentroidKdTreeGenerator.h.

template<class TSample> typedef KdTreeGenerator< TSample > itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::Superclass

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

---

Constructor & Destructor Documentation

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

Constructor

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

Destructor Definition at line 96 of file itkWeightedCentroidKdTreeGenerator.h.

---

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::KdTreeGenerator< TSample >::GenerateData (   )  [inherited]

Runs this k-d tree construction algorithm.

template<class TSample> virtual KdTreeNodeType* itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::GenerateNonterminalNode (  int  beginIndex, int  endIndex, MeasurementVectorType &  lowerBound, MeasurementVectorType &  upperBound, int  level )  [protected, virtual]

Nonterminal node generation routine Reimplemented from itk::Statistics::KdTreeGenerator< TSample >.

template<class TSample> KdTreeNodeType* itk::Statistics::KdTreeGenerator< TSample >::GenerateTreeLoop (  int  beginIndex, int  endIndex, MeasurementVectorType &  lowerBound, MeasurementVectorType &  upperBound, int  level )  [protected, inherited]

Tree generation loop

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> virtual unsigned int itk::Statistics::KdTreeGenerator< TSample >::GetMeasurementVectorSize (   )  const [virtual, inherited]

Get macro to get the length of the measurement vectors that are being held in the 'sample' that is passed to this class

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> virtual const char* itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods) Reimplemented from itk::Statistics::KdTreeGenerator< TSample >.

template<class TSample> OutputPointer itk::Statistics::KdTreeGenerator< TSample >::GetOutput (  void   )  [inline, inherited]

Returns the pointer to the generated k-d tree. Definition at line 117 of file itkKdTreeGenerator.h.

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> SubsamplePointer itk::Statistics::KdTreeGenerator< TSample >::GetSubsample (   )  [inline, protected, inherited]

Returns the smart pointer to the internal Subsample object. Definition at line 144 of file itkKdTreeGenerator.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::WeightedCentroidKdTreeGenerator< TSample >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Statistics::KdTreeGenerator< 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::WeightedCentroidKdTreeGenerator< 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::KdTreeGenerator< 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::KdTreeGenerator< TSample >::SetBucketSize (  int  size  )  [inherited]

Sets the number of measurement vectors that can be stored in a terminal node.

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

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::KdTreeGenerator< TSample >::SetSample (  TSample *  sample  )  [inherited]

Sets the input sample that provides the measurement vectors.

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

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

template<class TSample> void itk::Statistics::KdTreeGenerator< TSample >::Update (  void   )  [inline, inherited]

Runs this k-d tree construction algorithm. Definition at line 121 of file itkKdTreeGenerator.h. References HardConnectedComponentImageFilter::GenerateData().

---

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]

template<class TSample> unsigned int itk::Statistics::KdTreeGenerator< TSample >::TotalInstance [inherited]

The number of measurement vectors in an object of this class. Definition at line 128 of file itkKdTreeGenerator.h.

---

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

• itkWeightedCentroidKdTreeGenerator.h

---