Public Member Functions | List of all members
PointMatcher< T >::Transformation Struct Referenceabstract

A function that transforms points and their descriptors given a transformation matrix. More...

#include <PointMatcher.h>

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

Public Member Functions

virtual bool checkParameters (const TransformationParameters &parameters) const =0
 Return whether the given parameters respect the expected constraints. More...
 
virtual DataPoints compute (const DataPoints &input, const TransformationParameters &parameters) const =0
 Transform input using the transformation matrix. More...
 
virtual TransformationParameters correctParameters (const TransformationParameters &parameters) const =0
 Return a valid version of the given transformation. More...
 
virtual void inPlaceCompute (const TransformationParameters &parameters, DataPoints &cloud) const =0
 Transform point cloud in-place using the transformation matrix. More...
 
 Transformation ()
 Construct without parameter. More...
 
 Transformation (const std::string &className, const ParametersDoc paramsDoc, const Parameters &params)
 Construct with parameters. More...
 
virtual ~Transformation ()
 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...
 
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...
 

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 >::Transformation

A function that transforms points and their descriptors given a transformation matrix.

Definition at line 404 of file PointMatcher.h.

Constructor & Destructor Documentation

◆ Transformation() [1/2]

template<typename T >
PointMatcher< T >::Transformation::Transformation

Construct without parameter.

Definition at line 41 of file Transformation.cpp.

◆ Transformation() [2/2]

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

Construct with parameters.

Definition at line 46 of file Transformation.cpp.

◆ ~Transformation()

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

virtual destructor

Definition at line 52 of file Transformation.cpp.

Member Function Documentation

◆ checkParameters()

template<typename T >
virtual bool PointMatcher< T >::Transformation::checkParameters ( const TransformationParameters parameters) const
pure virtual

Return whether the given parameters respect the expected constraints.

◆ compute()

template<typename T >
virtual DataPoints PointMatcher< T >::Transformation::compute ( const DataPoints input,
const TransformationParameters parameters 
) const
pure virtual

Transform input using the transformation matrix.

◆ correctParameters()

template<typename T >
virtual TransformationParameters PointMatcher< T >::Transformation::correctParameters ( const TransformationParameters parameters) const
pure virtual

Return a valid version of the given transformation.

◆ inPlaceCompute()

template<typename T >
virtual void PointMatcher< T >::Transformation::inPlaceCompute ( const TransformationParameters parameters,
DataPoints cloud 
) const
pure virtual

Transform point cloud in-place using the transformation matrix.


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


libpointmatcher
Author(s):
autogenerated on Mon Sep 16 2024 02:24:11