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

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 (InstanceIdentifier 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<typename 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 362 of file itkKdTree.h.

Member Typedef Documentation

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

Definition at line 366 of file itkKdTree.h.

Definition at line 367 of file itkKdTree.h.

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

Definition at line 364 of file itkKdTree.h.

Constructor & Destructor Documentation

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

Definition at line 369 of file itkKdTree.h.

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

Member Function Documentation

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

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

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

Definition at line 425 of file itkKdTree.h.

template<typename TSample>
InstanceIdentifier itk::Statistics::KdTreeTerminalNode< TSample >::GetInstanceIdentifier ( InstanceIdentifier  index) 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 432 of file itkKdTree.h.

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

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

Return the parameters of the node.

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

Definition at line 383 of file itkKdTree.h.

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

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

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

Definition at line 419 of file itkKdTree.h.

template<typename TSample>
bool itk::Statistics::KdTreeTerminalNode< TSample >::IsTerminal ( ) const
inlinevirtual

A terminal node.

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

Definition at line 377 of file itkKdTree.h.

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

Return the left tree pointer. Null for terminal nodes.

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

Definition at line 386 of file itkKdTree.h.

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

Return the left tree const pointer. Null for terminal nodes.

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

Definition at line 398 of file itkKdTree.h.

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

Return the right tree pointer. Null for terminal nodes.

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

Definition at line 392 of file itkKdTree.h.

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

Return the right tree const pointer. Null for terminal nodes.

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

Definition at line 404 of file itkKdTree.h.

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

Return the size of the node.

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

Definition at line 410 of file itkKdTree.h.

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

Member Data Documentation

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

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

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