cvflann::CompositeIndex< Distance > Class Template Reference

#include <composite_index.h>

Inherits cvflann::NNIndex< Distance >.

List of all members.

Public Types
typedef Distance::ElementType	ElementType
typedef Distance::ResultType	DistanceType
Public Member Functions
	CompositeIndex (const Matrix< ElementType > &inputData, const IndexParams &params=CompositeIndexParams(), Distance d=Distance())
	CompositeIndex (const CompositeIndex &)
CompositeIndex &	operator= (const CompositeIndex &)
virtual	~CompositeIndex ()
flann_algorithm_t	getType () const
size_t	size () const
size_t	veclen () const
int	usedMemory () const
void	buildIndex ()
	Builds the index.
void	saveIndex (FILE *stream)
	Saves the index to a stream.
void	loadIndex (FILE *stream)
	Loads the index from a stream.
IndexParams	getParameters () const
void	findNeighbors (ResultSet< DistanceType > &result, const ElementType *vec, const SearchParams &searchParams)
	Method that searches for nearest-neighbours.
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.

---

Detailed Description

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

This index builds a kd-tree index and a k-means index and performs nearest neighbour search both indexes. This gives a slight boost in search performance as some of the neighbours that are missed by one index are found by the other.

---

Member Typedef Documentation

template<typename Distance>

typedef Distance::ElementType cvflann::CompositeIndex< Distance >::ElementType

Reimplemented from cvflann::NNIndex< Distance >.

template<typename Distance>

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

Reimplemented from cvflann::NNIndex< Distance >.

---

Constructor & Destructor Documentation

template<typename Distance>

cvflann::CompositeIndex< Distance >::CompositeIndex	(	const Matrix< ElementType > &	inputData,
		const IndexParams &	params = CompositeIndexParams(),
		Distance	d = Distance()
	)

Index constructor

Parameters:

inputData	dataset containing the points to index
params	Index parameters
d	Distance functor

Returns:

template<typename Distance>

cvflann::CompositeIndex< Distance >::CompositeIndex

(

const CompositeIndex< Distance > &

)

template<typename Distance>

virtual cvflann::CompositeIndex< Distance >::~CompositeIndex

(

)

[virtual]

---

Member Function Documentation

template<typename Distance>

CompositeIndex& cvflann::CompositeIndex< Distance >::operator=

(

const CompositeIndex< Distance > &

)

template<typename Distance>

flann_algorithm_t cvflann::CompositeIndex< Distance >::getType

(

)

const [virtual]

Returns:

The index type

Implements cvflann::NNIndex< Distance >.

template<typename Distance>

size_t cvflann::CompositeIndex< Distance >::size

(

)

const [virtual]

Returns:

Size of the index

Implements cvflann::NNIndex< Distance >.

template<typename Distance>

size_t cvflann::CompositeIndex< Distance >::veclen

(

)

const [virtual]

Returns:

The dimensionality of the features in this index.

Implements cvflann::NNIndex< Distance >.

template<typename Distance>

int cvflann::CompositeIndex< Distance >::usedMemory

(

)

const [virtual]

Returns:

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

Implements cvflann::NNIndex< Distance >.

template<typename Distance>

void cvflann::CompositeIndex< Distance >::buildIndex

(

)

[virtual]

Builds the index.

Implements cvflann::NNIndex< Distance >.

template<typename Distance>

void cvflann::CompositeIndex< 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>

void cvflann::CompositeIndex< 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>

IndexParams cvflann::CompositeIndex< Distance >::getParameters

(

)

const [virtual]

Returns:

The index parameters

Implements cvflann::NNIndex< Distance >.

template<typename Distance>

void cvflann::CompositeIndex< 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>

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

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, inherited]

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 > >.

---

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

• include/opencv2/flann/composite_index.h