itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample > Class Template Reference

#include <itkKdTree.h>

Inheritance diagram for itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >:

[legend]

Collaboration diagram for itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >:

[legend]

List of all members.

---

Detailed Description

template<class 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 205 of file itkKdTree.h.

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
virtual void	AddInstanceIdentifier (InstanceIdentifier id)=0
void	AddInstanceIdentifier (InstanceIdentifier valueId)
void	GetCentroid (CentroidType &centroid)
InstanceIdentifier	GetInstanceIdentifier (vcl_size_t) const
MeasurementVectorSizeType	GetMeasurementVectorSize () const
virtual void	GetParameters (unsigned int &partitionDimension, MeasurementType &partitionValue) const =0
void	GetParameters (unsigned int &partitionDimension, MeasurementType &partitionValue) const
void	GetWeightedCentroid (CentroidType &centroid)
virtual bool	IsTerminal () const
	KdTreeWeightedCentroidNonterminalNode (unsigned int partitionDimension, MeasurementType partitionValue, Superclass *left, Superclass *right, CentroidType &centroid, unsigned int size)
const Superclass *	Left () const
Superclass *	Left ()
const Superclass *	Right () const
Superclass *	Right ()
unsigned int	Size () const
virtual	~KdTreeWeightedCentroidNonterminalNode ()

---

Member Typedef Documentation

template<class TSample>

typedef Superclass::CentroidType itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::CentroidType

Centroid type

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

Definition at line 209 of file itkKdTree.h.

template<class TSample>

typedef Superclass::InstanceIdentifier itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::InstanceIdentifier

Instance identifier type (index value type for the measurement vector in a sample

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

Definition at line 210 of file itkKdTree.h.

template<class TSample>

typedef Superclass::MeasurementType itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::MeasurementType

Measurement type, not the measurement vector type

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

Definition at line 208 of file itkKdTree.h.

template<class TSample>

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

Definition at line 211 of file itkKdTree.h.

template<class TSample>

typedef KdTreeNode< TSample> itk::Statistics::KdTreeNode< TSample >::Self [inherited]

type alias for itself

Definition at line 66 of file itkKdTree.h.

template<class TSample>

typedef KdTreeNode< TSample > itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::Superclass

Definition at line 207 of file itkKdTree.h.

---

Constructor & Destructor Documentation

template<class TSample>

itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::KdTreeWeightedCentroidNonterminalNode	(	unsigned int	partitionDimension,
		MeasurementType	partitionValue,
		Superclass *	left,
		Superclass *	right,
		CentroidType &	centroid,
		unsigned int	size
	)

template<class TSample>

virtual itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::~KdTreeWeightedCentroidNonterminalNode

(

)

[inline, virtual]

Definition at line 219 of file itkKdTree.h.

---

Member Function Documentation

template<class TSample>

virtual void itk::Statistics::KdTreeNode< TSample >::AddInstanceIdentifier

(

InstanceIdentifier

id

)

[pure virtual, inherited]

Add an instance to this node

template<class TSample>

void itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::AddInstanceIdentifier

(

InstanceIdentifier

valueId

)

[inline]

Definition at line 258 of file itkKdTree.h.

template<class TSample>

void itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::GetCentroid

(

CentroidType &

centroid

)

[inline, virtual]

Returns the centroid. weighted centroid divided by the size

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

Definition at line 252 of file itkKdTree.h.

template<class TSample>

InstanceIdentifier itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::GetInstanceIdentifier

(

vcl_size_t

index

)

const [inline, virtual]

Retuns the instance identifier of the index-th measurement vector

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

Definition at line 255 of file itkKdTree.h.

template<class TSample>

MeasurementVectorSizeType itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::GetMeasurementVectorSize

(

)

const [inline]

Return the length of a measurement vector

Definition at line 228 of file itkKdTree.h.

template<class TSample>

virtual void itk::Statistics::KdTreeNode< TSample >::GetParameters	(	unsigned int &	partitionDimension,
		MeasurementType &	partitionValue
	)			const [pure virtual, inherited]

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

template<class TSample>

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

template<class TSample>

void itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::GetWeightedCentroid

(

CentroidType &

centroid

)

[inline, virtual]

Returns the vector sum of the all measurement vectors under this node

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

Definition at line 249 of file itkKdTree.h.

template<class TSample>

virtual bool itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::IsTerminal

(

)

const [inline, virtual]

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

template<class TSample>

const Superclass* itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::Left

(

)

const [inline, virtual]

Returns the pointer to the left child of this node

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

Definition at line 240 of file itkKdTree.h.

template<class TSample>

Superclass* itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::Left

(

)

[inline, virtual]

Returns the pointer to the left child of this node

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

Definition at line 233 of file itkKdTree.h.

template<class TSample>

const Superclass* itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::Right

(

)

const [inline, virtual]

Returns the pointer to the right child of this node

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

Definition at line 243 of file itkKdTree.h.

template<class TSample>

Superclass* itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::Right

(

)

[inline, virtual]

Returns the pointer to the right child of this node

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

Definition at line 236 of file itkKdTree.h.

template<class TSample>

unsigned int itk::Statistics::KdTreeWeightedCentroidNonterminalNode< TSample >::Size

(

)

const [inline, virtual]

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

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

Definition at line 246 of file itkKdTree.h.

---

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

• itkKdTree.h