#include <itkKdTree.h>

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

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

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

Public Types
using	CentroidType

using	InstanceIdentifier

using	MeasurementType

using	Superclass = KdTreeNode<TSample>

Public Types inherited from itk::Statistics::KdTreeNode< TSample >
using	CentroidType = Array<double>

using	InstanceIdentifier = typename TSample::InstanceIdentifier

using	MeasurementType = typename TSample::MeasurementType

using	Self = KdTreeNode<TSample>

Public Member Functions
void	AddInstanceIdentifier (InstanceIdentifier valueId) override

void	GetCentroid (CentroidType &) override

InstanceIdentifier	GetInstanceIdentifier (InstanceIdentifier) const override

void	GetParameters (unsigned int &, MeasurementType &) const override

void	GetWeightedCentroid (CentroidType &) override

bool	IsTerminal () const override

	KdTreeNonterminalNode (unsigned int, MeasurementType, Superclass , Superclass )

const Superclass *	Left () const override

Superclass *	Left () override

const Superclass *	Right () const override

Superclass *	Right () override

unsigned int	Size () const override

	~KdTreeNonterminalNode () override=default

Public Member Functions inherited from itk::Statistics::KdTreeNode< TSample >
virtual	~KdTreeNode ()=default

Private Attributes
InstanceIdentifier	m_InstanceIdentifier {}

Superclass *	m_Left {}

unsigned int	m_PartitionDimension {}

MeasurementType	m_PartitionValue {}

Superclass *	m_Right {}

Member Typedef Documentation

◆ CentroidType

template<typename TSample>

using itk::Statistics::KdTreeNode< TSample >::CentroidType

Centroid type

Definition at line 72 of file itkKdTree.h.

◆ InstanceIdentifier

template<typename TSample>

using itk::Statistics::KdTreeNode< TSample >::InstanceIdentifier

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

Definition at line 76 of file itkKdTree.h.

◆ MeasurementType

template<typename TSample>

using itk::Statistics::KdTreeNode< TSample >::MeasurementType

Measurement type, not the measurement vector type

Definition at line 69 of file itkKdTree.h.

◆ Superclass

template<typename TSample>

using itk::Statistics::KdTreeNonterminalNode< TSample >::Superclass = KdTreeNode<TSample>

Definition at line 149 of file itkKdTree.h.

Constructor & Destructor Documentation

◆ KdTreeNonterminalNode()

template<typename TSample>

itk::Statistics::KdTreeNonterminalNode< TSample >::KdTreeNonterminalNode	(	unsigned int	,
		MeasurementType	,
		Superclass *	,
		Superclass *	)

◆ ~KdTreeNonterminalNode()

template<typename TSample>

itk::Statistics::KdTreeNonterminalNode< TSample >::~KdTreeNonterminalNode ( )

overridedefault

Member Function Documentation

◆ AddInstanceIdentifier()

template<typename TSample>

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

inlineoverridevirtual

Set the identifier of the node.

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

Definition at line 236 of file itkKdTree.h.

References m_InstanceIdentifier.

◆ GetCentroid()

template<typename TSample>

void itk::Statistics::KdTreeNonterminalNode< TSample >::GetCentroid ( CentroidType & )

inlineoverridevirtual

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

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

Definition at line 218 of file itkKdTree.h.

◆ GetInstanceIdentifier()

template<typename TSample>

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

inlinenodiscardoverridevirtual

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

References m_InstanceIdentifier.

◆ GetParameters()

template<typename TSample>

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

overridevirtual

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 >.

◆ GetWeightedCentroid()

template<typename TSample>

void itk::Statistics::KdTreeNonterminalNode< TSample >::GetWeightedCentroid ( CentroidType & )

inlineoverridevirtual

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

◆ IsTerminal()

template<typename TSample>

bool itk::Statistics::KdTreeNonterminalNode< TSample >::IsTerminal ( ) const

inlinenodiscardoverridevirtual

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

◆ Left() [1/2]

template<typename TSample>

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

inlinenodiscardoverridevirtual

Returns the const pointer to the left child of this node

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

Definition at line 183 of file itkKdTree.h.

References m_Left.

◆ Left() [2/2]

template<typename TSample>

Superclass * itk::Statistics::KdTreeNonterminalNode< TSample >::Left ( )

inlineoverridevirtual

Returns the pointer to the left child of this node

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

Definition at line 169 of file itkKdTree.h.

References m_Left.

◆ Right() [1/2]

template<typename TSample>

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

inlinenodiscardoverridevirtual

Returns the const pointer to the right child of this node

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

Definition at line 190 of file itkKdTree.h.

References m_Right.

◆ Right() [2/2]

template<typename TSample>

Superclass * itk::Statistics::KdTreeNonterminalNode< TSample >::Right ( )

inlineoverridevirtual

Returns the pointer to the right child of this node

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

Definition at line 176 of file itkKdTree.h.

References m_Right.

◆ Size()

template<typename TSample>

unsigned int itk::Statistics::KdTreeNonterminalNode< TSample >::Size ( ) const

inlinenodiscardoverridevirtual

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

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

Definition at line 200 of file itkKdTree.h.

Member Data Documentation

◆ m_InstanceIdentifier

template<typename TSample>

InstanceIdentifier itk::Statistics::KdTreeNonterminalNode< TSample >::m_InstanceIdentifier {}

private

Definition at line 244 of file itkKdTree.h.

Referenced by AddInstanceIdentifier(), and GetInstanceIdentifier().

◆ m_Left

template<typename TSample>

Superclass* itk::Statistics::KdTreeNonterminalNode< TSample >::m_Left {}

private

Definition at line 245 of file itkKdTree.h.

Referenced by Left(), and Left().

◆ m_PartitionDimension

template<typename TSample>

unsigned int itk::Statistics::KdTreeNonterminalNode< TSample >::m_PartitionDimension {}

private

Definition at line 242 of file itkKdTree.h.

◆ m_PartitionValue

template<typename TSample>

MeasurementType itk::Statistics::KdTreeNonterminalNode< TSample >::m_PartitionValue {}

private

Definition at line 243 of file itkKdTree.h.

◆ m_Right

template<typename TSample>

Superclass* itk::Statistics::KdTreeNonterminalNode< TSample >::m_Right {}

private

Definition at line 246 of file itkKdTree.h.

Referenced by Right(), and Right().

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

itkKdTree.h

Detailed Description

Public Types

Public Member Functions

Private Attributes

Member Typedef Documentation

◆ CentroidType

◆ InstanceIdentifier

◆ MeasurementType

◆ Superclass

Constructor & Destructor Documentation

◆ KdTreeNonterminalNode()

◆ ~KdTreeNonterminalNode()

Member Function Documentation

◆ AddInstanceIdentifier()

◆ GetCentroid()

◆ GetInstanceIdentifier()

◆ GetParameters()

◆ GetWeightedCentroid()

◆ IsTerminal()

◆ Left() [1/2]

◆ Left() [2/2]

◆ Right() [1/2]

◆ Right() [2/2]

◆ Size()

Member Data Documentation

◆ m_InstanceIdentifier

◆ m_Left

◆ m_PartitionDimension

◆ m_PartitionValue

◆ m_Right