cvflann::KNNRadiusUniqueResultSet< DistanceType > Class Template Reference

Class that holds the k NN neighbors within a radius distance. More...

#include "result_set.h"

Inheritance diagram for cvflann::KNNRadiusUniqueResultSet< DistanceType >:

Collaboration diagram for cvflann::KNNRadiusUniqueResultSet< DistanceType >:

Public Member Functions
	KNNRadiusUniqueResultSet (unsigned int capacity, DistanceType radius)
	Constructor. More...
void	addPoint (DistanceType dist, int index)
	Add a possible candidate to the best neighbors. More...
void	clear ()
	Remove all elements in the set. More...
virtual void	copy (int *indices, DistanceType *dist, int n_neighbors=-1) const
	Copy the set to two C arrays. More...
bool	full () const
	Check the status of the set. More...
size_t	size () const
	The number of neighbors in the set. More...
virtual void	sortAndCopy (int *indices, DistanceType *dist, int n_neighbors=-1) const
	Copy the set to two C arrays but sort it according to the distance first. More...
DistanceType	worstDist () const
	The distance of the furthest neighbor If we don't have enough neighbors, it returns the max possible value. More...

Protected Types
typedef UniqueResultSet< DistanceType >::DistIndex	DistIndex

Protected Attributes
std::set< DistIndex >	dist_indices_
	The best candidates so far. More...
bool	is_full_
	Flag to say if the set is full. More...
DistanceType	worst_distance_
	The worst distance found so far. More...

Detailed Description

template<typename DistanceType>
class cvflann::KNNRadiusUniqueResultSet< DistanceType >

Class that holds the k NN neighbors within a radius distance.

Member Typedef Documentation

template<typename DistanceType>

typedef UniqueResultSet<DistanceType>::DistIndex cvflann::KNNUniqueResultSet< DistanceType >::DistIndex

protectedinherited

Constructor & Destructor Documentation

template<typename DistanceType >

cvflann::KNNRadiusUniqueResultSet< DistanceType >::KNNRadiusUniqueResultSet ( unsigned int  capacity, DistanceType  radius  )

inline

Constructor.

Parameters

capacity	the number of neighbors to store at max
radius	the maximum distance of a neighbor

Member Function Documentation

template<typename DistanceType>

void cvflann::KNNUniqueResultSet< DistanceType >::addPoint ( DistanceType  dist, int  index  )

inlinevirtualinherited

Add a possible candidate to the best neighbors.

Parameters

dist	distance for that neighbor
index	index of that neighbor

Implements cvflann::ResultSet< DistanceType >.

template<typename DistanceType >

void cvflann::KNNRadiusUniqueResultSet< DistanceType >::clear ( )

inlinevirtual

Remove all elements in the set.

Reimplemented from cvflann::KNNUniqueResultSet< DistanceType >.

template<typename DistanceType >

virtual void cvflann::UniqueResultSet< DistanceType >::copy ( int *  indices, DistanceType *  dist, int  n_neighbors = -1  ) const

inlinevirtualinherited

Copy the set to two C arrays.

Parameters

indices	pointer to a C array of indices
dist	pointer to a C array of distances
n_neighbors	the number of neighbors to copy

Referenced by cvflann::NNIndex< cv::L1< ElementType > >::knnSearch(), cvflann::LshIndex< Distance >::knnSearch(), and cvflann::NNIndex< cv::L1< ElementType > >::radiusSearch().

Here is the caller graph for this function:

template<typename DistanceType >

bool cvflann::UniqueResultSet< DistanceType >::full ( ) const

inlinevirtualinherited

Check the status of the set.

Returns

true if we have k NN

Implements cvflann::ResultSet< DistanceType >.

Reimplemented in cvflann::RadiusUniqueResultSet< DistanceType >.

template<typename DistanceType >

size_t cvflann::UniqueResultSet< DistanceType >::size ( ) const

inlineinherited

The number of neighbors in the set.

Returns

Referenced by cvflann::NNIndex< cv::L1< ElementType > >::radiusSearch().

Here is the caller graph for this function:

template<typename DistanceType >

virtual void cvflann::UniqueResultSet< DistanceType >::sortAndCopy ( int *  indices, DistanceType *  dist, int  n_neighbors = -1  ) const

inlinevirtualinherited

Copy the set to two C arrays but sort it according to the distance first.

Parameters

indices	pointer to a C array of indices
dist	pointer to a C array of distances
n_neighbors	the number of neighbors to copy

Referenced by cvflann::NNIndex< cv::L1< ElementType > >::knnSearch(), cvflann::LshIndex< Distance >::knnSearch(), and cvflann::NNIndex< cv::L1< ElementType > >::radiusSearch().

Here is the caller graph for this function:

template<typename DistanceType >

DistanceType cvflann::UniqueResultSet< DistanceType >::worstDist ( ) const

inlinevirtualinherited

The distance of the furthest neighbor If we don't have enough neighbors, it returns the max possible value.

Returns

Implements cvflann::ResultSet< DistanceType >.

Reimplemented in cvflann::RadiusUniqueResultSet< DistanceType >.

Member Data Documentation

template<typename DistanceType >

std::set<DistIndex> cvflann::UniqueResultSet< DistanceType >::dist_indices_

protectedinherited

The best candidates so far.

template<typename DistanceType >

bool cvflann::UniqueResultSet< DistanceType >::is_full_

protectedinherited

Flag to say if the set is full.

template<typename DistanceType >

DistanceType cvflann::UniqueResultSet< DistanceType >::worst_distance_

protectedinherited

The worst distance found so far.

---

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

• flann/include/opencv2/flann/result_set.h