Orfeo Toolbox  4.0
Public Types | Public Member Functions | Private Attributes | List of all members
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 >:

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, MeasurementType, Superclass *, Superclass *)
 
virtual ~KdTreeNonterminalNode ()
 
void AddInstanceIdentifier (InstanceIdentifier valueId)
 
void GetCentroid (CentroidType &)
 
InstanceIdentifier GetInstanceIdentifier (InstanceIdentifier) const
 
void GetParameters (unsigned int &, MeasurementType &) 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<typename 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 138 of file itkKdTree.h.

Member Typedef Documentation

template<typename TSample >
typedef Superclass::CentroidType itk::Statistics::KdTreeNonterminalNode< TSample >::CentroidType

Definition at line 142 of file itkKdTree.h.

Definition at line 143 of file itkKdTree.h.

Definition at line 141 of file itkKdTree.h.

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

type alias for itself

Definition at line 67 of file itkKdTree.h.

template<typename TSample >
typedef KdTreeNode<TSample> itk::Statistics::KdTreeNonterminalNode< TSample >::Superclass

Definition at line 140 of file itkKdTree.h.

Constructor & Destructor Documentation

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

Definition at line 29 of file itkKdTree.hxx.

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

Definition at line 148 of file itkKdTree.h.

Member Function Documentation

template<typename TSample >
void itk::Statistics::KdTreeNonterminalNode< TSample >::AddInstanceIdentifier ( InstanceIdentifier  valueId)
inlinevirtual

Set the identifier of the node.

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

Definition at line 215 of file itkKdTree.h.

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

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

Returns the centroid. weighted centroid divided by the size. Do nothing for this class.

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

Definition at line 200 of file itkKdTree.h.

template<typename TSample >
InstanceIdentifier itk::Statistics::KdTreeNonterminalNode< TSample >::GetInstanceIdentifier ( InstanceIdentifier  ) const
inlinevirtual

Returns the identifier of the only MeasurementVector associated with this node in the tree. This MeasurementVector will be used later during the distance computation when querying the tree.

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

Definition at line 207 of file itkKdTree.h.

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

template<typename TSample >
void itk::Statistics::KdTreeNonterminalNode< TSample >::GetParameters ( unsigned int &  ,
MeasurementType  
) 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.hxx.

template<typename TSample >
void itk::Statistics::KdTreeNonterminalNode< TSample >::GetWeightedCentroid ( CentroidType )
inlinevirtual

Returns the vector sum of the all measurement vectors under this node. Do nothing for this class.

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

Definition at line 194 of file itkKdTree.h.

template<typename 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 150 of file itkKdTree.h.

template<typename 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 158 of file itkKdTree.h.

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

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

Returns the const pointer to the left child of this node

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

Definition at line 170 of file itkKdTree.h.

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

template<typename 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 164 of file itkKdTree.h.

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

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

Returns the const pointer to the right child of this node

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

Definition at line 176 of file itkKdTree.h.

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

template<typename TSample >
unsigned int itk::Statistics::KdTreeNonterminalNode< TSample >::Size ( void  ) const
inlinevirtual

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

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

Definition at line 185 of file itkKdTree.h.

Member Data Documentation

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

Definition at line 222 of file itkKdTree.h.

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

Definition at line 223 of file itkKdTree.h.

template<typename TSample >
Superclass* itk::Statistics::KdTreeNonterminalNode< TSample >::m_Right
private

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

Generated at Sat Mar 8 2014 18:02:47 for Orfeo Toolbox with doxygen 1.8.3.1