Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
SurfaceNormalDataPointsFilter< T > Struct Template Reference

Surface normals estimation. Find the normal for every point using eigen-decomposition of neighbour points. More...

#include <SurfaceNormal.h>

Inheritance diagram for SurfaceNormalDataPointsFilter< T >:
Inheritance graph
[legend]

Public Types

typedef PointMatcher< T >::DataPoints DataPoints
 
typedef PointMatcher< T >::DataPoints::InvalidField InvalidField
 
typedef Parametrizable::InvalidParameter InvalidParameter
 
typedef PointMatcher< T >::Matrix Matrix
 
typedef PointMatcherSupport::Parametrizable P
 
typedef Parametrizable::ParameterDoc ParameterDoc
 
typedef Parametrizable::Parameters Parameters
 
typedef Parametrizable::ParametersDoc ParametersDoc
 
typedef PointMatcherSupport::Parametrizable Parametrizable
 
typedef PointMatcher< T >::Vector Vector
 
- 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 Member Functions

virtual DataPoints filter (const DataPoints &input)
 Apply filters to input point cloud. This is the non-destructive version and returns a copy. More...
 
virtual void inPlaceFilter (DataPoints &cloud)
 Apply these filters to a point cloud without copying. More...
 
 SurfaceNormalDataPointsFilter (const Parameters &params=Parameters())
 
virtual ~SurfaceNormalDataPointsFilter ()
 
- Public Member Functions inherited from PointMatcher< T >::DataPointsFilter
 DataPointsFilter ()
 Construct without parameter. More...
 
 DataPointsFilter (const std::string &className, const ParametersDoc paramsDoc, const Parameters &params)
 Construct with parameters. More...
 
virtual void init ()
 Init this filter. More...
 
virtual ~DataPointsFilter ()
 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...
 
 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 T epsilon
 
const bool keepDensities
 
const bool keepEigenValues
 
const bool keepEigenVectors
 
const bool keepMatchedIds
 
const bool keepMeanDist
 
const bool keepNormals
 
const unsigned knn
 
const T maxDist
 
const bool smoothNormals
 
const bool sortEigen
 
- 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 SurfaceNormalDataPointsFilter< T >

Surface normals estimation. Find the normal for every point using eigen-decomposition of neighbour points.

Definition at line 43 of file SurfaceNormal.h.

Member Typedef Documentation

◆ DataPoints

template<typename T >
typedef PointMatcher<T>::DataPoints SurfaceNormalDataPointsFilter< T >::DataPoints

Definition at line 54 of file SurfaceNormal.h.

◆ InvalidField

Definition at line 55 of file SurfaceNormal.h.

◆ InvalidParameter

Definition at line 50 of file SurfaceNormal.h.

◆ Matrix

template<typename T >
typedef PointMatcher<T>::Matrix SurfaceNormalDataPointsFilter< T >::Matrix

Definition at line 53 of file SurfaceNormal.h.

◆ P

Definition at line 46 of file SurfaceNormal.h.

◆ ParameterDoc

Definition at line 48 of file SurfaceNormal.h.

◆ Parameters

Definition at line 47 of file SurfaceNormal.h.

◆ ParametersDoc

Definition at line 49 of file SurfaceNormal.h.

◆ Parametrizable

Definition at line 45 of file SurfaceNormal.h.

◆ Vector

template<typename T >
typedef PointMatcher<T>::Vector SurfaceNormalDataPointsFilter< T >::Vector

Definition at line 52 of file SurfaceNormal.h.

Constructor & Destructor Documentation

◆ SurfaceNormalDataPointsFilter()

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

Definition at line 52 of file SurfaceNormal.cpp.

◆ ~SurfaceNormalDataPointsFilter()

template<typename T >
virtual SurfaceNormalDataPointsFilter< T >::~SurfaceNormalDataPointsFilter ( )
inlinevirtual

Definition at line 95 of file SurfaceNormal.h.

Member Function Documentation

◆ availableParameters()

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

Definition at line 65 of file SurfaceNormal.h.

◆ description()

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

Definition at line 57 of file SurfaceNormal.h.

◆ filter()

template<typename T >
PointMatcher< T >::DataPoints SurfaceNormalDataPointsFilter< T >::filter ( const DataPoints input)
virtual

Apply filters to input point cloud. This is the non-destructive version and returns a copy.

Implements PointMatcher< T >::DataPointsFilter.

Definition at line 72 of file SurfaceNormal.cpp.

◆ inPlaceFilter()

template<typename T >
void SurfaceNormalDataPointsFilter< T >::inPlaceFilter ( DataPoints cloud)
virtual

Apply these filters to a point cloud without copying.

Implements PointMatcher< T >::DataPointsFilter.

Definition at line 82 of file SurfaceNormal.cpp.

Member Data Documentation

◆ epsilon

template<typename T >
const T SurfaceNormalDataPointsFilter< T >::epsilon

Definition at line 84 of file SurfaceNormal.h.

◆ keepDensities

template<typename T >
const bool SurfaceNormalDataPointsFilter< T >::keepDensities

Definition at line 86 of file SurfaceNormal.h.

◆ keepEigenValues

template<typename T >
const bool SurfaceNormalDataPointsFilter< T >::keepEigenValues

Definition at line 87 of file SurfaceNormal.h.

◆ keepEigenVectors

template<typename T >
const bool SurfaceNormalDataPointsFilter< T >::keepEigenVectors

Definition at line 88 of file SurfaceNormal.h.

◆ keepMatchedIds

template<typename T >
const bool SurfaceNormalDataPointsFilter< T >::keepMatchedIds

Definition at line 89 of file SurfaceNormal.h.

◆ keepMeanDist

template<typename T >
const bool SurfaceNormalDataPointsFilter< T >::keepMeanDist

Definition at line 90 of file SurfaceNormal.h.

◆ keepNormals

template<typename T >
const bool SurfaceNormalDataPointsFilter< T >::keepNormals

Definition at line 85 of file SurfaceNormal.h.

◆ knn

template<typename T >
const unsigned SurfaceNormalDataPointsFilter< T >::knn

Definition at line 82 of file SurfaceNormal.h.

◆ maxDist

template<typename T >
const T SurfaceNormalDataPointsFilter< T >::maxDist

Definition at line 83 of file SurfaceNormal.h.

◆ smoothNormals

template<typename T >
const bool SurfaceNormalDataPointsFilter< T >::smoothNormals

Definition at line 92 of file SurfaceNormal.h.

◆ sortEigen

template<typename T >
const bool SurfaceNormalDataPointsFilter< T >::sortEigen

Definition at line 91 of file SurfaceNormal.h.


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


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