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:
Inheritance graph
[legend]

Public Member Functions

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

Public Attributes

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

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. More...
 
typedef std::string Parameter
 alias More...
 
typedef std::map< std::string, ParameterParameters
 Parameters stored as a map of string->string. More...
 
typedef std::vector< ParameterDocParametersDoc
 The documentation of all parameters. More...
 
typedef std::set< std::string > ParametersUsed
 Parameters whose value has been read. More...
 
- 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. More...
 

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.

Definition at line 473 of file PointMatcher.h.

Constructor & Destructor Documentation

◆ Matcher() [1/2]

template<typename T >
PointMatcher< T >::Matcher::Matcher ( )

Construct without parameter.

Definition at line 45 of file pointmatcher/Matcher.cpp.

◆ Matcher() [2/2]

template<typename T >
PointMatcher< T >::Matcher::Matcher ( const std::string &  className,
const ParametersDoc  paramsDoc,
const Parameters params 
)

Construct with parameters.

Definition at line 51 of file pointmatcher/Matcher.cpp.

◆ ~Matcher()

template<typename T >
PointMatcher< T >::Matcher::~Matcher ( )
virtual

virtual destructor

Definition at line 58 of file pointmatcher/Matcher.cpp.

Member Function Documentation

◆ findClosests()

template<typename T>
virtual Matches PointMatcher< T >::Matcher::findClosests ( const DataPoints filteredReading)
pure virtual

Find the closest neighbors of filteredReading in filteredReference passed to init()

Implemented in MatchersImpl< T >::KDTreeVarDistMatcher, MatchersImpl< T >::KDTreeMatcher, and MatchersImpl< T >::NullMatcher.

◆ getVisitCount()

template<typename T >
unsigned long PointMatcher< T >::Matcher::getVisitCount ( ) const

Return the visit counter.

Definition at line 70 of file pointmatcher/Matcher.cpp.

◆ init()

template<typename T>
virtual void PointMatcher< T >::Matcher::init ( const DataPoints filteredReference)
pure virtual

Init this matcher to find nearest neighbor in filteredReference.

Implemented in MatchersImpl< T >::KDTreeVarDistMatcher, MatchersImpl< T >::KDTreeMatcher, and MatchersImpl< T >::NullMatcher.

◆ resetVisitCount()

template<typename T >
void PointMatcher< T >::Matcher::resetVisitCount ( )

Reset the visit counter.

Definition at line 63 of file pointmatcher/Matcher.cpp.

Member Data Documentation

◆ visitCounter

template<typename T>
unsigned long PointMatcher< T >::Matcher::visitCounter

number of points visited

Definition at line 475 of file PointMatcher.h.


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


libpointmatcher
Author(s):
autogenerated on Sat May 27 2023 02:38:04