Orfeo Toolbox  3.16
Public Types | Public Member Functions | Private Attributes
itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample > Class Template Reference

This is a subclass of the KdTreeNode. More...

#include <itkKdTree.h>

+ Inheritance diagram for itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >:
+ Collaboration diagram for itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >:

List of all members.

Public Types

typedef Superclass::CentroidType CentroidType
typedef
Superclass::InstanceIdentifier 
InstanceIdentifier
typedef Superclass::MeasurementType MeasurementType
typedef
TSample::MeasurementVectorSizeType 
MeasurementVectorSizeType
typedef KdTreeNode< TSample > Self
typedef KdTreeNode< TSample > Superclass

Public Member Functions

 KdTreeWeightedCentroidNonterminalNode (unsigned int partitionDimension, MeasurementType partitionValue, Superclass *left, Superclass *right, CentroidType &centroid, unsigned int size)
virtual ~KdTreeWeightedCentroidNonterminalNode ()
void AddInstanceIdentifier (InstanceIdentifier valueId)
void GetCentroid (CentroidType &centroid)
InstanceIdentifier GetInstanceIdentifier (vcl_size_t) const
MeasurementVectorSizeType GetMeasurementVectorSize () const
void GetParameters (unsigned int &partitionDimension, MeasurementType &partitionValue) const
void GetWeightedCentroid (CentroidType &centroid)
virtual bool IsTerminal () const
SuperclassLeft ()
const SuperclassLeft () const
SuperclassRight ()
const SuperclassRight () const
unsigned int Size () const

Private Attributes

CentroidType m_Centroid
InstanceIdentifier m_InstanceIdentifier
Superclassm_Left
MeasurementVectorSizeType m_MeasurementVectorSize
unsigned int m_PartitionDimension
MeasurementType m_PartitionValue
Superclassm_Right
unsigned int m_Size
CentroidType m_WeightedCentroid

Detailed Description

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

This is a subclass of the KdTreeNode.

KdTreeNonterminalNode does have the information related with the centroids. Therefore, the GetWeightedCentroid and the GetCentroid methods returns meaningful values. This class should have the left and right children. If we have a sample and want to generate a KdTree with the centroid related information, we can use the WeightedCentroidKdTreeGenerator. The centroid, the weighted centroid, and the size (the number of measurement vectors) can be used to accelate the k-means estimation.

See also:
KdTreeNode, KdTreeNonterminalNode, WeightedCentroidKdTreeGenerator

Definition at line 206 of file itkKdTree.h.


Member Typedef Documentation

Centroid type

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

Definition at line 210 of file itkKdTree.h.

Instance identifier type (index value type for the measurement vector in a sample

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

Definition at line 211 of file itkKdTree.h.

Measurement type, not the measurement vector type

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

Definition at line 209 of file itkKdTree.h.

template<class TSample >
typedef TSample::MeasurementVectorSizeType itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::MeasurementVectorSizeType

Definition at line 212 of file itkKdTree.h.

template<class TSample >
typedef KdTreeNode< TSample> itk::Statistics::KdTreeNode< TSample >::Self
inherited

type alias for itself

Definition at line 69 of file itkKdTree.h.

template<class TSample >
typedef KdTreeNode< TSample > itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::Superclass

Definition at line 208 of file itkKdTree.h.


Constructor & Destructor Documentation

template<class TSample >
itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::KdTreeWeightedCentroidNonterminalNode ( unsigned int  partitionDimension,
MeasurementType  partitionValue,
Superclass left,
Superclass right,
CentroidType centroid,
unsigned int  size 
)

Definition at line 50 of file itkKdTree.txx.

References itk::MeasurementVectorTraits::GetLength().

template<class TSample >
virtual itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::~KdTreeWeightedCentroidNonterminalNode ( )
inlinevirtual

Definition at line 220 of file itkKdTree.h.


Member Function Documentation

template<class TSample >
void itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::AddInstanceIdentifier ( InstanceIdentifier  id)
inlinevirtual
template<class TSample >
void itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::GetCentroid ( CentroidType centroid)
inlinevirtual

Returns the centroid. weighted centroid divided by the size

Implements itk::Statistics::KdTreeNode< TSample >.

Definition at line 255 of file itkKdTree.h.

References itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::m_Centroid.

template<class TSample >
InstanceIdentifier itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::GetInstanceIdentifier ( vcl_size_t  index) const
inlinevirtual

Retuns the instance identifier of the index-th measurement vector

Implements itk::Statistics::KdTreeNode< TSample >.

Definition at line 258 of file itkKdTree.h.

References itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::m_InstanceIdentifier.

template<class TSample >
MeasurementVectorSizeType itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::GetMeasurementVectorSize ( ) const
inline

Return the length of a measurement vector

Definition at line 232 of file itkKdTree.h.

References itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::m_MeasurementVectorSize.

template<class TSample >
void itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::GetParameters ( unsigned int &  partitionDimension,
MeasurementType partitionValue 
) const
virtual

Fills the partitionDimension (the dimension that was chosen to split the measurement vectors belong to this node to the left and the right child among k dimensions) and the partitionValue (the measurement value on the partitionDimension divides the left and the right child

Implements itk::Statistics::KdTreeNode< TSample >.

Definition at line 72 of file itkKdTree.txx.

template<class TSample >
void itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::GetWeightedCentroid ( CentroidType centroid)
inlinevirtual

Returns the vector sum of the all measurement vectors under this node

Implements itk::Statistics::KdTreeNode< TSample >.

Definition at line 252 of file itkKdTree.h.

References itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::m_WeightedCentroid.

template<class TSample >
virtual bool itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::IsTerminal ( ) const
inlinevirtual

Returns true if the node is a terminal node, that is a node that doesn't have any child.

Implements itk::Statistics::KdTreeNode< TSample >.

Definition at line 225 of file itkKdTree.h.

template<class TSample >
Superclass* itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::Left ( )
inlinevirtual

Returns the pointer to the left child of this node

Implements itk::Statistics::KdTreeNode< TSample >.

Definition at line 237 of file itkKdTree.h.

References itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::m_Left.

template<class TSample >
const Superclass* itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::Left ( ) const
inlinevirtual
template<class TSample >
Superclass* itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::Right ( )
inlinevirtual

Returns the pointer to the right child of this node

Implements itk::Statistics::KdTreeNode< TSample >.

Definition at line 240 of file itkKdTree.h.

References itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::m_Right.

template<class TSample >
const Superclass* itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::Right ( ) const
inlinevirtual
template<class TSample >
unsigned int itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::Size ( ) const
inlinevirtual

Returs the number of measurement vectors under this node including its children

Implements itk::Statistics::KdTreeNode< TSample >.

Definition at line 249 of file itkKdTree.h.

References itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::m_Size.


Member Data Documentation

template<class TSample >
CentroidType itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::m_Centroid
private
template<class TSample >
InstanceIdentifier itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::m_InstanceIdentifier
private
template<class TSample >
Superclass* itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::m_Left
private
template<class TSample >
MeasurementVectorSizeType itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::m_MeasurementVectorSize
private
template<class TSample >
unsigned int itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::m_PartitionDimension
private

Definition at line 266 of file itkKdTree.h.

template<class TSample >
MeasurementType itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::m_PartitionValue
private

Definition at line 267 of file itkKdTree.h.

template<class TSample >
Superclass* itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::m_Right
private
template<class TSample >
unsigned int itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::m_Size
private
template<class TSample >
CentroidType itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::m_WeightedCentroid
private

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

Generated at Sun Feb 3 2013 03:02:10 for Orfeo Toolbox with doxygen 1.8.1.1