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

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

Member Typedef Documentation

Definition at line 249 of file itkKdTree.h.

Definition at line 250 of file itkKdTree.h.

Definition at line 248 of file itkKdTree.h.

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

Definition at line 251 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::KdTreeWeightedCentroidNonterminalNode< TSample >::Superclass

Definition at line 247 of file itkKdTree.h.

Constructor & Destructor Documentation

template<typename 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.hxx.

References itk::NumericTraits< T >::GetLength().

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

Definition at line 256 of file itkKdTree.h.

Member Function Documentation

template<typename TSample >
void itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::AddInstanceIdentifier ( InstanceIdentifier  valueId)
inlinevirtual
template<typename 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 314 of file itkKdTree.h.

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

template<typename TSample >
InstanceIdentifier itk::Statistics::KdTreeWeightedCentroidNonterminalNode< 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 324 of file itkKdTree.h.

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

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

Return the length of a measurement vector

Definition at line 268 of file itkKdTree.h.

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

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

Return the parameters of the node.

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

Definition at line 70 of file itkKdTree.hxx.

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

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

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

Not a terminal node.

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

Definition at line 259 of file itkKdTree.h.

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

Return the left tree pointer.

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

Definition at line 274 of file itkKdTree.h.

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

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

Return the left tree const pointer.

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

Definition at line 286 of file itkKdTree.h.

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

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

Return the right tree pointer.

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

Definition at line 280 of file itkKdTree.h.

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

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

Return the right tree const pointer.

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

Definition at line 292 of file itkKdTree.h.

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

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

Return the size of the node.

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

Definition at line 298 of file itkKdTree.h.

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

Member Data Documentation

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

Definition at line 339 of file itkKdTree.h.

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

Definition at line 340 of file itkKdTree.h.

template<typename TSample >
Superclass* itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::m_Right
private
template<typename TSample >
unsigned int itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::m_Size
private
template<typename TSample >
CentroidType itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::m_WeightedCentroid
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