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

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

#include <itkKdTree.h>

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

List of all members.

Public Types

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

Public Member Functions

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

Private Attributes

InstanceIdentifier m_InstanceIdentifier
Superclassm_Left
unsigned int m_PartitionDimension
MeasurementType m_PartitionValue
Superclassm_Right

Detailed Description

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

This is a subclass of the KdTreeNode.

KdTreeNonterminalNode doesn't store the information related with the centroids. Therefore, the GetWeightedCentroid and the GetCentroid methods are void. This class should have the left and the right children. If we have a sample and want to generate a KdTree without the centroid related information, we can use the KdTreeGenerator.

See also:
KdTreeNode, KdTreeWeightedCentroidNonterminalNode, KdTreeGenerator

Definition at line 133 of file itkKdTree.h.


Member Typedef Documentation

Centroid type

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

Definition at line 137 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 138 of file itkKdTree.h.

Measurement type, not the measurement vector type

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

Definition at line 136 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::KdTreeNonterminalNode< TSample >::Superclass

Definition at line 135 of file itkKdTree.h.


Constructor & Destructor Documentation

template<class TSample >
itk::Statistics::KdTreeNonterminalNode< TSample >::KdTreeNonterminalNode ( unsigned int  partitionDimension,
MeasurementType  partitionValue,
Superclass left,
Superclass right 
)

Definition at line 27 of file itkKdTree.txx.

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

Definition at line 145 of file itkKdTree.h.


Member Function Documentation

template<class TSample >
void itk::Statistics::KdTreeNonterminalNode< TSample >::AddInstanceIdentifier ( InstanceIdentifier  id)
inlinevirtual

Add an instance to this node

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

Definition at line 180 of file itkKdTree.h.

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

template<class TSample >
void itk::Statistics::KdTreeNonterminalNode< TSample >::GetCentroid ( CentroidType centroid)
inlinevirtual

Returns the centroid. weighted centroid divided by the size

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

Definition at line 171 of file itkKdTree.h.

template<class TSample >
InstanceIdentifier itk::Statistics::KdTreeNonterminalNode< 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 177 of file itkKdTree.h.

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

template<class TSample >
void itk::Statistics::KdTreeNonterminalNode< 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 41 of file itkKdTree.txx.

template<class TSample >
void itk::Statistics::KdTreeNonterminalNode< 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 168 of file itkKdTree.h.

template<class TSample >
virtual bool itk::Statistics::KdTreeNonterminalNode< 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 147 of file itkKdTree.h.

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

Returns the pointer to the left child of this node

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

Definition at line 153 of file itkKdTree.h.

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

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

Returns the pointer to the right child of this node

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

Definition at line 156 of file itkKdTree.h.

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

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

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

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

Definition at line 165 of file itkKdTree.h.


Member Data Documentation

template<class TSample >
InstanceIdentifier itk::Statistics::KdTreeNonterminalNode< TSample >::m_InstanceIdentifier
private
template<class TSample >
Superclass* itk::Statistics::KdTreeNonterminalNode< TSample >::m_Left
private
template<class TSample >
unsigned int itk::Statistics::KdTreeNonterminalNode< TSample >::m_PartitionDimension
private

Definition at line 184 of file itkKdTree.h.

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

Definition at line 185 of file itkKdTree.h.

template<class TSample >
Superclass* itk::Statistics::KdTreeNonterminalNode< TSample >::m_Right
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