This class generates a KdTree object with centroid information. More...

#include <itkWeightedCentroidKdTreeGenerator.h>

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

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

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::KdTreeNodeType	KdTreeNodeType
typedef Superclass::KdTreeType	KdTreeType
typedef Superclass::MeasurementType	MeasurementType
typedef Superclass::MeasurementVectorType	MeasurementVectorType
typedef SmartPointer< Self >	Pointer
typedef WeightedCentroidKdTreeGenerator	Self
typedef Superclass::SubsamplePointer	SubsamplePointer
typedef Superclass::SubsampleType	SubsampleType
typedef KdTreeGenerator< TSample >	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
virtual KdTreeNodeType *	GenerateNonterminalNode (unsigned int beginIndex, unsigned int endIndex, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound, unsigned int level)
void	PrintSelf (std::ostream &os, Indent indent) const
	WeightedCentroidKdTreeGenerator ()
virtual	~WeightedCentroidKdTreeGenerator ()
Private Member Functions
void	operator= (const Self &)
	WeightedCentroidKdTreeGenerator (const Self &)
Private Attributes
MeasurementVectorType	m_TempLowerBound
MeasurementVectorType	m_TempMean
MeasurementVectorType	m_TempUpperBound

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.

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 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 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 95 of file itkWeightedCentroidKdTreeGenerator.h.

template<class TSample >

itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::WeightedCentroidKdTreeGenerator ( const Self & ) [private]

Member Function Documentation

template<class TSample >

virtual::itk::LightObject::Pointer itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::CreateAnother ( void ) 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::Statistics::KdTreeGenerator< TSample >.

template<class TSample >

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

Nonterminal node generation routine

Reimplemented from itk::Statistics::KdTreeGenerator< TSample >.

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 >

static Pointer itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Statistics::KdTreeGenerator< TSample >.

template<class TSample >

void itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::operator= ( const Self & ) [private]

Mutex lock to protect modification to the reference count

Reimplemented from itk::Statistics::KdTreeGenerator< TSample >.

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