opencv on mbed

Dependencies:   mbed

Embed: (wiki syntax)

« Back to documentation index

RadiusUniqueResultSet< DistanceType > Class Template Reference

RadiusUniqueResultSet< DistanceType > Class Template Reference

Class that holds the radius nearest neighbors It is more accurate than RadiusResult as it is not limited in the number of neighbors. More...

#include <result_set.h>

Inherits cvflann::UniqueResultSet< DistanceType >.

Public Member Functions

 RadiusUniqueResultSet (DistanceType radius)
 Constructor.
void addPoint (DistanceType dist, int index)
 Add a possible candidate to the best neighbors.
void clear ()
 Remove all elements in the set.
bool full () const
 Check the status of the set.
DistanceType worstDist () const
 The distance of the furthest neighbor If we don't have enough neighbors, it returns the max possible value.
virtual void copy (int *indices, DistanceType *dist, int n_neighbors=-1) const
 Copy the set to two C arrays.
virtual void sortAndCopy (int *indices, DistanceType *dist, int n_neighbors=-1) const
 Copy the set to two C arrays but sort it according to the distance first.
size_t size () const
 The number of neighbors in the set.

Protected Attributes

bool is_full_
 Flag to say if the set is full.
DistanceType worst_distance_
 The worst distance found so far.
std::set< DistIndex > dist_indices_
 The best candidates so far.

Detailed Description

template<typename DistanceType>
class cvflann::RadiusUniqueResultSet< DistanceType >

Class that holds the radius nearest neighbors It is more accurate than RadiusResult as it is not limited in the number of neighbors.

Definition at line 448 of file result_set.h.


Constructor & Destructor Documentation

RadiusUniqueResultSet ( DistanceType  radius )

Constructor.

Parameters:
radiusthe maximum distance of a neighbor

Definition at line 454 of file result_set.h.


Member Function Documentation

void addPoint ( DistanceType  dist,
int  index 
)

Add a possible candidate to the best neighbors.

Parameters:
distdistance for that neighbor
indexindex of that neighbor

Definition at line 464 of file result_set.h.

void clear (  ) [virtual]

Remove all elements in the set.

Implements UniqueResultSet< DistanceType >.

Definition at line 471 of file result_set.h.

virtual void copy ( int *  indices,
DistanceType *  dist,
int  n_neighbors = -1 
) const [virtual, inherited]

Copy the set to two C arrays.

Parameters:
indicespointer to a C array of indices
distpointer to a C array of distances
n_neighborsthe number of neighbors to copy

Definition at line 327 of file result_set.h.

bool full (  ) const

Check the status of the set.

Returns:
alwys false

Reimplemented from UniqueResultSet< DistanceType >.

Definition at line 480 of file result_set.h.

size_t size (  ) const [inherited]

The number of neighbors in the set.

Returns:

Definition at line 359 of file result_set.h.

virtual void sortAndCopy ( int *  indices,
DistanceType *  dist,
int  n_neighbors = -1 
) const [virtual, inherited]

Copy the set to two C arrays but sort it according to the distance first.

Parameters:
indicespointer to a C array of indices
distpointer to a C array of distances
n_neighborsthe number of neighbors to copy

Definition at line 351 of file result_set.h.

DistanceType worstDist (  ) const

The distance of the furthest neighbor If we don't have enough neighbors, it returns the max possible value.

Returns:

Reimplemented from UniqueResultSet< DistanceType >.

Definition at line 489 of file result_set.h.


Field Documentation

std::set<DistIndex> dist_indices_ [protected, inherited]

The best candidates so far.

Definition at line 380 of file result_set.h.

bool is_full_ [protected, inherited]

Flag to say if the set is full.

Definition at line 374 of file result_set.h.

DistanceType worst_distance_ [protected, inherited]

The worst distance found so far.

Definition at line 377 of file result_set.h.