cvflann::NNIndex< Distance > Class Template Reference

#include <nn_index.h>

Inherited by cvflann::AutotunedIndex< Distance >, cvflann::CompositeIndex< Distance >, cvflann::HierarchicalClusteringIndex< Distance >, cvflann::Index< Distance >, cvflann::KDTreeIndex< Distance >, cvflann::KDTreeSingleIndex< Distance >, cvflann::KMeansIndex< Distance >, cvflann::LinearIndex< Distance >, and cvflann::LshIndex< Distance >.

List of all members.

Public Member Functions
virtual	~NNIndex ()
virtual void	buildIndex ()=0
	Builds the index.
virtual void	knnSearch (const Matrix< ElementType > &queries, Matrix< int > &indices, Matrix< DistanceType > &dists, int knn, const SearchParams &params)
	Perform k-nearest neighbor search.
virtual int	radiusSearch (const Matrix< ElementType > &query, Matrix< int > &indices, Matrix< DistanceType > &dists, float radius, const SearchParams &params)
	Perform radius search.
virtual void	saveIndex (FILE *stream)=0
	Saves the index to a stream.
virtual void	loadIndex (FILE *stream)=0
	Loads the index from a stream.
virtual size_t	size () const =0
virtual size_t	veclen () const =0
virtual int	usedMemory () const =0
virtual flann_algorithm_t	getType () const =0
virtual IndexParams	getParameters () const =0
virtual void	findNeighbors (ResultSet< DistanceType > &result, const ElementType *vec, const SearchParams &searchParams)=0
	Method that searches for nearest-neighbours.

---

Detailed Description

template<typename Distance>
class cvflann::NNIndex< Distance >

Nearest-neighbour index base class

---

Constructor & Destructor Documentation

template<typename Distance>

virtual cvflann::NNIndex< Distance >::~NNIndex

(

)

[virtual]

---

Member Function Documentation

template<typename Distance>

virtual void cvflann::NNIndex< Distance >::buildIndex

(

)

[pure virtual]

Builds the index.

Implemented in cvflann::KMeansIndex< Distance >, cvflann::HierarchicalClusteringIndex< Distance >, cvflann::CompositeIndex< Distance >, cvflann::Index< Distance >, cvflann::Index< L1< ElementType > >, cvflann::Index< L2< ElementType > >, cvflann::KDTreeIndex< Distance >, cvflann::KDTreeSingleIndex< Distance >, cvflann::LshIndex< Distance >, cvflann::AutotunedIndex< Distance >, and cvflann::LinearIndex< Distance >.

template<typename Distance>

virtual void cvflann::NNIndex< Distance >::knnSearch	(	const Matrix< ElementType > &	queries,
		Matrix< int > &	indices,
		Matrix< DistanceType > &	dists,
		int	knn,
		const SearchParams &	params
	)		[virtual]

Perform k-nearest neighbor search.

Parameters:

[in]	queries	The query points for which to find the nearest neighbors
[out]	indices	The indices of the nearest neighbors found
[out]	dists	Distances to the nearest neighbors found
[in]	knn	Number of nearest neighbors to return
[in]	params	Search parameters

Reimplemented in cvflann::Index< Distance >, cvflann::Index< L1< ElementType > >, cvflann::Index< L2< ElementType > >, cvflann::KDTreeSingleIndex< Distance >, and cvflann::LshIndex< Distance >.

template<typename Distance>

virtual int cvflann::NNIndex< Distance >::radiusSearch	(	const Matrix< ElementType > &	query,
		Matrix< int > &	indices,
		Matrix< DistanceType > &	dists,
		float	radius,
		const SearchParams &	params
	)		[virtual]

Perform radius search.

Parameters:

[in]	query	The query point
[out]	indices	The indinces of the neighbors found within the given radius
[out]	dists	The distances to the nearest neighbors found
[in]	radius	The radius used for search
[in]	params	Search parameters

Returns:

Number of neighbors found

Reimplemented in cvflann::Index< Distance >, cvflann::Index< L1< ElementType > >, and cvflann::Index< L2< ElementType > >.

template<typename Distance>

virtual void cvflann::NNIndex< Distance >::saveIndex

(

FILE *

stream

)

[pure virtual]

Saves the index to a stream.

Parameters:

stream

The stream to save the index to

Implemented in cvflann::KMeansIndex< Distance >, cvflann::HierarchicalClusteringIndex< Distance >, cvflann::Index< Distance >, cvflann::Index< L1< ElementType > >, cvflann::Index< L2< ElementType > >, cvflann::CompositeIndex< Distance >, cvflann::KDTreeSingleIndex< Distance >, cvflann::KDTreeIndex< Distance >, cvflann::LshIndex< Distance >, cvflann::AutotunedIndex< Distance >, and cvflann::LinearIndex< Distance >.

template<typename Distance>

virtual void cvflann::NNIndex< Distance >::loadIndex

(

FILE *

stream

)

[pure virtual]

Loads the index from a stream.

Parameters:

stream

The stream from which the index is loaded

Implemented in cvflann::KMeansIndex< Distance >, cvflann::HierarchicalClusteringIndex< Distance >, cvflann::Index< Distance >, cvflann::Index< L1< ElementType > >, cvflann::Index< L2< ElementType > >, cvflann::CompositeIndex< Distance >, cvflann::KDTreeSingleIndex< Distance >, cvflann::KDTreeIndex< Distance >, cvflann::LshIndex< Distance >, cvflann::AutotunedIndex< Distance >, and cvflann::LinearIndex< Distance >.

template<typename Distance>

virtual size_t cvflann::NNIndex< Distance >::size

(

)

const [pure virtual]

Returns:

number of features in this index.

Implemented in cvflann::KMeansIndex< Distance >, cvflann::HierarchicalClusteringIndex< Distance >, cvflann::KDTreeSingleIndex< Distance >, cvflann::AutotunedIndex< Distance >, cvflann::Index< Distance >, cvflann::Index< L1< ElementType > >, cvflann::Index< L2< ElementType > >, cvflann::KDTreeIndex< Distance >, cvflann::LshIndex< Distance >, cvflann::CompositeIndex< Distance >, and cvflann::LinearIndex< Distance >.

template<typename Distance>

virtual size_t cvflann::NNIndex< Distance >::veclen

(

)

const [pure virtual]

Returns:

The dimensionality of the features in this index.

Implemented in cvflann::KMeansIndex< Distance >, cvflann::HierarchicalClusteringIndex< Distance >, cvflann::KDTreeSingleIndex< Distance >, cvflann::AutotunedIndex< Distance >, cvflann::KDTreeIndex< Distance >, cvflann::Index< Distance >, cvflann::Index< L1< ElementType > >, cvflann::Index< L2< ElementType > >, cvflann::LshIndex< Distance >, cvflann::CompositeIndex< Distance >, and cvflann::LinearIndex< Distance >.

template<typename Distance>

virtual int cvflann::NNIndex< Distance >::usedMemory

(

)

const [pure virtual]

Returns:

The amount of memory (in bytes) used by the index.

Implemented in cvflann::KMeansIndex< Distance >, cvflann::HierarchicalClusteringIndex< Distance >, cvflann::KDTreeSingleIndex< Distance >, cvflann::AutotunedIndex< Distance >, cvflann::Index< Distance >, cvflann::Index< L1< ElementType > >, cvflann::Index< L2< ElementType > >, cvflann::KDTreeIndex< Distance >, cvflann::LshIndex< Distance >, cvflann::CompositeIndex< Distance >, and cvflann::LinearIndex< Distance >.

template<typename Distance>

virtual flann_algorithm_t cvflann::NNIndex< Distance >::getType

(

)

const [pure virtual]

Returns:

The index type (kdtree, kmeans,...)

Implemented in cvflann::HierarchicalClusteringIndex< Distance >, cvflann::KMeansIndex< Distance >, cvflann::AutotunedIndex< Distance >, cvflann::Index< Distance >, cvflann::Index< L1< ElementType > >, cvflann::Index< L2< ElementType > >, cvflann::KDTreeSingleIndex< Distance >, cvflann::KDTreeIndex< Distance >, cvflann::LshIndex< Distance >, cvflann::CompositeIndex< Distance >, and cvflann::LinearIndex< Distance >.

template<typename Distance>

virtual IndexParams cvflann::NNIndex< Distance >::getParameters

(

)

const [pure virtual]

Returns:

The index parameters

Implemented in cvflann::KMeansIndex< Distance >, cvflann::HierarchicalClusteringIndex< Distance >, cvflann::KDTreeSingleIndex< Distance >, cvflann::KDTreeIndex< Distance >, cvflann::Index< Distance >, cvflann::Index< L1< ElementType > >, cvflann::Index< L2< ElementType > >, cvflann::LshIndex< Distance >, cvflann::CompositeIndex< Distance >, cvflann::AutotunedIndex< Distance >, and cvflann::LinearIndex< Distance >.

template<typename Distance>

virtual void cvflann::NNIndex< Distance >::findNeighbors	(	ResultSet< DistanceType > &	result,
		const ElementType *	vec,
		const SearchParams &	searchParams
	)		[pure virtual]

Method that searches for nearest-neighbours.

Implemented in cvflann::KMeansIndex< Distance >, cvflann::HierarchicalClusteringIndex< Distance >, cvflann::KDTreeSingleIndex< Distance >, cvflann::Index< Distance >, cvflann::Index< L1< ElementType > >, cvflann::Index< L2< ElementType > >, cvflann::LshIndex< Distance >, cvflann::KDTreeIndex< Distance >, cvflann::CompositeIndex< Distance >, cvflann::AutotunedIndex< Distance >, and cvflann::LinearIndex< Distance >.

---

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

• include/opencv2/flann/nn_index.h