ITK 6.0.0
Insight Toolkit
 
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Private Attributes | List of all members
itk::Statistics::KdTreeTerminalNode< TSample > Class Template Reference
Group Numerics » Module ITKStatistics

#include <itkKdTree.h>

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

+ Inheritance diagram for itk::Statistics::KdTreeTerminalNode< TSample >:
+ Collaboration diagram for itk::Statistics::KdTreeTerminalNode< 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 id) override
 
void GetCentroid (CentroidType &) override
 
InstanceIdentifier GetInstanceIdentifier (InstanceIdentifier index) const override
 
void GetParameters (unsigned int &, MeasurementType &) const override
 
void GetWeightedCentroid (CentroidType &) override
 
bool IsTerminal () const override
 
 KdTreeTerminalNode ()=default
 
const Superclass * Left () const override
 
Superclass * Left () override
 
const Superclass * Right () const override
 
Superclass * Right () override
 
unsigned int Size () const override
 
 ~KdTreeTerminalNode () override
 
- Public Member Functions inherited from itk::Statistics::KdTreeNode< TSample >
virtual ~KdTreeNode ()=default
 

Private Attributes

std::vector< InstanceIdentifier > m_InstanceIdentifiers {}
 

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::KdTreeTerminalNode< TSample >::Superclass = KdTreeNode<TSample>

Definition at line 402 of file itkKdTree.h.

Constructor & Destructor Documentation

◆ KdTreeTerminalNode()

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

◆ ~KdTreeTerminalNode()

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

Definition at line 409 of file itkKdTree.h.

References m_InstanceIdentifiers.

Member Function Documentation

◆ AddInstanceIdentifier()

template<typename TSample>
void itk::Statistics::KdTreeTerminalNode< TSample >::AddInstanceIdentifier ( InstanceIdentifier id)
inlineoverridevirtual

Set the identifier of the node.

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

Definition at line 489 of file itkKdTree.h.

References m_InstanceIdentifiers.

◆ GetCentroid()

template<typename TSample>
void itk::Statistics::KdTreeTerminalNode< TSample >::GetCentroid ( CentroidType & )
inlineoverridevirtual

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

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

Definition at line 471 of file itkKdTree.h.

◆ GetInstanceIdentifier()

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

References m_InstanceIdentifiers.

◆ GetParameters()

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

Return the parameters of the node.

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

Definition at line 420 of file itkKdTree.h.

◆ GetWeightedCentroid()

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

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

◆ IsTerminal()

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

A terminal node.

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

Definition at line 413 of file itkKdTree.h.

◆ Left() [1/2]

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

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

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

Definition at line 439 of file itkKdTree.h.

◆ Left() [2/2]

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

Return the left tree pointer. Null for terminal nodes.

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

Definition at line 425 of file itkKdTree.h.

◆ Right() [1/2]

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

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

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

Definition at line 446 of file itkKdTree.h.

◆ Right() [2/2]

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

Return the right tree pointer. Null for terminal nodes.

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

Definition at line 432 of file itkKdTree.h.

◆ Size()

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

Return the size of the node.

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

Definition at line 453 of file itkKdTree.h.

References m_InstanceIdentifiers.

Member Data Documentation

◆ m_InstanceIdentifiers

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

Definition at line 495 of file itkKdTree.h.

Referenced by AddInstanceIdentifier(), GetInstanceIdentifier(), Size(), and ~KdTreeTerminalNode().

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