Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Private Member Functions | List of all members
OctreeGridDataPointsFilter< T > Class Template Reference

Data Filter based on Octree representation. More...

#include <OctreeGrid.h>

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

Classes

struct  CentroidSampler
 
struct  FirstPtsSampler
 
struct  MedoidSampler
 
struct  RandomPtsSampler
 

Public Types

typedef PM::DataPoints DataPoints
 
typedef PM::DataPointsFilter DataPointsFilter
 
typedef DataPoints::Index Index
 
typedef PointMatcher< T >::DataPoints::InvalidField InvalidField
 
typedef Parametrizable::InvalidParameter InvalidParameter
 
typedef PointMatcherSupport::Parametrizable P
 
typedef Parametrizable::ParameterDoc ParameterDoc
 
typedef Parametrizable::Parameters Parameters
 
typedef Parametrizable::ParametersDoc ParametersDoc
 
typedef PointMatcherSupport::Parametrizable Parametrizable
 
typedef PointMatcher< T > PM
 
enum  SamplingMethod : int { FIRST_PTS =0, RAND_PTS =1, CENTROID =2, MEDOID =3 }
 
- 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...
 
 OctreeGridDataPointsFilter (const Parameters &params=Parameters())
 
 OctreeGridDataPointsFilter ()
 
virtual ~OctreeGridDataPointsFilter ()
 
- 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

bool buildParallel
 
std::size_t maxPointByNode
 
maxSizeByNode
 
SamplingMethod samplingMethod
 
- 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...
 

Private Member Functions

template<std::size_t dim>
void sample (DataPoints &cloud)
 

Detailed Description

template<typename T>
class OctreeGridDataPointsFilter< T >

Data Filter based on Octree representation.

Author
Mathieu Labussiere (<mathieu dot="" labu="" at="" gmail="" dot="" com>="">)
Date
24/05/2018
Version
0.1

Processings are applyed via a Visitor through Depth-first search in the Octree (DFS) i.e. for each node, the Visitor/Callback is called

Definition at line 54 of file OctreeGrid.h.

Member Typedef Documentation

◆ DataPoints

template<typename T >
typedef PM::DataPoints OctreeGridDataPointsFilter< T >::DataPoints

Definition at line 58 of file OctreeGrid.h.

◆ DataPointsFilter

Definition at line 59 of file OctreeGrid.h.

◆ Index

template<typename T >
typedef DataPoints::Index OctreeGridDataPointsFilter< T >::Index

Definition at line 68 of file OctreeGrid.h.

◆ InvalidField

Definition at line 70 of file OctreeGrid.h.

◆ InvalidParameter

Definition at line 66 of file OctreeGrid.h.

◆ P

Definition at line 62 of file OctreeGrid.h.

◆ ParameterDoc

Definition at line 64 of file OctreeGrid.h.

◆ Parameters

Definition at line 63 of file OctreeGrid.h.

◆ ParametersDoc

Definition at line 65 of file OctreeGrid.h.

◆ Parametrizable

Definition at line 61 of file OctreeGrid.h.

◆ PM

template<typename T >
typedef PointMatcher<T> OctreeGridDataPointsFilter< T >::PM

Definition at line 57 of file OctreeGrid.h.

Member Enumeration Documentation

◆ SamplingMethod

template<typename T >
enum OctreeGridDataPointsFilter::SamplingMethod : int
Enumerator
FIRST_PTS 
RAND_PTS 
CENTROID 
MEDOID 

Definition at line 153 of file OctreeGrid.h.

Constructor & Destructor Documentation

◆ OctreeGridDataPointsFilter() [1/2]

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

Definition at line 286 of file OctreeGrid.cpp.

◆ OctreeGridDataPointsFilter() [2/2]

template<typename T >
OctreeGridDataPointsFilter< T >::OctreeGridDataPointsFilter ( )

◆ ~OctreeGridDataPointsFilter()

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

Definition at line 169 of file OctreeGrid.h.

Member Function Documentation

◆ availableParameters()

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

Definition at line 77 of file OctreeGrid.h.

◆ description()

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

Definition at line 72 of file OctreeGrid.h.

◆ filter()

template<typename T >
PointMatcher< T >::DataPoints OctreeGridDataPointsFilter< 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 306 of file OctreeGrid.cpp.

◆ inPlaceFilter()

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

Apply these filters to a point cloud without copying.

Implements PointMatcher< T >::DataPointsFilter.

Definition at line 314 of file OctreeGrid.cpp.

◆ sample()

template<typename T >
template<std::size_t dim>
void OctreeGridDataPointsFilter< T >::sample ( DataPoints cloud)
private

Definition at line 329 of file OctreeGrid.cpp.

Member Data Documentation

◆ buildParallel

template<typename T >
bool OctreeGridDataPointsFilter< T >::buildParallel

Definition at line 156 of file OctreeGrid.h.

◆ maxPointByNode

template<typename T >
std::size_t OctreeGridDataPointsFilter< T >::maxPointByNode

Definition at line 158 of file OctreeGrid.h.

◆ maxSizeByNode

template<typename T >
T OctreeGridDataPointsFilter< T >::maxSizeByNode

Definition at line 159 of file OctreeGrid.h.

◆ samplingMethod

template<typename T >
SamplingMethod OctreeGridDataPointsFilter< T >::samplingMethod

Definition at line 161 of file OctreeGrid.h.


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


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