#include <itkKdTreeGenerator.h>

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

Collaboration diagram for itk::Statistics::KdTreeGenerator< TSample >:

Detailed Description

template<typename TSample>
class itk::Statistics::KdTreeGenerator< TSample >

This class generates a KdTree object without 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 WeightedCentroidKdTreeGenerator class.

The number of the measurement vectors in a terminal node is set by the SetBucketSize method. If we use too small number for this, it might cause computational overhead to calculate bound conditions. However, too large number will cause more distance calculation between the measurement vectors in a terminal node and the query point.

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, KdTreeNonterminalNode, KdTreeTerminalNode, WeightedCentroidKdTreeGenerator

Wiki Examples:

Examples:: Examples/Statistics/KdTree.cxx, WikiExamples/Statistics/KdTree.cxx, and WikiExamples/Statistics/KdTreeBasedKmeansEstimator.cxx.

Definition at line 70 of file itkKdTreeGenerator.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef KdTreeType::KdTreeNodeType	KdTreeNodeType

typedef KdTree< TSample >	KdTreeType

typedef TSample::MeasurementType	MeasurementType

typedef unsigned int	MeasurementVectorSizeType

typedef TSample::MeasurementVectorType	MeasurementVectorType

typedef KdTreeType::Pointer	OutputPointer

typedef KdTreeType	OutputType

typedef SmartPointer< Self >	Pointer

typedef KdTreeGenerator	Self

typedef SubsampleType::Pointer	SubsamplePointer

typedef Subsample< TSample >	SubsampleType

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

void	GenerateData ()

virtual unsigned int	GetMeasurementVectorSize () const

virtual const char *	GetNameOfClass () const

OutputPointer	GetOutput ()

void	SetBucketSize (unsigned int size)

void	SetSample (TSample *sample)

void	Update ()

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
virtual KdTreeNodeType *	GenerateNonterminalNode (unsigned int beginIndex, unsigned int endIndex, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound, unsigned int level)

KdTreeNodeType *	GenerateTreeLoop (unsigned int beginIndex, unsigned int endIndex, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound, unsigned int level)

SubsamplePointer	GetSubsample ()

	KdTreeGenerator ()

virtual void	PrintSelf (std::ostream &os, Indent indent) const override

virtual	~KdTreeGenerator ()

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Member Functions
	KdTreeGenerator (const Self &) ITK_DELETE_FUNCTION

void	operator= (const Self &) ITK_DELETE_FUNCTION

Private Attributes
unsigned int	m_BucketSize

MeasurementVectorSizeType	m_MeasurementVectorSize

TSample *	m_SourceSample

SubsamplePointer	m_Subsample

MeasurementVectorType	m_TempLowerBound

MeasurementVectorType	m_TempMean

MeasurementVectorType	m_TempUpperBound

OutputPointer	m_Tree

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<typename TSample >

typedef SmartPointer< const Self > itk::Statistics::KdTreeGenerator< TSample >::ConstPointer

Definition at line 77 of file itkKdTreeGenerator.h.

template<typename TSample >

typedef KdTreeType::KdTreeNodeType itk::Statistics::KdTreeGenerator< TSample >::KdTreeNodeType

Typedef for the k-d tree node type

Definition at line 102 of file itkKdTreeGenerator.h.

template<typename TSample >

typedef KdTree< TSample > itk::Statistics::KdTreeGenerator< TSample >::KdTreeType

Typedef for the k-d tree

Definition at line 93 of file itkKdTreeGenerator.h.

template<typename TSample >

typedef TSample::MeasurementType itk::Statistics::KdTreeGenerator< TSample >::MeasurementType

Definition at line 87 of file itkKdTreeGenerator.h.

template<typename TSample >

typedef unsigned int itk::Statistics::KdTreeGenerator< TSample >::MeasurementVectorSizeType

Typedef for the length of each measurement vector

Definition at line 90 of file itkKdTreeGenerator.h.

template<typename TSample >

typedef TSample::MeasurementVectorType itk::Statistics::KdTreeGenerator< TSample >::MeasurementVectorType

typedef alias for the source data container

Definition at line 83 of file itkKdTreeGenerator.h.

template<typename TSample >

typedef KdTreeType::Pointer itk::Statistics::KdTreeGenerator< TSample >::OutputPointer

Typedef for the smart pointer to the k-d tree

Definition at line 99 of file itkKdTreeGenerator.h.

template<typename TSample >

typedef KdTreeType itk::Statistics::KdTreeGenerator< TSample >::OutputType

Type alias for the k-d tree type

Definition at line 96 of file itkKdTreeGenerator.h.

template<typename TSample >

typedef SmartPointer< Self > itk::Statistics::KdTreeGenerator< TSample >::Pointer

Definition at line 76 of file itkKdTreeGenerator.h.

template<typename TSample >

typedef KdTreeGenerator itk::Statistics::KdTreeGenerator< TSample >::Self

Standard class typedefs

Definition at line 74 of file itkKdTreeGenerator.h.

template<typename TSample >

typedef SubsampleType::Pointer itk::Statistics::KdTreeGenerator< TSample >::SubsamplePointer

Typedef for the smart pointer to the Subsample

Definition at line 108 of file itkKdTreeGenerator.h.

template<typename TSample >

typedef Subsample< TSample > itk::Statistics::KdTreeGenerator< TSample >::SubsampleType

Typedef for the internal Subsample

Definition at line 105 of file itkKdTreeGenerator.h.

template<typename TSample >

typedef Object itk::Statistics::KdTreeGenerator< TSample >::Superclass

Definition at line 75 of file itkKdTreeGenerator.h.

Constructor & Destructor Documentation

template<typename TSample >

itk::Statistics::KdTreeGenerator< TSample >::KdTreeGenerator ( )

protected

Constructor

template<typename TSample >

virtual itk::Statistics::KdTreeGenerator< TSample >::~KdTreeGenerator ( )

inlineprotectedvirtual

Destructor

Definition at line 141 of file itkKdTreeGenerator.h.

template<typename TSample >

itk::Statistics::KdTreeGenerator< TSample >::KdTreeGenerator ( const Self & )

private

Member Function Documentation

template<typename TSample >

virtual::itk::LightObject::Pointer itk::Statistics::KdTreeGenerator< TSample >::CreateAnother ( ) const

virtual

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::Object.

Reimplemented in itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >.

template<typename TSample >

void itk::Statistics::KdTreeGenerator< TSample >::GenerateData ( )

Runs this k-d tree construction algorithm.

Referenced by itk::Statistics::KdTreeGenerator< TSample >::Update().

template<typename TSample >

virtual KdTreeNodeType* itk::Statistics::KdTreeGenerator< TSample >::GenerateNonterminalNode	(	unsigned int	beginIndex,
		unsigned int	endIndex,
		MeasurementVectorType &	lowerBound,
		MeasurementVectorType &	upperBound,
		unsigned int	level
	)

protectedvirtual

Nonterminal node generation routine

Reimplemented in itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >.

template<typename TSample >

KdTreeNodeType* itk::Statistics::KdTreeGenerator< TSample >::GenerateTreeLoop	(	unsigned int	beginIndex,
		unsigned int	endIndex,
		MeasurementVectorType &	lowerBound,
		MeasurementVectorType &	upperBound,
		unsigned int	level
	)

protected

Tree generation loop

template<typename TSample >

virtual unsigned int itk::Statistics::KdTreeGenerator< TSample >::GetMeasurementVectorSize ( ) const

virtual

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

template<typename TSample >

virtual const char* itk::Statistics::KdTreeGenerator< TSample >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods)

Reimplemented from itk::Object.

Reimplemented in itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >.

template<typename TSample >

OutputPointer itk::Statistics::KdTreeGenerator< TSample >::GetOutput ( )

inline

Returns the pointer to the generated k-d tree.

Definition at line 118 of file itkKdTreeGenerator.h.

References itk::Statistics::KdTreeGenerator< TSample >::m_Tree.

template<typename TSample >

SubsamplePointer itk::Statistics::KdTreeGenerator< TSample >::GetSubsample ( )

inlineprotected

Returns the smart pointer to the internal Subsample object.

Definition at line 146 of file itkKdTreeGenerator.h.

References itk::Statistics::KdTreeGenerator< TSample >::m_Subsample.

template<typename TSample >

static Pointer itk::Statistics::KdTreeGenerator< TSample >::New ( )

static

Method for creation through the object factory.

template<typename TSample >

void itk::Statistics::KdTreeGenerator< TSample >::operator= ( const Self & )

private

template<typename TSample >

virtual void itk::Statistics::KdTreeGenerator< TSample >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

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.

Reimplemented in itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >.

template<typename TSample >

void itk::Statistics::KdTreeGenerator< TSample >::SetBucketSize ( unsigned int size )

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

template<typename TSample >

void itk::Statistics::KdTreeGenerator< TSample >::SetSample ( TSample * sample )

Sets the input sample that provides the measurement vectors.

template<typename TSample >

void itk::Statistics::KdTreeGenerator< TSample >::Update ( void )

inline

Runs this k-d tree construction algorithm.