cvflann::CompositeIndex< Distance > Class Template Reference

#include "composite_index.h"

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

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()
	)

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 ( )

virtual

Member Function Documentation

buildIndex()

template<typename Distance>

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

virtual

Builds the index.

Implements cvflann::NNIndex< Distance >.

findNeighbors()

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

getParameters()

template<typename Distance>

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

virtual

Returns

The index parameters

Implements cvflann::NNIndex< Distance >.

getType()

template<typename Distance>

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

virtual

Returns

The index type

Implements cvflann::NNIndex< Distance >.

loadIndex()

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

operator=()

template<typename Distance>

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

(

const CompositeIndex< Distance > &

)

saveIndex()

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

size()

template<typename Distance>

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

virtual

Returns

Size of the index

Implements cvflann::NNIndex< Distance >.

usedMemory()

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

veclen()

template<typename Distance>

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

virtual

Returns

The dimensionality of the features in this index.

Implements cvflann::NNIndex< Distance >.

---

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

• flann/include/opencv2/flann/composite_index.h