itk::Statistics::KdTree< TSample >::NearestNeighbors Class Reference

data structure for storing k-nearest neighbor search result (k number of Neighbors) More...

#include <itkKdTree.h>

List of all members.

Public Member Functions
	NearestNeighbors ()
	~NearestNeighbors ()
double	GetLargestDistance ()
InstanceIdentifierVectorType	GetNeighbors ()
InstanceIdentifier	GetNeighbor (unsigned int index)
std::vector< double > &	GetDistances ()
void	resize (unsigned int k)
void	ReplaceFarthestNeighbor (InstanceIdentifier id, double distance)

---

Detailed Description

template<class TSample>
class itk::Statistics::KdTree< TSample >::NearestNeighbors

data structure for storing k-nearest neighbor search result (k number of Neighbors)

This class stores the instance identifiers and the distance values of k-nearest neighbors. We can also query the farthest neighbor's distance from the query point using the GetLargestDistance method.

Definition at line 369 of file itkKdTree.h.

---

Constructor & Destructor Documentation

template<class TSample> itk::Statistics::KdTree< TSample >::NearestNeighbors::NearestNeighbors (   )  [inline]

Constructor Definition at line 373 of file itkKdTree.h.

template<class TSample> itk::Statistics::KdTree< TSample >::NearestNeighbors::~NearestNeighbors (   )  [inline]

Destructor Definition at line 376 of file itkKdTree.h.

---

Member Function Documentation

template<class TSample> std::vector< double >& itk::Statistics::KdTree< TSample >::NearestNeighbors::GetDistances (   )  [inline]

Returns the vector of k-neighbors' instance identifiers Definition at line 423 of file itkKdTree.h. References itk::Statistics::KdTree< TSample >::InstanceIdentifierVectorType.

template<class TSample> double itk::Statistics::KdTree< TSample >::NearestNeighbors::GetLargestDistance (   )  [inline]

Returns the distance of the farthest neighbor from the query point Definition at line 391 of file itkKdTree.h.

template<class TSample> InstanceIdentifier itk::Statistics::KdTree< TSample >::NearestNeighbors::GetNeighbor (  unsigned int  index  )  [inline]

Returns the instance identifier of the index-th neighbor among k-neighbors Definition at line 419 of file itkKdTree.h.

template<class TSample> InstanceIdentifierVectorType itk::Statistics::KdTree< TSample >::NearestNeighbors::GetNeighbors (   )  [inline]

Returns the vector of k-neighbors' instance identifiers Definition at line 414 of file itkKdTree.h. References itk::Statistics::KdTree< TSample >::InstanceIdentifier.

template<class TSample> void itk::Statistics::KdTree< TSample >::NearestNeighbors::ReplaceFarthestNeighbor (  InstanceIdentifier  id, double  distance )  [inline]

Replaces the farthest neighbor's instance identifier and distance value with the id and the distance Definition at line 396 of file itkKdTree.h.

template<class TSample> void itk::Statistics::KdTree< TSample >::NearestNeighbors::resize (  unsigned int  k  )  [inline]

Initialize the internal instance identifier and distance holders with the size, k Definition at line 380 of file itkKdTree.h.

---

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

• itkKdTree.h

---