libpointmatcher  1.3.1
Public Member Functions | Public Attributes | List of all members
PointMatcher< T >::Matcher Struct Referenceabstract

A matcher links points in the reading to points in the reference. More...

#include <PointMatcher.h>

Inheritance diagram for PointMatcher< T >::Matcher:
PointMatcherSupport::Parametrizable

Public Member Functions

 Matcher ()
 Construct without parameter.
 
 Matcher (const std::string &className, const ParametersDoc paramsDoc, const Parameters &params)
 Construct with parameters.
 
virtual ~Matcher ()
 virtual destructor
 
void resetVisitCount ()
 Reset the visit counter.
 
unsigned long getVisitCount () const
 Return the visit counter.
 
virtual void init (const DataPoints &filteredReference)=0
 Init this matcher to find nearest neighbor in filteredReference.
 
virtual Matches findClosests (const DataPoints &filteredReading)=0
 Find the closest neighbors of filteredReading in filteredReference passed to init()
 
- Public Member Functions inherited from PointMatcherSupport::Parametrizable
 Parametrizable ()
 Construct a documentation of parameters from a description in the source. More...
 
 Parametrizable (const std::string &className, const ParametersDoc paramsDoc, const Parameters &params)
 Construct with documented parameters.
 
virtual ~Parametrizable ()
 Virtual destructor, do nothing.
 
std::string getParamValueString (const std::string &paramName)
 Get the value of a parameter, as a string.
 
template<typename S >
get (const std::string &paramName)
 Return the value of paramName, lexically-casted to S.
 

Public Attributes

unsigned long visitCounter
 number of points visited
 
- Public Attributes inherited from PointMatcherSupport::Parametrizable
const std::string className
 name of the class
 
const ParametersDoc parametersDoc
 documentation of parameters
 
Parameters parameters
 parameters with their values encoded in string
 
ParametersUsed parametersUsed
 parameters whose value has actually been read
 

Additional Inherited Members

- Public Types inherited from PointMatcherSupport::Parametrizable
typedef bool(* LexicalComparison) (std::string a, std::string b)
 A function that returns whether a is smaller than b.
 
typedef std::vector< ParameterDocParametersDoc
 The documentation of all parameters.
 
typedef std::string Parameter
 alias
 
typedef std::map< std::string, ParameterParameters
 Parameters stored as a map of string->string.
 
typedef std::set< std::string > ParametersUsed
 Parameters whose value has been read.
 
- Static Public Member Functions inherited from PointMatcherSupport::Parametrizable
template<typename S >
static bool Comp (std::string a, std::string b)
 Return whether a < b, lexically casted to S.
 

Detailed Description

template<typename T>
struct PointMatcher< T >::Matcher

A matcher links points in the reading to points in the reference.

This typically uses a space-partitioning structure such as a kd-tree for performance optimization.


The documentation for this struct was generated from the following files: