cvflann::Index< Distance > Class Template Reference

#include <flann_base.hpp>

Inherits cvflann::NNIndex< Distance >.

List of all members.

Public Types
typedef Distance::ElementType	ElementType
typedef Distance::ResultType	DistanceType
Public Member Functions
	Index (const Matrix< ElementType > &features, const IndexParams &params, Distance distance=Distance())
	~Index ()
void	buildIndex ()
void	save (std::string filename)
virtual void	saveIndex (FILE *stream)
	Saves the index to a stream.
virtual void	loadIndex (FILE *stream)
	Loads the index from a stream.
size_t	veclen () const
size_t	size () const
flann_algorithm_t	getType () const
virtual int	usedMemory () const
IndexParams	getParameters () const
void	knnSearch (const Matrix< ElementType > &queries, Matrix< int > &indices, Matrix< DistanceType > &dists, int knn, const SearchParams &params)
	Perform k-nearest neighbor search.
int	radiusSearch (const Matrix< ElementType > &query, Matrix< int > &indices, Matrix< DistanceType > &dists, float radius, const SearchParams &params)
	Perform radius search.
void	findNeighbors (ResultSet< DistanceType > &result, const ElementType *vec, const SearchParams &searchParams)
	Method that searches for nearest-neighbours.
FLANN_DEPRECATED NNIndex < Distance > *	getIndex ()
	Returns actual index.
FLANN_DEPRECATED const IndexParams *	getIndexParameters ()
	Returns index parameters.

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

---

Member Typedef Documentation

template<typename Distance>

typedef Distance::ElementType cvflann::Index< Distance >::ElementType

Reimplemented from cvflann::NNIndex< Distance >.

template<typename Distance>

typedef Distance::ResultType cvflann::Index< Distance >::DistanceType

Reimplemented from cvflann::NNIndex< Distance >.

---

Constructor & Destructor Documentation

template<typename Distance>

cvflann::Index< Distance >::Index	(	const Matrix< ElementType > &	features,
		const IndexParams &	params,
		Distance	distance = Distance()
	)

template<typename Distance>

cvflann::Index< Distance >::~Index

(

)

---

Member Function Documentation

template<typename Distance>

void cvflann::Index< Distance >::buildIndex

(

)

[virtual]

Builds the index.

Implements cvflann::NNIndex< Distance >.

template<typename Distance>

void cvflann::Index< Distance >::save

(

std::string

filename

)

template<typename Distance>

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

(

FILE *

stream

)

[virtual]

Saves the index to a stream.

Parameters:

stream

The stream to save the index to

Implements cvflann::NNIndex< Distance >.

template<typename Distance>

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

(

FILE *

stream

)

[virtual]

Loads the index from a stream.

Parameters:

stream

The stream from which the index is loaded

Implements cvflann::NNIndex< Distance >.

template<typename Distance>

size_t cvflann::Index< Distance >::veclen

(

)

const [virtual]

Returns:

number of features in this index.

Implements cvflann::NNIndex< Distance >.

template<typename Distance>

size_t cvflann::Index< Distance >::size

(

)

const [virtual]

Returns:

The dimensionality of the features in this index.

Implements cvflann::NNIndex< Distance >.

template<typename Distance>

flann_algorithm_t cvflann::Index< Distance >::getType

(

)

const [virtual]

Returns:

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

Implements cvflann::NNIndex< Distance >.

template<typename Distance>

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

(

)

const [virtual]

Returns:

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

Implements cvflann::NNIndex< Distance >.

template<typename Distance>

IndexParams cvflann::Index< Distance >::getParameters

(

)

const [virtual]

Returns:

The index parameters

Implements cvflann::NNIndex< Distance >.

template<typename Distance>

void cvflann::Index< 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 from cvflann::NNIndex< Distance >.

template<typename Distance>

int cvflann::Index< 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 from cvflann::NNIndex< Distance >.

template<typename Distance>

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

Method that searches for nearest-neighbours.

Implements cvflann::NNIndex< Distance >.

template<typename Distance>

FLANN_DEPRECATED NNIndex<Distance>* cvflann::Index< Distance >::getIndex

(

)

Returns actual index.

template<typename Distance>

FLANN_DEPRECATED const IndexParams* cvflann::Index< Distance >::getIndexParameters

(

)

Returns index parameters.

---

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

• include/opencv2/flann/flann_base.hpp