#include <flann.hpp>

Public Types
typedef Distance::ResultType	DistanceType

typedef Distance::ElementType	ElementType

typedef NNIndex< Distance >	IndexType

Public Member Functions
void	addPoints (const Matrix< ElementType > &points, float rebuild_threshold=2)

void	buildIndex ()

void	buildIndex (const Matrix< ElementType > &points)

IndexParams	getParameters () const

ElementType *	getPoint (size_t point_id)

flann_algorithm_t	getType () const

	Index (const Index &other)

	Index (const IndexParams &params, Distance distance=Distance())

	Index (const Matrix< ElementType > &features, const IndexParams &params, Distance distance=Distance())

int	knnSearch (const Matrix< ElementType > &queries, Matrix< int > &indices, Matrix< DistanceType > &dists, size_t knn, const SearchParams &params) const

int	knnSearch (const Matrix< ElementType > &queries, Matrix< size_t > &indices, Matrix< DistanceType > &dists, size_t knn, const SearchParams &params) const
	Perform k-nearest neighbor search. More...

int	knnSearch (const Matrix< ElementType > &queries, std::vector< std::vector< int > > &indices, std::vector< std::vector< DistanceType > > &dists, size_t knn, const SearchParams &params) const

int	knnSearch (const Matrix< ElementType > &queries, std::vector< std::vector< size_t > > &indices, std::vector< std::vector< DistanceType > > &dists, size_t knn, const SearchParams &params) const
	Perform k-nearest neighbor search. More...

Index &	operator= (Index other)

int	radiusSearch (const Matrix< ElementType > &queries, Matrix< int > &indices, Matrix< DistanceType > &dists, float radius, const SearchParams &params) const

int	radiusSearch (const Matrix< ElementType > &queries, Matrix< size_t > &indices, Matrix< DistanceType > &dists, float radius, const SearchParams &params) const
	Perform radius search. More...

int	radiusSearch (const Matrix< ElementType > &queries, std::vector< std::vector< int > > &indices, std::vector< std::vector< DistanceType > > &dists, float radius, const SearchParams &params) const

int	radiusSearch (const Matrix< ElementType > &queries, std::vector< std::vector< size_t > > &indices, std::vector< std::vector< DistanceType > > &dists, float radius, const SearchParams &params) const
	Perform radius search. More...

size_t	removedCount () const

void	removePoint (size_t point_id)

void	save (std::string filename)

size_t	size () const

size_t	sizeAtBuild () const

int	usedMemory () const

size_t	veclen () const

virtual	~Index ()

Private Member Functions
IndexType *	load_saved_index (const Matrix< ElementType > &dataset, const std::string &filename, Distance distance)

void	swap (Index &other)

Private Attributes
IndexParams	index_params_

bool	loaded_

IndexType *	nnIndex_

Detailed Description

template<typename Distance>
class rtflann::Index< Distance >

Definition at line 104 of file flann.hpp.

Member Typedef Documentation

◆ DistanceType

template<typename Distance >

typedef Distance::ResultType rtflann::Index< Distance >::DistanceType

Definition at line 108 of file flann.hpp.

◆ ElementType

template<typename Distance >

typedef Distance::ElementType rtflann::Index< Distance >::ElementType

Definition at line 107 of file flann.hpp.

◆ IndexType

template<typename Distance >

typedef NNIndex<Distance> rtflann::Index< Distance >::IndexType

Definition at line 109 of file flann.hpp.

Constructor & Destructor Documentation

◆ Index() [1/3]

template<typename Distance >

rtflann::Index< Distance >::Index	(	const IndexParams &	params,
		Distance	distance = `Distance()`
	)

inline

Definition at line 111 of file flann.hpp.

◆ Index() [2/3]

template<typename Distance >

rtflann::Index< Distance >::Index	(	const Matrix< ElementType > &	features,
		const IndexParams &	params,
		Distance	distance = `Distance()`
	)

inline

Definition at line 129 of file flann.hpp.

◆ Index() [3/3]

template<typename Distance >

rtflann::Index< Distance >::Index ( const Index< Distance > & other )

inline

Definition at line 146 of file flann.hpp.

◆ ~Index()

template<typename Distance >

virtual rtflann::Index< Distance >::~Index ( )

inlinevirtual

Definition at line 157 of file flann.hpp.

Member Function Documentation

◆ addPoints()

template<typename Distance >

void rtflann::Index< Distance >::addPoints	(	const Matrix< ElementType > &	points,
		float	rebuild_threshold = `2`
	)

inline

Definition at line 177 of file flann.hpp.

◆ buildIndex() [1/2]

template<typename Distance >

void rtflann::Index< Distance >::buildIndex ( )

inline

Builds the index.

Definition at line 165 of file flann.hpp.

◆ buildIndex() [2/2]

template<typename Distance >

void rtflann::Index< Distance >::buildIndex ( const Matrix< ElementType > & points )

inline

Definition at line 172 of file flann.hpp.

◆ getParameters()

template<typename Distance >

IndexParams rtflann::Index< Distance >::getParameters ( ) const

inline

Returns: The index parameters

Definition at line 261 of file flann.hpp.

◆ getPoint()

template<typename Distance >

ElementType* rtflann::Index< Distance >::getPoint ( size_t point_id )

inline

Returns pointer to a data point with the specified id.

Parameters

point_id the id of point to retrieve

Returns

Definition at line 196 of file flann.hpp.

◆ getType()

template<typename Distance >

flann_algorithm_t rtflann::Index< Distance >::getType ( ) const

inline

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

Definition at line 244 of file flann.hpp.

◆ knnSearch() [1/4]

template<typename Distance >

int rtflann::Index< Distance >::knnSearch	(	const Matrix< ElementType > &	queries,
		Matrix< int > &	indices,
		Matrix< DistanceType > &	dists,
		size_t	knn,
		const SearchParams &	params
	)		const

inline

Parameters

queries
indices
dists
knn
params

Returns

Definition at line 292 of file flann.hpp.

◆ knnSearch() [2/4]

template<typename Distance >

int rtflann::Index< Distance >::knnSearch	(	const Matrix< ElementType > &	queries,
		Matrix< size_t > &	indices,
		Matrix< DistanceType > &	dists,
		size_t	knn,
		const SearchParams &	params
	)		const

inline

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

Definition at line 274 of file flann.hpp.

◆ knnSearch() [3/4]

template<typename Distance >

int rtflann::Index< Distance >::knnSearch	(	const Matrix< ElementType > &	queries,
		std::vector< std::vector< int > > &	indices,
		std::vector< std::vector< DistanceType > > &	dists,
		size_t	knn,
		const SearchParams &	params
	)		const

inline

Parameters

queries
indices
dists
knn
params

Returns

Definition at line 327 of file flann.hpp.

◆ knnSearch() [4/4]

template<typename Distance >

int rtflann::Index< Distance >::knnSearch	(	const Matrix< ElementType > &	queries,
		std::vector< std::vector< size_t > > &	indices,
		std::vector< std::vector< DistanceType > > &	dists,
		size_t	knn,
		const SearchParams &	params
	)		const

inline

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

Definition at line 309 of file flann.hpp.

◆ load_saved_index()

template<typename Distance >

IndexType* rtflann::Index< Distance >::load_saved_index	(	const Matrix< ElementType > &	dataset,
		const std::string &	filename,
		Distance	distance
	)

inlineprivate

Definition at line 409 of file flann.hpp.

◆ operator=()

template<typename Distance >

Index& rtflann::Index< Distance >::operator= ( Index< Distance > other )

inline

Definition at line 151 of file flann.hpp.

◆ radiusSearch() [1/4]

template<typename Distance >

int rtflann::Index< Distance >::radiusSearch	(	const Matrix< ElementType > &	queries,
		Matrix< int > &	indices,
		Matrix< DistanceType > &	dists,
		float	radius,
		const SearchParams &	params
	)		const

inline

Parameters

queries
indices
dists
radius
params

Returns

Definition at line 363 of file flann.hpp.

◆ radiusSearch() [2/4]

template<typename Distance >

int rtflann::Index< Distance >::radiusSearch	(	const Matrix< ElementType > &	queries,
		Matrix< size_t > &	indices,
		Matrix< DistanceType > &	dists,
		float	radius,
		const SearchParams &	params
	)		const

inline

Perform radius search.

Parameters

[in]	queries	The query points
[out]	indices	The indices 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

Definition at line 345 of file flann.hpp.

◆ radiusSearch() [3/4]

template<typename Distance >

int rtflann::Index< Distance >::radiusSearch	(	const Matrix< ElementType > &	queries,
		std::vector< std::vector< int > > &	indices,
		std::vector< std::vector< DistanceType > > &	dists,
		float	radius,
		const SearchParams &	params
	)		const

inline

Parameters

queries
indices
dists
radius
params

Returns

Definition at line 399 of file flann.hpp.

◆ radiusSearch() [4/4]

template<typename Distance >

int rtflann::Index< Distance >::radiusSearch	(	const Matrix< ElementType > &	queries,
		std::vector< std::vector< size_t > > &	indices,
		std::vector< std::vector< DistanceType > > &	dists,
		float	radius,
		const SearchParams &	params
	)		const

inline

Perform radius search.

Parameters

[in]	queries	The query points
[out]	indices	The indices 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

Definition at line 381 of file flann.hpp.

◆ removedCount()

template<typename Distance >

size_t rtflann::Index< Distance >::removedCount ( ) const

inline

Definition at line 231 of file flann.hpp.

◆ removePoint()

template<typename Distance >

void rtflann::Index< Distance >::removePoint ( size_t point_id )

inline

Remove point from the index

Parameters

index Index of point to be removed

Definition at line 186 of file flann.hpp.

◆ save()

template<typename Distance >

void rtflann::Index< Distance >::save ( std::string filename )

inline

Save index to file

Parameters

filename

Definition at line 205 of file flann.hpp.

◆ size()

template<typename Distance >

size_t rtflann::Index< Distance >::size ( ) const

inline

Returns: The dimensionality of the features in this index.

Definition at line 226 of file flann.hpp.

◆ sizeAtBuild()

template<typename Distance >

size_t rtflann::Index< Distance >::sizeAtBuild ( ) const

inline

Definition at line 236 of file flann.hpp.

◆ swap()

template<typename Distance >

void rtflann::Index< Distance >::swap ( Index< Distance > & other )

inlineprivate

Definition at line 430 of file flann.hpp.

◆ usedMemory()

template<typename Distance >

int rtflann::Index< Distance >::usedMemory ( ) const

inline

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

Definition at line 252 of file flann.hpp.

◆ veclen()

template<typename Distance >

size_t rtflann::Index< Distance >::veclen ( ) const

inline

Returns: number of features in this index.

Definition at line 218 of file flann.hpp.

Member Data Documentation

◆ index_params_

template<typename Distance >

IndexParams rtflann::Index< Distance >::index_params_

private

Parameters passed to the index

Definition at line 443 of file flann.hpp.

◆ loaded_

template<typename Distance >

bool rtflann::Index< Distance >::loaded_

private

Indices if the index was loaded from a file

Definition at line 441 of file flann.hpp.

◆ nnIndex_

template<typename Distance >

IndexType* rtflann::Index< Distance >::nnIndex_

private

Pointer to actual index class

Definition at line 439 of file flann.hpp.

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

flann.hpp

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

template<typename Distance> class rtflann::Index< Distance >

Member Typedef Documentation

◆ DistanceType

◆ ElementType

◆ IndexType

Constructor & Destructor Documentation

◆ Index() [1/3]

◆ Index() [2/3]

◆ Index() [3/3]

◆ ~Index()

Member Function Documentation

◆ addPoints()

◆ buildIndex() [1/2]

◆ buildIndex() [2/2]

◆ getParameters()

◆ getPoint()

◆ getType()

◆ knnSearch() [1/4]

◆ knnSearch() [2/4]

◆ knnSearch() [3/4]

◆ knnSearch() [4/4]

◆ load_saved_index()

◆ operator=()

◆ radiusSearch() [1/4]

◆ radiusSearch() [2/4]

◆ radiusSearch() [3/4]

◆ radiusSearch() [4/4]

◆ removedCount()

◆ removePoint()

◆ save()

◆ size()

◆ sizeAtBuild()

◆ swap()

◆ usedMemory()

◆ veclen()

Member Data Documentation

◆ index_params_

◆ loaded_

◆ nnIndex_

template<typename Distance>
class rtflann::Index< Distance >