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

This class is the node that doesn't have any child node. The IsTerminal method returns true for this class. This class stores the instance identifiers belonging to this node, while the nonterminal nodes do not store them. The AddInstanceIdentifier and GetInstanceIdentifier are storing and retrieving the instance identifiers belonging to this node. More...

#include <itkKdTree.h>

+ Inheritance diagram for itk::Statistics::KdTreeTerminalNode< TSample >:
+ Collaboration diagram for itk::Statistics::KdTreeTerminalNode< 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

 KdTreeTerminalNode ()
virtual ~KdTreeTerminalNode ()
void AddInstanceIdentifier (InstanceIdentifier id)
void GetCentroid (CentroidType &)
InstanceIdentifier GetInstanceIdentifier (vcl_size_t index) const
void GetParameters (unsigned int &, MeasurementType &) const
void GetWeightedCentroid (CentroidType &)
bool IsTerminal () const
SuperclassLeft ()
const SuperclassLeft () const
SuperclassRight ()
const SuperclassRight () const
unsigned int Size () const

Private Attributes

std::vector< InstanceIdentifierm_InstanceIdentifiers

Detailed Description

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

This class is the node that doesn't have any child node. The IsTerminal method returns true for this class. This class stores the instance identifiers belonging to this node, while the nonterminal nodes do not store them. The AddInstanceIdentifier and GetInstanceIdentifier are storing and retrieving the instance identifiers belonging to this node.

See also:
KdTreeNode, KdTreeNonterminalNode, KdTreeWeightedCentroidNonterminalNode

Definition at line 289 of file itkKdTree.h.


Member Typedef Documentation

template<class TSample>
typedef Superclass::CentroidType itk::Statistics::KdTreeTerminalNode< TSample >::CentroidType

Centroid type

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

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

Measurement type, not the measurement vector type

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

Definition at line 292 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::KdTreeTerminalNode< TSample >::Superclass

Definition at line 291 of file itkKdTree.h.


Constructor & Destructor Documentation

template<class TSample>
itk::Statistics::KdTreeTerminalNode< TSample >::KdTreeTerminalNode ( )
inline

Definition at line 296 of file itkKdTree.h.

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

Member Function Documentation

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

Returns the centroid. weighted centroid divided by the size

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

Definition at line 327 of file itkKdTree.h.

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

References itk::Statistics::KdTreeTerminalNode< TSample >::m_InstanceIdentifiers.

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

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 306 of file itkKdTree.h.

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

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

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

Returns the pointer to the left child of this node

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

Definition at line 309 of file itkKdTree.h.

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

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

Definition at line 315 of file itkKdTree.h.

template<class TSample>
Superclass* itk::Statistics::KdTreeTerminalNode< TSample >::Right ( )
inlinevirtual

Returns the pointer to the right child of this node

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

Definition at line 312 of file itkKdTree.h.

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

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

Definition at line 318 of file itkKdTree.h.

template<class TSample>
unsigned int itk::Statistics::KdTreeTerminalNode< TSample >::Size ( ) const
inlinevirtual

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

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

Definition at line 321 of file itkKdTree.h.

References itk::Statistics::KdTreeTerminalNode< TSample >::m_InstanceIdentifiers.


Member Data Documentation

template<class TSample>
std::vector< InstanceIdentifier > itk::Statistics::KdTreeTerminalNode< TSample >::m_InstanceIdentifiers
private

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

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