Hierarchical index. More...

#include <opencv2/flann/hierarchical_clustering_index.h>

Inheritance diagram for cvflann::HierarchicalClusteringIndex< Distance >:

Collaboration 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())
	Index constructor. More...

	HierarchicalClusteringIndex (const HierarchicalClusteringIndex &)

virtual	~HierarchicalClusteringIndex ()
	Index destructor. More...

void	buildIndex () CV_OVERRIDE
	Builds the index. More...

void	findNeighbors (ResultSet< DistanceType > &result, const ElementType *vec, const SearchParams &searchParams) CV_OVERRIDE
	Find set of nearest neighbors to vec. More...

void	free_elements ()
	Release the inner elements of indices[]. 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...

HierarchicalClusteringIndex &	operator= (const HierarchicalClusteringIndex &)

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
	Returns size of index. More...

int	usedMemory () const CV_OVERRIDE
	Computes the inde memory usage Returns: memory used by the index. More...

size_t	veclen () const CV_OVERRIDE
	Returns the length of an index feature. More...

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

◆ DistanceType

template<typename Distance>

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

◆ ElementType

template<typename Distance>

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

Constructor & Destructor Documentation

◆ HierarchicalClusteringIndex() [1/2]

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

References cvflann::FLANN_CENTERS_GONZALES, cvflann::FLANN_CENTERS_GROUPWISE, cvflann::FLANN_CENTERS_KMEANSPP, cvflann::FLANN_CENTERS_RANDOM, and cvflann::get_param().

Here is the call graph for this function:

◆ HierarchicalClusteringIndex() [2/2]

template<typename Distance>

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

◆ ~HierarchicalClusteringIndex()

template<typename Distance>

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

inlinevirtual

Index destructor.

Release the memory used by the index.

Member Function Documentation

◆ buildIndex()

template<typename Distance>

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

inlinevirtual

Builds the index.

Implements cvflann::NNIndex< Distance >.

◆ findNeighbors()

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

References cvflann::get_param(), cvflann::BranchStruct< T, DistanceType >::node, and cvflann::Heap< T >::popMin().

Here is the call graph for this function:

◆ free_elements()

template<typename Distance>

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

inline

Release the inner elements of indices[].

◆ getParameters()

template<typename Distance>

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

inlinevirtual

Returns: The index parameters

Implements cvflann::NNIndex< Distance >.

References cvflann::ResultSet< DistanceType >::addPoint(), cvflann::ResultSet< DistanceType >::full(), cvflann::Heap< T >::insert(), cvflann::load_value(), cvflann::save_value(), cv::sort(), and cv::swap().

Here is the call graph for this function:

◆ getType()

template<typename Distance>

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

inlinevirtual

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

Implements cvflann::NNIndex< Distance >.

References cvflann::FLANN_INDEX_HIERARCHICAL.

◆ 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::HierarchicalClusteringIndex< 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 >.

References cvflann::load_value().

Here is the call graph for this function:

◆ operator=()

template<typename Distance>

HierarchicalClusteringIndex& cvflann::HierarchicalClusteringIndex< Distance >::operator= ( const HierarchicalClusteringIndex< 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::HierarchicalClusteringIndex< Distance >::saveIndex ( FILE * stream )

inlinevirtual

Saves the index to a stream.

Parameters

stream The stream to save the index to

Implements cvflann::NNIndex< Distance >.

References cvflann::save_value().

Here is the call graph for this function:

◆ size()

template<typename Distance>

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

inlinevirtual

Returns size of index.

Implements cvflann::NNIndex< Distance >.

◆ usedMemory()

template<typename Distance>

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

inlinevirtual

Computes the inde memory usage Returns: memory used by the index.

Implements cvflann::NNIndex< Distance >.

◆ veclen()

template<typename Distance>

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

inlinevirtual

Returns the length of an index feature.

Implements cvflann::NNIndex< Distance >.

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

opencv2/flann/hierarchical_clustering_index.h

Public Types

Public Member Functions

Detailed Description

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

Member Typedef Documentation

◆ DistanceType

◆ ElementType

Constructor & Destructor Documentation

◆ HierarchicalClusteringIndex() [1/2]

◆ HierarchicalClusteringIndex() [2/2]

◆ ~HierarchicalClusteringIndex()

Member Function Documentation

◆ buildIndex()

◆ findNeighbors()

◆ free_elements()

◆ getParameters()

◆ getType()

◆ knnSearch()

◆ loadIndex()

◆ operator=()

◆ radiusSearch()

◆ saveIndex()

◆ size()

◆ usedMemory()

◆ veclen()

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