Joe Verbout / Mbed 2 deprecated main

opencv on mbed

Dependencies:   mbed

Embed: (wiki syntax)

« Back to documentation index

LshIndex< Distance > Class Template Reference
Public Member Functions

LshIndex< Distance > Class Template Reference

Randomized kd-tree index. More...

#include <lsh_index.h>

Inherits cvflann::NNIndex< Distance >.

Public Member Functions

 LshIndex (const Matrix< ElementType > &input_data, const IndexParams &params=LshIndexParams(), Distance d=Distance())
 Constructor.
void buildIndex ()
 Builds the index.
flann_algorithm_t getType () const
void saveIndex (FILE *stream)
 Saves the index to a stream.
void loadIndex (FILE *stream)
 Loads the index from a stream.
size_t size () const
 Returns size of index.
size_t veclen () const
 Returns the length of an index feature.
int usedMemory () const
 Computes the index memory usage Returns: memory used by the index.
IndexParams getParameters () const
virtual void knnSearch (const Matrix< ElementType > &queries, Matrix< int > &indices, Matrix< DistanceType > &dists, int knn, const SearchParams &params)
 Perform k-nearest neighbor search.
void findNeighbors (ResultSet< DistanceType > &result, const ElementType *vec, const SearchParams &)
 Find set of nearest neighbors to vec.
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.
virtual void findNeighbors (ResultSet< DistanceType > &result, const ElementType *vec, const SearchParams &searchParams)=0
 Method that searches for nearest-neighbours.

Detailed Description

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

Randomized kd-tree index.

Contains the k-d trees and other information for indexing a set of points for nearest-neighbor matching.

Definition at line 78 of file lsh_index.h.

Constructor & Destructor Documentation

LshIndex ( const Matrix< ElementType > &  input_data,
const IndexParams &  params = LshIndexParams(),
Distance  d = Distance() 
)

Constructor.

Parameters:
input_datadataset with the input features
paramsparameters passed to the LSH algorithm
dthe distance used

Definition at line 89 of file lsh_index.h.

Member Function Documentation

void buildIndex (  ) [virtual]

Builds the index.

Implements NNIndex< Distance >.

Definition at line 110 of file lsh_index.h.

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

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 maxCheck = the maximum number of restarts (in a best-bin-first manner)

Definition at line 220 of file lsh_index.h.

virtual void findNeighbors ( ResultSet< DistanceType > &  result,
const ElementType *  vec,
const SearchParams &  searchParams 
) [pure virtual, inherited]

Method that searches for nearest-neighbours.

IndexParams getParameters (  ) const [virtual]
Returns:
The index parameters

Implements NNIndex< Distance >.

Definition at line 177 of file lsh_index.h.

flann_algorithm_t getType (  ) const [virtual]
Returns:
The index type (kdtree, kmeans,...)

Implements NNIndex< Distance >.

Definition at line 122 of file lsh_index.h.

virtual void knnSearch ( const Matrix< ElementType > &  queries,
Matrix< int > &  indices,
Matrix< DistanceType > &  dists,
int  knn,
const SearchParams &  params 
) [virtual]

Perform k-nearest neighbor search.

Parameters:
[in]queriesThe query points for which to find the nearest neighbors
[out]indicesThe indices of the nearest neighbors found
[out]distsDistances to the nearest neighbors found
[in]knnNumber of nearest neighbors to return
[in]paramsSearch parameters

Definition at line 190 of file lsh_index.h.

virtual void knnSearch ( const Matrix< ElementType > &  queries,
Matrix< int > &  indices,
Matrix< DistanceType > &  dists,
int  knn,
const SearchParams &  params 
) [virtual, inherited]

Perform k-nearest neighbor search.

Parameters:
[in]queriesThe query points for which to find the nearest neighbors
[out]indicesThe indices of the nearest neighbors found
[out]distsDistances to the nearest neighbors found
[in]knnNumber of nearest neighbors to return
[in]paramsSearch parameters

Definition at line 68 of file nn_index.h.

void loadIndex ( FILE *  stream ) [virtual]

Loads the index from a stream.

Parameters:
streamThe stream from which the index is loaded

Implements NNIndex< Distance >.

Definition at line 136 of file lsh_index.h.

virtual int radiusSearch ( const Matrix< ElementType > &  query,
Matrix< int > &  indices,
Matrix< DistanceType > &  dists,
float  radius,
const SearchParams &  params 
) [virtual, inherited]

Perform radius search.

Parameters:
[in]queryThe query point
[out]indicesThe indinces of the neighbors found within the given radius
[out]distsThe distances to the nearest neighbors found
[in]radiusThe radius used for search
[in]paramsSearch parameters
Returns:
Number of neighbors found

Definition at line 102 of file nn_index.h.

void saveIndex ( FILE *  stream ) [virtual]

Saves the index to a stream.

Parameters:
streamThe stream to save the index to

Implements NNIndex< Distance >.

Definition at line 128 of file lsh_index.h.

size_t size (  ) const [virtual]

Returns size of index.

Implements NNIndex< Distance >.

Definition at line 154 of file lsh_index.h.

int usedMemory (  ) const [virtual]

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

Implements NNIndex< Distance >.

Definition at line 171 of file lsh_index.h.

size_t veclen (  ) const [virtual]

Returns the length of an index feature.

Implements NNIndex< Distance >.

Definition at line 162 of file lsh_index.h.

Generated on Tue Jul 12 2022 16:42:45 by  doxygen 1.7.2