cvflann::CompositeIndex< Distance > Class Template Reference

This index builds a kd-tree index and a k-means index and performs nearest neighbour search both indexes. More...

#include <opencv2/flann/composite_index.h>

Inheritance diagram for cvflann::CompositeIndex< Distance >:

Collaboration diagram for cvflann::CompositeIndex< Distance >:

Public Types
typedef Distance::ResultType	DistanceType
typedef Distance::ElementType	ElementType

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

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

DistanceType

template<typename Distance>

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

ElementType

template<typename Distance>

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

Constructor & Destructor Documentation

CompositeIndex() [1/2]

template<typename Distance>

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

inline

Index constructor.

Parameters

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

Returns

CompositeIndex() [2/2]

template<typename Distance>

cvflann::CompositeIndex< Distance >::CompositeIndex

(

const CompositeIndex< Distance > &

)

~CompositeIndex()

template<typename Distance>

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

inlinevirtual

Member Function Documentation

buildIndex()

template<typename Distance>

void cvflann::CompositeIndex< Distance >::buildIndex ( )

inlinevirtual

Builds the index.

Implements cvflann::NNIndex< Distance >.

References cvflann::Logger::info().

Here is the call graph for this function:

findNeighbors()

template<typename Distance>

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

inlinevirtual

Method that searches for nearest-neighbours.

Implements cvflann::NNIndex< Distance >.

getParameters()

template<typename Distance>

IndexParams cvflann::CompositeIndex< Distance >::getParameters ( ) const

inlinevirtual

Returns

The index parameters

Implements cvflann::NNIndex< Distance >.

getType()

template<typename Distance>

flann_algorithm_t cvflann::CompositeIndex< Distance >::getType ( ) const

inlinevirtual

Returns

The index type

Implements cvflann::NNIndex< Distance >.

References cvflann::FLANN_INDEX_COMPOSITE.

knnSearch()

template<typename Distance>

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

inlinevirtualinherited

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< cv::L2< ElementType > >, cvflann::Index< cv::L1< ElementType > >, cvflann::KDTreeSingleIndex< Distance >, and cvflann::LshIndex< Distance >.

loadIndex()

template<typename Distance>

void cvflann::CompositeIndex< Distance >::loadIndex ( FILE *  stream )

inlinevirtual

Loads the index from a stream.

Parameters

stream

The stream from which the index is loaded

Implements cvflann::NNIndex< Distance >.

operator=()

template<typename Distance>

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

(

const CompositeIndex< Distance > &

)

radiusSearch()

template<typename Distance>

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

inlinevirtualinherited

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< cv::L2< ElementType > >, and cvflann::Index< cv::L1< ElementType > >.

saveIndex()

template<typename Distance>

void cvflann::CompositeIndex< Distance >::saveIndex ( FILE *  stream )

inlinevirtual

Saves the index to a stream.

Parameters

stream

The stream to save the index to

Implements cvflann::NNIndex< Distance >.

size()

template<typename Distance>

size_t cvflann::CompositeIndex< Distance >::size ( ) const

inlinevirtual

Returns

Size of the index

Implements cvflann::NNIndex< Distance >.

usedMemory()

template<typename Distance>

int cvflann::CompositeIndex< Distance >::usedMemory ( ) const

inlinevirtual

Returns

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

Implements cvflann::NNIndex< Distance >.

veclen()

template<typename Distance>

size_t cvflann::CompositeIndex< Distance >::veclen ( ) const

inlinevirtual

Returns

The dimensionality of the features in this index.

Implements cvflann::NNIndex< Distance >.

---

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

• opencv2/flann/composite_index.h