PointToPoint.h
Go to the documentation of this file.
1 // kate: replace-tabs off; indent-width 4; indent-mode normal
2 // vim: ts=4:sw=4:noexpandtab
3 /*
4 
5 Copyright (c) 2010--2012,
6 François Pomerleau and Stephane Magnenat, ASL, ETHZ, Switzerland
7 You can contact the authors at <f dot pomerleau at gmail dot com> and
8 <stephane at magnenat dot net>
9 
10 All rights reserved.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, are permitted provided that the following conditions are met:
14  * Redistributions of source code must retain the above copyright
15  notice, this list of conditions and the following disclaimer.
16  * Redistributions in binary form must reproduce the above copyright
17  notice, this list of conditions and the following disclaimer in the
18  documentation and/or other materials provided with the distribution.
19  * Neither the name of the <organization> nor the
20  names of its contributors may be used to endorse or promote products
21  derived from this software without specific prior written permission.
22 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
24 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
25 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26 DISCLAIMED. IN NO EVENT SHALL ETH-ASL BE LIABLE FOR ANY
27 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
30 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 
36 #ifndef LIBPOINTMATCHER_POINTTOPOINT_H
37 #define LIBPOINTMATCHER_POINTTOPOINT_H
38 
39 #include "PointMatcher.h"
40 
41 template<typename T>
43 {
47 
53  typedef typename PointMatcher<T>::Vector Vector;
54  typedef typename PointMatcher<T>::Matrix Matrix;
56 
57  inline static const std::string description()
58  {
59  return "Point-to-point error. Based on SVD decomposition. Per \\cite{Besl1992Point2Point}.";
60  }
61 
62 
64  PointToPointErrorMinimizer(const std::string& className, const ParametersDoc paramsDoc, const Parameters& params);
65  virtual TransformationParameters compute(const ErrorElements& mPts);
66  TransformationParameters compute_in_place(ErrorElements& mPts);
67  virtual T getResidualError(const DataPoints& filteredReading, const DataPoints& filteredReference, const OutlierWeights& outlierWeights, const Matches& matches) const;
68  virtual T getOverlap() const;
69 
70  static T computeResidualError(const ErrorElements& mPts);
71 };
72 
73 #endif //LIBPOINTMATCHER_POINTTOPOINT_H
Matrix OutlierWeights
Weights of the associations between the points in Matches and the points in the reference.
Definition: PointMatcher.h:397
public interface
PointMatcher< T >::Matches Matches
Definition: PointToPoint.h:52
A structure holding data ready for minimization. The data are "normalized", for instance there are no...
Definition: PointMatcher.h:533
PointMatcher< T >::OutlierWeights OutlierWeights
Definition: PointToPoint.h:51
TransformationParameters compute_in_place(ErrorElements &mPts)
static const std::string description()
Definition: PointToPoint.h:57
::std::string string
Definition: gtest.h:1979
PointMatcher< T >::ErrorMinimizer::ErrorElements ErrorElements
Definition: PointToPoint.h:49
PointMatcher< T >::ErrorMinimizer ErrorMinimizer
Definition: PointToPoint.h:55
An error minimizer will compute a transformation matrix such as to minimize the error between the rea...
Definition: PointMatcher.h:530
PointMatcherSupport::Parametrizable Parametrizable
Definition: PointToPoint.h:44
Eigen::Matrix< T, Eigen::Dynamic, Eigen::Dynamic > Matrix
A dense matrix over ScalarType.
Definition: PointMatcher.h:169
PointMatcher< T >::Matrix Matrix
Definition: PointToPoint.h:54
PointMatcher< T >::DataPoints DataPoints
Definition: PointToPoint.h:50
std::map< std::string, Parameter > Parameters
Parameters stored as a map of string->string.
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.
Functions and classes that are dependant on scalar type are defined in this templatized class...
Definition: PointMatcher.h:130
Parametrizable::ParametersDoc ParametersDoc
Definition: PointToPoint.h:46
virtual TransformationParameters compute(const ErrorElements &mPts)
Find the transformation that minimizes the error given matched pair of points. This function most be ...
Result of the data-association step (Matcher::findClosests), before outlier rejection.
Definition: PointMatcher.h:371
static T computeResidualError(const ErrorElements &mPts)
The superclass of classes that are constructed using generic parameters. This class provides the para...
std::vector< ParameterDoc > ParametersDoc
The documentation of all parameters.
const std::string className
name of the class
PointMatcher< T >::Vector Vector
Definition: PointToPoint.h:53
Eigen::Matrix< T, Eigen::Dynamic, 1 > Vector
A vector over ScalarType.
Definition: PointMatcher.h:161
PointMatcher< T >::TransformationParameters TransformationParameters
Definition: PointToPoint.h:48
Parametrizable::Parameters Parameters
Definition: PointToPoint.h:45
Matrix TransformationParameters
A matrix holding the parameters a transformation.
Definition: PointMatcher.h:182
virtual T getOverlap() const
If not redefined by child class, return the ratio of how many points were used (with weight) for erro...


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