Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
InspectorsImpl< T >::AbstractVTKInspector Struct Referenceabstract

#include <InspectorsImpl.h>

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

Public Member Functions

 AbstractVTKInspector (const std::string &className, const ParametersDoc paramsDoc, const Parameters &params)
 
virtual void dumpDataPoints (const DataPoints &cloud, const std::string &name)
 
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 dumpMeshNodes (const DataPoints &cloud, const std::string &name)
 
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...
 
- Public Member Functions inherited from InspectorsImpl< T >::PerformanceInspector
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 std::string &className, const ParametersDoc paramsDoc, const Parameters &params)
 
 PerformanceInspector (const Parameters &params)
 
- Public Member Functions inherited from PointMatcher< T >::Inspector
 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 >
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...
 
 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...
 

Protected Member Functions

virtual void closeStream (std::ostream *stream)=0
 
void dumpDataLinks (const DataPoints &ref, const DataPoints &reading, const Matches &matches, const OutlierWeights &featureOutlierWeights, std::ostream &stream)
 
void dumpDataPoints (const DataPoints &data, std::ostream &stream)
 
void dumpMeshNodes (const DataPoints &data, std::ostream &stream)
 
virtual std::ostream * openStream (const std::string &role)=0
 
virtual std::ostream * openStream (const std::string &role, const size_t iterationNumber)=0
 

Protected Attributes

const bool bDumpDataLinks
 
const bool bDumpIterationInfo
 
const bool bDumpReading
 
const bool bDumpReference
 
const bool bWriteBinary
 
std::ostream * streamIter
 
- Protected Attributes inherited from InspectorsImpl< T >::PerformanceInspector
HistogramMap stats
 

Private Member Functions

void buildColorStream (std::ostream &stream, const std::string &name, const DataPoints &cloud)
 
void buildGenericAttributeStream (std::ostream &stream, const std::string &attribute, const std::string &nameTag, const DataPoints &cloud, const int forcedDim)
 
void buildNormalStream (std::ostream &stream, const std::string &name, const DataPoints &ref, const DataPoints &reading)
 
void buildNormalStream (std::ostream &stream, const std::string &name, const DataPoints &cloud)
 
void buildScalarStream (std::ostream &stream, const std::string &name, const DataPoints &ref, const DataPoints &reading)
 
void buildScalarStream (std::ostream &stream, const std::string &name, const DataPoints &cloud)
 
void buildTensorStream (std::ostream &stream, const std::string &name, const DataPoints &ref, const DataPoints &reading)
 
void buildTensorStream (std::ostream &stream, const std::string &name, const DataPoints &cloud)
 
void buildTimeStream (std::ostream &stream, const std::string &name, const DataPoints &cloud)
 
void buildVectorStream (std::ostream &stream, const std::string &name, const DataPoints &ref, const DataPoints &reading)
 
void buildVectorStream (std::ostream &stream, const std::string &name, const DataPoints &cloud)
 
Matrix padWithOnes (const Matrix m, const int expectedRow, const int expectedCols)
 
Matrix padWithZeros (const Matrix m, const int expectedRow, const int expectedCols)
 

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 InspectorsImpl< T >::PerformanceInspector
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 inherited from InspectorsImpl< T >::PerformanceInspector
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 inherited from InspectorsImpl< T >::PerformanceInspector
typedef PointMatcherSupport::Histogram< double > Histogram
 
typedef std::map< std::string, Histogram > HistogramMap
 

Detailed Description

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

Definition at line 107 of file InspectorsImpl.h.

Constructor & Destructor Documentation

◆ AbstractVTKInspector()

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

Definition at line 138 of file InspectorsImpl.cpp.

Member Function Documentation

◆ buildColorStream()

template<typename T >
void InspectorsImpl< T >::AbstractVTKInspector::buildColorStream ( std::ostream &  stream,
const std::string &  name,
const DataPoints &  cloud 
)
private

Definition at line 524 of file InspectorsImpl.cpp.

◆ buildGenericAttributeStream()

template<typename T >
void InspectorsImpl< T >::AbstractVTKInspector::buildGenericAttributeStream ( std::ostream &  stream,
const std::string &  attribute,
const std::string &  nameTag,
const DataPoints &  cloud,
const int  forcedDim 
)
private

Definition at line 453 of file InspectorsImpl.cpp.

◆ buildNormalStream() [1/2]

template<typename T >
void InspectorsImpl< T >::AbstractVTKInspector::buildNormalStream ( std::ostream &  stream,
const std::string &  name,
const DataPoints &  ref,
const DataPoints &  reading 
)
private

Definition at line 557 of file InspectorsImpl.cpp.

◆ buildNormalStream() [2/2]

template<typename T >
void InspectorsImpl< T >::AbstractVTKInspector::buildNormalStream ( std::ostream &  stream,
const std::string &  name,
const DataPoints &  cloud 
)
private

Definition at line 500 of file InspectorsImpl.cpp.

◆ buildScalarStream() [1/2]

template<typename T >
void InspectorsImpl< T >::AbstractVTKInspector::buildScalarStream ( std::ostream &  stream,
const std::string &  name,
const DataPoints &  ref,
const DataPoints &  reading 
)
private

Definition at line 532 of file InspectorsImpl.cpp.

◆ buildScalarStream() [2/2]

template<typename T >
void InspectorsImpl< T >::AbstractVTKInspector::buildScalarStream ( std::ostream &  stream,
const std::string &  name,
const DataPoints &  cloud 
)
private

Definition at line 492 of file InspectorsImpl.cpp.

◆ buildTensorStream() [1/2]

template<typename T >
void InspectorsImpl< T >::AbstractVTKInspector::buildTensorStream ( std::ostream &  stream,
const std::string &  name,
const DataPoints &  ref,
const DataPoints &  reading 
)
private

Definition at line 605 of file InspectorsImpl.cpp.

◆ buildTensorStream() [2/2]

template<typename T >
void InspectorsImpl< T >::AbstractVTKInspector::buildTensorStream ( std::ostream &  stream,
const std::string &  name,
const DataPoints &  cloud 
)
private

Definition at line 516 of file InspectorsImpl.cpp.

◆ buildTimeStream()

template<typename T >
void InspectorsImpl< T >::AbstractVTKInspector::buildTimeStream ( std::ostream &  stream,
const std::string &  name,
const DataPoints &  cloud 
)
private

Definition at line 628 of file InspectorsImpl.cpp.

◆ buildVectorStream() [1/2]

template<typename T >
void InspectorsImpl< T >::AbstractVTKInspector::buildVectorStream ( std::ostream &  stream,
const std::string &  name,
const DataPoints &  ref,
const DataPoints &  reading 
)
private

Definition at line 581 of file InspectorsImpl.cpp.

◆ buildVectorStream() [2/2]

template<typename T >
void InspectorsImpl< T >::AbstractVTKInspector::buildVectorStream ( std::ostream &  stream,
const std::string &  name,
const DataPoints &  cloud 
)
private

Definition at line 508 of file InspectorsImpl.cpp.

◆ closeStream()

template<typename T >
virtual void InspectorsImpl< T >::AbstractVTKInspector::closeStream ( std::ostream *  stream)
protectedpure virtual

Implemented in InspectorsImpl< T >::VTKFileInspector.

◆ dumpDataLinks()

template<typename T >
void InspectorsImpl< T >::AbstractVTKInspector::dumpDataLinks ( const DataPoints &  ref,
const DataPoints &  reading,
const Matches &  matches,
const OutlierWeights &  featureOutlierWeights,
std::ostream &  stream 
)
protected

Definition at line 286 of file InspectorsImpl.cpp.

◆ dumpDataPoints() [1/2]

template<typename T >
void InspectorsImpl< T >::AbstractVTKInspector::dumpDataPoints ( const DataPoints &  data,
std::ostream &  stream 
)
protected

Definition at line 159 of file InspectorsImpl.cpp.

◆ dumpDataPoints() [2/2]

template<typename T >
void InspectorsImpl< T >::AbstractVTKInspector::dumpDataPoints ( const DataPoints &  cloud,
const std::string &  name 
)
virtual

Definition at line 369 of file InspectorsImpl.cpp.

◆ dumpIteration()

template<typename T >
void InspectorsImpl< T >::AbstractVTKInspector::dumpIteration ( const size_t  iterationNumber,
const TransformationParameters &  parameters,
const DataPoints &  filteredReference,
const DataPoints &  reading,
const Matches &  matches,
const OutlierWeights &  outlierWeights,
const TransformationCheckers &  transformationCheckers 
)
virtual

Dump the state of a given iteration.

Reimplemented from PointMatcher< T >::Inspector.

Definition at line 385 of file InspectorsImpl.cpp.

◆ dumpMeshNodes() [1/2]

template<typename T >
void InspectorsImpl< T >::AbstractVTKInspector::dumpMeshNodes ( const DataPoints &  data,
std::ostream &  stream 
)
protected

Definition at line 238 of file InspectorsImpl.cpp.

◆ dumpMeshNodes() [2/2]

template<typename T >
void InspectorsImpl< T >::AbstractVTKInspector::dumpMeshNodes ( const DataPoints &  cloud,
const std::string &  name 
)
virtual

Definition at line 377 of file InspectorsImpl.cpp.

◆ finish()

template<typename T >
void InspectorsImpl< T >::AbstractVTKInspector::finish ( const size_t  iterationCount)
virtual

Tell the inspector the ICP operation is completed.

Reimplemented from PointMatcher< T >::Inspector.

Reimplemented in InspectorsImpl< T >::VTKFileInspector.

Definition at line 706 of file InspectorsImpl.cpp.

◆ init()

template<typename T >
virtual void InspectorsImpl< T >::AbstractVTKInspector::init ( )
inlinevirtual

Start a new ICP operation or sequence.

Reimplemented from PointMatcher< T >::Inspector.

Reimplemented in InspectorsImpl< T >::VTKFileInspector.

Definition at line 127 of file InspectorsImpl.h.

◆ openStream() [1/2]

template<typename T >
virtual std::ostream* InspectorsImpl< T >::AbstractVTKInspector::openStream ( const std::string &  role)
protectedpure virtual

Implemented in InspectorsImpl< T >::VTKFileInspector.

◆ openStream() [2/2]

template<typename T >
virtual std::ostream* InspectorsImpl< T >::AbstractVTKInspector::openStream ( const std::string &  role,
const size_t  iterationNumber 
)
protectedpure virtual

Implemented in InspectorsImpl< T >::VTKFileInspector.

◆ padWithOnes()

template<typename T >
PointMatcher< T >::Matrix InspectorsImpl< T >::AbstractVTKInspector::padWithOnes ( const Matrix  m,
const int  expectedRow,
const int  expectedCols 
)
private

Definition at line 686 of file InspectorsImpl.cpp.

◆ padWithZeros()

template<typename T >
PointMatcher< T >::Matrix InspectorsImpl< T >::AbstractVTKInspector::padWithZeros ( const Matrix  m,
const int  expectedRow,
const int  expectedCols 
)
private

Definition at line 666 of file InspectorsImpl.cpp.

Member Data Documentation

◆ bDumpDataLinks

template<typename T >
const bool InspectorsImpl< T >::AbstractVTKInspector::bDumpDataLinks
protected

Definition at line 120 of file InspectorsImpl.h.

◆ bDumpIterationInfo

template<typename T >
const bool InspectorsImpl< T >::AbstractVTKInspector::bDumpIterationInfo
protected

Definition at line 119 of file InspectorsImpl.h.

◆ bDumpReading

template<typename T >
const bool InspectorsImpl< T >::AbstractVTKInspector::bDumpReading
protected

Definition at line 121 of file InspectorsImpl.h.

◆ bDumpReference

template<typename T >
const bool InspectorsImpl< T >::AbstractVTKInspector::bDumpReference
protected

Definition at line 122 of file InspectorsImpl.h.

◆ bWriteBinary

template<typename T >
const bool InspectorsImpl< T >::AbstractVTKInspector::bWriteBinary
protected

Definition at line 123 of file InspectorsImpl.h.

◆ streamIter

template<typename T >
std::ostream* InspectorsImpl< T >::AbstractVTKInspector::streamIter
protected

Definition at line 118 of file InspectorsImpl.h.

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

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