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

#include <InspectorsImpl.h>

Inheritance diagram for InspectorsImpl< T >::PerformanceInspector:
Inheritance graph
[legend]

Public Member Functions

virtual void addStat (const std::string &name, double data)
 Add a value for statistics name, create it if new. More...
 
virtual void dumpStats (std::ostream &stream)
 Dump all statistics in CSV format. More...
 
virtual void dumpStatsHeader (std::ostream &stream)
 Dump header for all statistics. More...
 
 PerformanceInspector (const Parameters &params)
 
 PerformanceInspector (const std::string &className, const ParametersDoc paramsDoc, const Parameters &params)
 
- Public Member Functions inherited from PointMatcher< T >::Inspector
virtual void dumpIteration (const size_t iterationNumber, const TransformationParameters &parameters, const DataPoints &filteredReference, const DataPoints &reading, const Matches &matches, const OutlierWeights &outlierWeights, const TransformationCheckers &transformationCheckers)
 Dump the state of a given iteration. More...
 
virtual void finish (const size_t iterationCount)
 Tell the inspector the ICP operation is completed. More...
 
virtual void init ()
 Start a new ICP operation or sequence. More...
 
 Inspector ()
 Construct without parameter. More...
 
 Inspector (const std::string &className, const ParametersDoc paramsDoc, const Parameters &params)
 Construct with parameters. More...
 
virtual ~Inspector ()
 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...
 

Public Attributes

const std::string baseFileName
 
const bool bDumpPerfOnExit
 
const bool bDumpStats
 
- 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...
 

Protected Types

typedef PointMatcherSupport::Histogram< double > Histogram
 
typedef std::map< std::string, HistogramHistogramMap
 

Protected Attributes

HistogramMap stats
 

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...
 

Detailed Description

template<typename T>
struct InspectorsImpl< T >::PerformanceInspector

Definition at line 72 of file InspectorsImpl.h.

Member Typedef Documentation

◆ Histogram

template<typename T >
typedef PointMatcherSupport::Histogram<double> InspectorsImpl< T >::PerformanceInspector::Histogram
protected

Definition at line 94 of file InspectorsImpl.h.

◆ HistogramMap

template<typename T >
typedef std::map<std::string, Histogram> InspectorsImpl< T >::PerformanceInspector::HistogramMap
protected

Definition at line 95 of file InspectorsImpl.h.

Constructor & Destructor Documentation

◆ PerformanceInspector() [1/2]

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

Definition at line 52 of file InspectorsImpl.cpp.

◆ PerformanceInspector() [2/2]

template<typename T >
InspectorsImpl< T >::PerformanceInspector::PerformanceInspector ( const Parameters params)

Definition at line 62 of file InspectorsImpl.cpp.

Member Function Documentation

◆ addStat()

template<typename T >
void InspectorsImpl< T >::PerformanceInspector::addStat ( const std::string &  name,
double  data 
)
virtual

Add a value for statistics name, create it if new.

Reimplemented from PointMatcher< T >::Inspector.

Definition at line 70 of file InspectorsImpl.cpp.

◆ availableParameters()

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

Definition at line 78 of file InspectorsImpl.h.

◆ description()

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

Definition at line 74 of file InspectorsImpl.h.

◆ dumpStats()

template<typename T >
void InspectorsImpl< T >::PerformanceInspector::dumpStats ( std::ostream &  stream)
virtual

Dump all statistics in CSV format.

Reimplemented from PointMatcher< T >::Inspector.

Definition at line 83 of file InspectorsImpl.cpp.

◆ dumpStatsHeader()

template<typename T >
void InspectorsImpl< T >::PerformanceInspector::dumpStatsHeader ( std::ostream &  stream)
virtual

Dump header for all statistics.

Reimplemented from PointMatcher< T >::Inspector.

Definition at line 97 of file InspectorsImpl.cpp.

Member Data Documentation

◆ baseFileName

template<typename T >
const std::string InspectorsImpl< T >::PerformanceInspector::baseFileName

Definition at line 87 of file InspectorsImpl.h.

◆ bDumpPerfOnExit

template<typename T >
const bool InspectorsImpl< T >::PerformanceInspector::bDumpPerfOnExit

Definition at line 90 of file InspectorsImpl.h.

◆ bDumpStats

template<typename T >
const bool InspectorsImpl< T >::PerformanceInspector::bDumpStats

Definition at line 91 of file InspectorsImpl.h.

◆ stats

template<typename T >
HistogramMap InspectorsImpl< T >::PerformanceInspector::stats
protected

Definition at line 96 of file InspectorsImpl.h.


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


libpointmatcher
Author(s):
autogenerated on Mon Jul 1 2024 02:22:43