Public Member Functions | Protected Types | Static Protected Member Functions | Protected Attributes | List of all members
PointMatcher< T >::TransformationChecker Struct Referenceabstract

A transformation checker can stop the iteration depending on some conditions. More...

#include <PointMatcher.h>

Inheritance diagram for PointMatcher< T >::TransformationChecker:
Inheritance graph
[legend]

Public Member Functions

virtual void check (const TransformationParameters &parameters, bool &iterate)=0
 Set iterate to false if iteration should stop. More...
 
const StringVectorgetConditionVariableNames () const
 Return the names of variables involved in conditions to stop ICP loop. More...
 
const VectorgetConditionVariables () const
 Return the values of variables involved in conditions to stop ICP loop. More...
 
const StringVectorgetLimitNames () const
 Return the names of limits involved in conditions to stop ICP loop. More...
 
const VectorgetLimits () const
 Return the value of limits involved in conditions to stop ICP loop. More...
 
virtual void init (const TransformationParameters &parameters, bool &iterate)=0
 Init, set iterate to false if iteration should stop. More...
 
 TransformationChecker ()
 Construct without parameter. More...
 
 TransformationChecker (const std::string &className, const ParametersDoc paramsDoc, const Parameters &params)
 Construct with parameters. More...
 
virtual ~TransformationChecker ()
 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...
 
template<typename T >
std::vector< T > getVector (const std::string &paramName)
 Return the value of paramName, lexically-casted std::vector<S> 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...
 

Protected Types

typedef std::vector< std::string > StringVector
 a vector of strings More...
 

Static Protected Member Functions

static Vector matrixToAngles (const TransformationParameters &parameters)
 Extract the Euler angles from a rigid-transformation matrix. More...
 

Protected Attributes

StringVector conditionVariableNames
 names of variables involved in conditions to stop ICP loop More...
 
Vector conditionVariables
 values of variables involved in conditions to stop ICP loop More...
 
StringVector limitNames
 names of limits involved in conditions to stop ICP loop More...
 
Vector limits
 values of limits involved in conditions to stop ICP loop 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...
 
- 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...
 

Detailed Description

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

A transformation checker can stop the iteration depending on some conditions.

For example, a condition can be the number of times the loop was executed, or it can be related to the matching error. Because the modules can be chained, we defined that the relation between modules must agree through an OR-condition, while all AND-conditions are defined within a single module.

Definition at line 583 of file PointMatcher.h.

Member Typedef Documentation

◆ StringVector

template<typename T >
typedef std::vector<std::string> PointMatcher< T >::TransformationChecker::StringVector
protected

a vector of strings

Definition at line 586 of file PointMatcher.h.

Constructor & Destructor Documentation

◆ TransformationChecker() [1/2]

template<typename T >
PointMatcher< T >::TransformationChecker::TransformationChecker

Construct without parameter.

Definition at line 41 of file TransformationChecker.cpp.

◆ TransformationChecker() [2/2]

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

Construct with parameters.

Definition at line 46 of file TransformationChecker.cpp.

◆ ~TransformationChecker()

template<typename T >
PointMatcher< T >::TransformationChecker::~TransformationChecker
virtual

Destructor.

Definition at line 52 of file TransformationChecker.cpp.

Member Function Documentation

◆ check()

template<typename T >
virtual void PointMatcher< T >::TransformationChecker::check ( const TransformationParameters parameters,
bool &  iterate 
)
pure virtual

◆ getConditionVariableNames()

template<typename T >
const PointMatcher< T >::TransformationChecker::StringVector & PointMatcher< T >::TransformationChecker::getConditionVariableNames

Return the names of variables involved in conditions to stop ICP loop.

Definition at line 78 of file TransformationChecker.cpp.

◆ getConditionVariables()

template<typename T >
const PointMatcher< T >::Vector & PointMatcher< T >::TransformationChecker::getConditionVariables

Return the values of variables involved in conditions to stop ICP loop.

Definition at line 64 of file TransformationChecker.cpp.

◆ getLimitNames()

template<typename T >
const PointMatcher< T >::TransformationChecker::StringVector & PointMatcher< T >::TransformationChecker::getLimitNames

Return the names of limits involved in conditions to stop ICP loop.

Definition at line 71 of file TransformationChecker.cpp.

◆ getLimits()

template<typename T >
const PointMatcher< T >::Vector & PointMatcher< T >::TransformationChecker::getLimits

Return the value of limits involved in conditions to stop ICP loop.

Definition at line 57 of file TransformationChecker.cpp.

◆ init()

template<typename T >
virtual void PointMatcher< T >::TransformationChecker::init ( const TransformationParameters parameters,
bool &  iterate 
)
pure virtual

◆ matrixToAngles()

template<typename T >
PointMatcher< T >::Vector PointMatcher< T >::TransformationChecker::matrixToAngles ( const TransformationParameters parameters)
staticprotected

Extract the Euler angles from a rigid-transformation matrix.

Definition at line 85 of file TransformationChecker.cpp.

Member Data Documentation

◆ conditionVariableNames

template<typename T >
StringVector PointMatcher< T >::TransformationChecker::conditionVariableNames
protected

names of variables involved in conditions to stop ICP loop

Definition at line 590 of file PointMatcher.h.

◆ conditionVariables

template<typename T >
Vector PointMatcher< T >::TransformationChecker::conditionVariables
protected

values of variables involved in conditions to stop ICP loop

Definition at line 588 of file PointMatcher.h.

◆ limitNames

template<typename T >
StringVector PointMatcher< T >::TransformationChecker::limitNames
protected

names of limits involved in conditions to stop ICP loop

Definition at line 589 of file PointMatcher.h.

◆ limits

template<typename T >
Vector PointMatcher< T >::TransformationChecker::limits
protected

values of limits involved in conditions to stop ICP loop

Definition at line 587 of file PointMatcher.h.


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


libpointmatcher
Author(s):
autogenerated on Mon Jan 1 2024 03:24:44