Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

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

#include <itkKdTree.h>

List of all members.


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

Public Member Functions

const std::vector< double > & GetDistances () const
double GetLargestDistance ()
InstanceIdentifier GetNeighbor (unsigned int index) const
const InstanceIdentifierVectorTypeGetNeighbors () const
 NearestNeighbors ()
 ~NearestNeighbors ()
void ReplaceFarthestNeighbor (InstanceIdentifier id, double distance)
void resize (unsigned int k)


Constructor & Destructor Documentation

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

Constructor

Definition at line 422 of file itkKdTree.h.

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

Destructor

Definition at line 425 of file itkKdTree.h.


Member Function Documentation

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

Returns the vector of k-neighbors' instance identifiers

Definition at line 472 of file itkKdTree.h.

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

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

Returns the instance identifier of the index-th neighbor among k-neighbors

Definition at line 468 of file itkKdTree.h.

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

Returns the vector of k-neighbors' instance identifiers

Definition at line 463 of file itkKdTree.h.

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


The documentation for this class was generated from the following file:
Generated at Wed Jul 30 12:59:34 2008 for ITK by doxygen 1.5.1 written by Dimitri van Heesch, © 1997-2000