Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
OutlierFiltersImpl< T >::RobustOutlierFilter Struct Reference

#include <OutlierFiltersImpl.h>

Inheritance diagram for OutlierFiltersImpl< T >::RobustOutlierFilter:
Inheritance graph
[legend]

Public Member Functions

virtual OutlierWeights compute (const DataPoints &filteredReading, const DataPoints &filteredReference, const Matches &input)
 Detect outliers using features. More...
 
Matrix computePointToPlaneDistance (const DataPoints &filteredReading, const DataPoints &filteredReference, const Matches &input)
 
 RobustOutlierFilter (const Parameters &params=Parameters())
 
 RobustOutlierFilter (const std::string &className, const ParametersDoc paramsDoc, const Parameters &params)
 
- Public Member Functions inherited from PointMatcher< T >::OutlierFilter
 OutlierFilter ()
 Construct without parameter. More...
 
 OutlierFilter (const std::string &className, const ParametersDoc paramsDoc, const Parameters &params)
 Construct with parameters. More...
 
virtual ~OutlierFilter ()
 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 PointMatcherSupport::Parametrizable
template<typename S >
static bool Comp (std::string a, std::string b)
 Return whether a < b, lexically casted to S. More...
 

Protected Types

enum  RobustFctId {
  Cauchy =0, Welsch =1, SwitchableConstraint =2, GM =3,
  Tukey =4, Huber =5, L1 =6, Student =7
}
 
typedef std::map< std::string, RobustFctIdRobustFctMap
 

Protected Member Functions

virtual void resolveEstimatorName ()
 
virtual OutlierWeights robustFiltering (const DataPoints &filteredReading, const DataPoints &filteredReference, const Matches &input)
 

Protected Attributes

berg_target_scale
 
const std::string distanceType
 
int iteration
 
const int nbIterationForScale
 
int robustFctId
 
const std::string robustFctName
 
scale
 
const std::string scaleEstimator
 
const T squaredApproximation
 
tuning
 

Static Protected Attributes

static RobustFctMap robustFcts
 

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...
 
- 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 OutlierFiltersImpl< T >::RobustOutlierFilter

Definition at line 223 of file OutlierFiltersImpl.h.

Member Typedef Documentation

◆ RobustFctMap

template<typename T >
typedef std::map<std::string, RobustFctId> OutlierFiltersImpl< T >::RobustOutlierFilter::RobustFctMap
protected

Definition at line 262 of file OutlierFiltersImpl.h.

Member Enumeration Documentation

◆ RobustFctId

template<typename T >
enum OutlierFiltersImpl::RobustOutlierFilter::RobustFctId
protected
Enumerator
Cauchy 
Welsch 
SwitchableConstraint 
GM 
Tukey 
Huber 
L1 
Student 

Definition at line 252 of file OutlierFiltersImpl.h.

Constructor & Destructor Documentation

◆ RobustOutlierFilter() [1/2]

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

Definition at line 402 of file OutlierFiltersImpl.cpp.

◆ RobustOutlierFilter() [2/2]

template<typename T >
OutlierFiltersImpl< T >::RobustOutlierFilter::RobustOutlierFilter ( const Parameters params = Parameters())

Definition at line 446 of file OutlierFiltersImpl.cpp.

Member Function Documentation

◆ availableParameters()

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

Definition at line 230 of file OutlierFiltersImpl.h.

◆ compute()

template<typename T >
PointMatcher< T >::OutlierWeights OutlierFiltersImpl< T >::RobustOutlierFilter::compute ( const DataPoints filteredReading,
const DataPoints filteredReference,
const Matches input 
)
virtual

Detect outliers using features.

Implements PointMatcher< T >::OutlierFilter.

Definition at line 462 of file OutlierFiltersImpl.cpp.

◆ computePointToPlaneDistance()

template<typename T >
PointMatcher< T >::Matrix OutlierFiltersImpl< T >::RobustOutlierFilter::computePointToPlaneDistance ( const DataPoints filteredReading,
const DataPoints filteredReference,
const Matches input 
)

Definition at line 474 of file OutlierFiltersImpl.cpp.

◆ description()

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

Definition at line 226 of file OutlierFiltersImpl.h.

◆ resolveEstimatorName()

template<typename T >
void OutlierFiltersImpl< T >::RobustOutlierFilter::resolveEstimatorName
protectedvirtual

Definition at line 453 of file OutlierFiltersImpl.cpp.

◆ robustFiltering()

template<typename T >
PointMatcher< T >::OutlierWeights OutlierFiltersImpl< T >::RobustOutlierFilter::robustFiltering ( const DataPoints filteredReading,
const DataPoints filteredReference,
const Matches input 
)
protectedvirtual

Definition at line 510 of file OutlierFiltersImpl.cpp.

Member Data Documentation

◆ berg_target_scale

template<typename T >
T OutlierFiltersImpl< T >::RobustOutlierFilter::berg_target_scale
protected

Definition at line 273 of file OutlierFiltersImpl.h.

◆ distanceType

template<typename T >
const std::string OutlierFiltersImpl< T >::RobustOutlierFilter::distanceType
protected

Definition at line 269 of file OutlierFiltersImpl.h.

◆ iteration

template<typename T >
int OutlierFiltersImpl< T >::RobustOutlierFilter::iteration
protected

Definition at line 271 of file OutlierFiltersImpl.h.

◆ nbIterationForScale

template<typename T >
const int OutlierFiltersImpl< T >::RobustOutlierFilter::nbIterationForScale
protected

Definition at line 268 of file OutlierFiltersImpl.h.

◆ robustFctId

template<typename T >
int OutlierFiltersImpl< T >::RobustOutlierFilter::robustFctId
protected

Definition at line 270 of file OutlierFiltersImpl.h.

◆ robustFctName

template<typename T >
const std::string OutlierFiltersImpl< T >::RobustOutlierFilter::robustFctName
protected

Definition at line 264 of file OutlierFiltersImpl.h.

◆ robustFcts

template<typename T >
OutlierFiltersImpl< T >::RobustOutlierFilter::RobustFctMap OutlierFiltersImpl< T >::RobustOutlierFilter::robustFcts
staticprotected
Initial value:
= {
{"cauchy", RobustFctId::Cauchy},
{"welsch", RobustFctId::Welsch},
{"sc", RobustFctId::SwitchableConstraint},
{"gm", RobustFctId::GM},
{"tukey", RobustFctId::Tukey},
{"huber", RobustFctId::Huber},
{"L1", RobustFctId::L1},
{"student", RobustFctId::Student}
}

Definition at line 263 of file OutlierFiltersImpl.h.

◆ scale

template<typename T >
T OutlierFiltersImpl< T >::RobustOutlierFilter::scale
protected

Definition at line 272 of file OutlierFiltersImpl.h.

◆ scaleEstimator

template<typename T >
const std::string OutlierFiltersImpl< T >::RobustOutlierFilter::scaleEstimator
protected

Definition at line 267 of file OutlierFiltersImpl.h.

◆ squaredApproximation

template<typename T >
const T OutlierFiltersImpl< T >::RobustOutlierFilter::squaredApproximation
protected

Definition at line 266 of file OutlierFiltersImpl.h.

◆ tuning

template<typename T >
T OutlierFiltersImpl< T >::RobustOutlierFilter::tuning
protected

Definition at line 265 of file OutlierFiltersImpl.h.


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


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