Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
PointToPointWithCovErrorMinimizer< T > Struct Template Reference

#include <PointToPointWithCov.h>

Inheritance diagram for PointToPointWithCovErrorMinimizer< T >:
Inheritance graph
[legend]

Public Types

typedef PointMatcher< T >::DataPoints DataPoints
 
typedef PointMatcher< T >::ErrorMinimizer::ErrorElements ErrorElements
 
typedef PointMatcher< T >::ErrorMinimizer ErrorMinimizer
 
typedef PointMatcher< T >::Matches Matches
 
typedef PointMatcher< T >::Matrix Matrix
 
typedef PointMatcher< T >::OutlierWeights OutlierWeights
 
typedef PointMatcherSupport::Parametrizable P
 
typedef Parametrizable::Parameters Parameters
 
typedef Parametrizable::ParametersDoc ParametersDoc
 
typedef PointMatcherSupport::Parametrizable Parametrizable
 
typedef PointMatcher< T >::TransformationParameters TransformationParameters
 
typedef PointMatcher< T >::Vector Vector
 
- Public Types inherited from PointToPointErrorMinimizer< T >
typedef PointMatcher< T >::DataPoints DataPoints
 
typedef PointMatcher< T >::ErrorMinimizer::ErrorElements ErrorElements
 
typedef PointMatcher< T >::ErrorMinimizer ErrorMinimizer
 
typedef PointMatcher< T >::Matches Matches
 
typedef PointMatcher< T >::Matrix Matrix
 
typedef PointMatcher< T >::OutlierWeights OutlierWeights
 
typedef Parametrizable::Parameters Parameters
 
typedef Parametrizable::ParametersDoc ParametersDoc
 
typedef PointMatcherSupport::Parametrizable Parametrizable
 
typedef PointMatcher< T >::TransformationParameters TransformationParameters
 
typedef PointMatcher< T >::Vector Vector
 
- 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...
 

Public Member Functions

virtual TransformationParameters compute (const ErrorElements &mPts)
 Find the transformation that minimizes the error given matched pair of points. This function most be defined for all new instances of ErrorMinimizer. More...
 
Matrix estimateCovariance (const ErrorElements &mPts, const TransformationParameters &transformation)
 
virtual Matrix getCovariance () const
 If not redefined by child class, return zero matrix. More...
 
 PointToPointWithCovErrorMinimizer (const Parameters &params=Parameters())
 
- Public Member Functions inherited from PointToPointErrorMinimizer< T >
TransformationParameters compute_in_place (ErrorElements &mPts)
 
virtual T getOverlap () const
 If not redefined by child class, return the ratio of how many points were used (with weight) for error minimization. More...
 
virtual T getResidualError (const DataPoints &filteredReading, const DataPoints &filteredReference, const OutlierWeights &outlierWeights, const Matches &matches) const
 If not redefined by child class, return max value for T. More...
 
 PointToPointErrorMinimizer ()
 
 PointToPointErrorMinimizer (const std::string &className, const ParametersDoc paramsDoc, const Parameters &params)
 
- Public Member Functions inherited from PointMatcher< T >::ErrorMinimizer
virtual TransformationParameters compute (const DataPoints &filteredReading, const DataPoints &filteredReference, const OutlierWeights &outlierWeights, const Matches &matches)
 Find the transformation that minimizes the error. More...
 
 ErrorMinimizer ()
 Construct without parameter. More...
 
 ErrorMinimizer (const std::string &className, const ParametersDoc paramsDoc, const Parameters &params)
 Construct with parameters. More...
 
ErrorElements getErrorElements () const
 Return the last the ErrorElements structure that was used for error minimization. More...
 
getPointUsedRatio () const
 Return the ratio of how many points were used for error minimization. More...
 
getWeightedPointUsedRatio () const
 Return the ratio of how many points were used (with weight) for error minimization. More...
 
virtual ~ErrorMinimizer ()
 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...
 

Static Public Member Functions

static const ParametersDoc availableParameters ()
 
static const std::string description ()
 
- Static Public Member Functions inherited from PointToPointErrorMinimizer< T >
static T computeResidualError (const ErrorElements &mPts)
 
static const std::string description ()
 
- Static Public Member Functions inherited from PointMatcher< T >::ErrorMinimizer
static Matrix crossProduct (const Matrix &A, const Matrix &B)
 Helper funtion doing the cross product in 3D and a pseudo cross product in 2D. 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

Matrix covMatrix
 
const T sensorStdDev
 
- 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

- Protected Attributes inherited from PointMatcher< T >::ErrorMinimizer
ErrorElements lastErrorElements
 memory of the last computed error More...
 

Detailed Description

template<typename T>
struct PointToPointWithCovErrorMinimizer< T >

Definition at line 43 of file PointToPointWithCov.h.

Member Typedef Documentation

◆ DataPoints

template<typename T >
typedef PointMatcher<T>::DataPoints PointToPointWithCovErrorMinimizer< T >::DataPoints

Definition at line 53 of file PointToPointWithCov.h.

◆ ErrorElements

Definition at line 52 of file PointToPointWithCov.h.

◆ ErrorMinimizer

Definition at line 56 of file PointToPointWithCov.h.

◆ Matches

template<typename T >
typedef PointMatcher<T>::Matches PointToPointWithCovErrorMinimizer< T >::Matches

Definition at line 55 of file PointToPointWithCov.h.

◆ Matrix

template<typename T >
typedef PointMatcher<T>::Matrix PointToPointWithCovErrorMinimizer< T >::Matrix

Definition at line 50 of file PointToPointWithCov.h.

◆ OutlierWeights

Definition at line 54 of file PointToPointWithCov.h.

◆ P

Definition at line 46 of file PointToPointWithCov.h.

◆ Parameters

Definition at line 47 of file PointToPointWithCov.h.

◆ ParametersDoc

Definition at line 48 of file PointToPointWithCov.h.

◆ Parametrizable

Definition at line 45 of file PointToPointWithCov.h.

◆ TransformationParameters

Definition at line 51 of file PointToPointWithCov.h.

◆ Vector

template<typename T >
typedef PointMatcher<T>::Vector PointToPointWithCovErrorMinimizer< T >::Vector

Definition at line 57 of file PointToPointWithCov.h.

Constructor & Destructor Documentation

◆ PointToPointWithCovErrorMinimizer()

Definition at line 43 of file PointToPointWithCov.cpp.

Member Function Documentation

◆ availableParameters()

template<typename T >
static const ParametersDoc PointToPointWithCovErrorMinimizer< T >::availableParameters ( )
inlinestatic

Definition at line 64 of file PointToPointWithCov.h.

◆ compute()

template<typename T >
PointMatcher< T >::TransformationParameters PointToPointWithCovErrorMinimizer< T >::compute ( const ErrorElements matchedPoints)
virtual

Find the transformation that minimizes the error given matched pair of points. This function most be defined for all new instances of ErrorMinimizer.

Reimplemented from PointToPointErrorMinimizer< T >.

Definition at line 50 of file PointToPointWithCov.cpp.

◆ description()

template<typename T >
static const std::string PointToPointWithCovErrorMinimizer< T >::description ( )
inlinestatic

Definition at line 59 of file PointToPointWithCov.h.

◆ estimateCovariance()

template<typename T >
PointToPointWithCovErrorMinimizer< T >::Matrix PointToPointWithCovErrorMinimizer< T >::estimateCovariance ( const ErrorElements mPts,
const TransformationParameters transformation 
)

Definition at line 62 of file PointToPointWithCov.cpp.

◆ getCovariance()

template<typename T >
PointToPointWithCovErrorMinimizer< T >::Matrix PointToPointWithCovErrorMinimizer< T >::getCovariance
virtual

If not redefined by child class, return zero matrix.

Reimplemented from PointMatcher< T >::ErrorMinimizer.

Definition at line 148 of file PointToPointWithCov.cpp.

Member Data Documentation

◆ covMatrix

template<typename T >
Matrix PointToPointWithCovErrorMinimizer< T >::covMatrix

Definition at line 72 of file PointToPointWithCov.h.

◆ sensorStdDev

template<typename T >
const T PointToPointWithCovErrorMinimizer< T >::sensorStdDev

Definition at line 71 of file PointToPointWithCov.h.


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


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