An inspector allows to log data at the different steps, for analysis. More...
#include <PointMatcher.h>
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 | dumpIteration (const size_t iterationNumber, const TransformationParameters ¶meters, 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 | dumpStats (std::ostream &stream) |
| Dump all statistics in CSV format. More... | |
| virtual void | dumpStatsHeader (std::ostream &stream) |
| Dump header for all statistics. 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 ¶ms) | |
| Construct with parameters. More... | |
| virtual | ~Inspector () |
| virtual destructor More... | |
 Public Member Functions inherited from PointMatcherSupport::Parametrizable | |
| template<typename S > | |
| S | get (const std::string ¶mName) |
| Return the value of paramName, lexically-casted to S. More... | |
| std::string | getParamValueString (const std::string ¶mName) |
| Get the value of a parameter, as a string. More... | |
| Parametrizable () | |
| Construct a documentation of parameters from a description in the source. More... | |
| Parametrizable (const std::string &className, const ParametersDoc paramsDoc, const Parameters ¶ms) | |
| 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, Parameter > | Parameters |
| Parameters stored as a map of string->string. More... | |
| typedef std::vector< ParameterDoc > | ParametersDoc |
| 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 >::Inspector
An inspector allows to log data at the different steps, for analysis.
Definition at line 621 of file PointMatcher.h.
Constructor & Destructor Documentation
◆ Inspector() [1/2]
| PointMatcher< T >::Inspector::Inspector |
Construct without parameter.
Definition at line 41 of file Inspector.cpp.
◆ Inspector() [2/2]
| PointMatcher< T >::Inspector::Inspector | ( | const std::string & | className, |
| const ParametersDoc | paramsDoc, | ||
| const Parameters & | params | ||
| ) |
Construct with parameters.
Definition at line 46 of file Inspector.cpp.
◆ ~Inspector()
|
virtual |
virtual destructor
Definition at line 52 of file Inspector.cpp.
Member Function Documentation
◆ addStat()
|
virtual |
Add a value for statistics name, create it if new.
Reimplemented in InspectorsImpl< T >::PerformanceInspector.
Definition at line 64 of file Inspector.cpp.
◆ dumpIteration()
|
virtual |
Dump the state of a given iteration.
Reimplemented in InspectorsImpl< T >::AbstractVTKInspector.
Definition at line 81 of file Inspector.cpp.
◆ dumpStats()
|
virtual |
Dump all statistics in CSV format.
Reimplemented in InspectorsImpl< T >::PerformanceInspector.
Definition at line 69 of file Inspector.cpp.
◆ dumpStatsHeader()
|
virtual |
Dump header for all statistics.
Reimplemented in InspectorsImpl< T >::PerformanceInspector.
Definition at line 74 of file Inspector.cpp.
◆ finish()
|
virtual |
Tell the inspector the ICP operation is completed.
Reimplemented in InspectorsImpl< T >::VTKFileInspector, and InspectorsImpl< T >::AbstractVTKInspector.
Definition at line 86 of file Inspector.cpp.
◆ init()
|
virtual |
Start a new ICP operation or sequence.
Reimplemented in InspectorsImpl< T >::VTKFileInspector, and InspectorsImpl< T >::AbstractVTKInspector.
Definition at line 57 of file Inspector.cpp.
The documentation for this struct was generated from the following files: