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

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

#include <itkWeightedCentroidKdTreeGenerator.h>

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

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

[legend]List of all members.

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

---

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

---

Member Function Documentation

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

---

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

• itkWeightedCentroidKdTreeGenerator.h

---