#include <opencv2/flann/hierarchical_clustering_index.h>

Inheritance diagram for cvflann::HierarchicalClusteringIndex< Distance >:

Public Types
typedef Distance::ResultType	DistanceType

typedef Distance::ElementType	ElementType

Public Member Functions
	HierarchicalClusteringIndex (const Matrix< ElementType > &inputData, const IndexParams &index_params=HierarchicalClusteringIndexParams(), Distance d=Distance())

	HierarchicalClusteringIndex (const HierarchicalClusteringIndex &)

virtual	~HierarchicalClusteringIndex ()

void	buildIndex () CV_OVERRIDE

void	findNeighbors (ResultSet< DistanceType > &result, const ElementType *vec, const SearchParams &searchParams) CV_OVERRIDE

void	free_elements ()

IndexParams	getParameters () const CV_OVERRIDE

flann_algorithm_t	getType () const CV_OVERRIDE

void	loadIndex (FILE *stream) CV_OVERRIDE
	Loads the index from a stream.

HierarchicalClusteringIndex &	operator= (const HierarchicalClusteringIndex &)

void	saveIndex (FILE *stream) CV_OVERRIDE
	Saves the index to a stream.

size_t	size () const CV_OVERRIDE

int	usedMemory () const CV_OVERRIDE

size_t	veclen () const CV_OVERRIDE

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.

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::HierarchicalClusteringIndex< Distance >

Hierarchical index

Contains a tree constructed through a hierarchical clustering and other information for indexing a set of points for nearest-neighbour matching.

Member Typedef Documentation

template<typename Distance>

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

template<typename Distance>

typedef Distance::ElementType cvflann::HierarchicalClusteringIndex< Distance >::ElementType

Constructor & Destructor Documentation

template<typename Distance>

cvflann::HierarchicalClusteringIndex< Distance >::HierarchicalClusteringIndex	(	const Matrix< ElementType > &	inputData,
		const IndexParams &	index_params = `HierarchicalClusteringIndexParams()`,
		Distance	d = `Distance()`
	)

inline

Index constructor

Params: inputData = dataset with the input features params = parameters passed to the hierarchical k-means algorithm

template<typename Distance>

cvflann::HierarchicalClusteringIndex< Distance >::HierarchicalClusteringIndex ( const HierarchicalClusteringIndex< Distance > & )

template<typename Distance>

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

inlinevirtual

Index destructor.

Release the memory used by the index.

Member Function Documentation

template<typename Distance>

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

inlinevirtual

Builds the index

Implements cvflann::NNIndex< Distance >.

template<typename Distance>

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

inlinevirtual

Find set of nearest neighbors to vec. Their indices are stored inside the result object.

Params: result = the result object in which the indices of the nearest-neighbors are stored vec = the vector for which to search the nearest neighbors searchParams = parameters that influence the search algorithm (checks)

Implements cvflann::NNIndex< Distance >.

template<typename Distance>

void cvflann::HierarchicalClusteringIndex< Distance >::free_elements ( )

inline

Release the inner elements of indices[]

template<typename Distance>

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

inlinevirtual