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

Subsampling. Filter points beyond a maximum quantile measured on a specific axis. More...

#include <MaxQuantileOnAxis.h>

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

Public Types

typedef PointMatcher< T >::DataPoints DataPoints
 
typedef Parametrizable::InvalidParameter InvalidParameter
 
typedef PointMatcherSupport::Parametrizable P
 
typedef Parametrizable::ParameterDoc ParameterDoc
 
typedef Parametrizable::Parameters Parameters
 
typedef Parametrizable::ParametersDoc ParametersDoc
 
typedef PointMatcherSupport::Parametrizable Parametrizable
 
- 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...
 
 MaxQuantileOnAxisDataPointsFilter (const Parameters &params=Parameters())
 Constructor, uses parameter interface. More...
 
- 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...
 
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 unsigned dim
 
const T ratio
 
const bool removeBeyond
 
- 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 MaxQuantileOnAxisDataPointsFilter< T >

Subsampling. Filter points beyond a maximum quantile measured on a specific axis.

Definition at line 41 of file MaxQuantileOnAxis.h.

Member Typedef Documentation

◆ DataPoints

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

Definition at line 50 of file MaxQuantileOnAxis.h.

◆ InvalidParameter

Definition at line 48 of file MaxQuantileOnAxis.h.

◆ P

Definition at line 44 of file MaxQuantileOnAxis.h.

◆ ParameterDoc

Definition at line 46 of file MaxQuantileOnAxis.h.

◆ Parameters

Definition at line 45 of file MaxQuantileOnAxis.h.

◆ ParametersDoc

Definition at line 47 of file MaxQuantileOnAxis.h.

◆ Parametrizable

Definition at line 43 of file MaxQuantileOnAxis.h.

Constructor & Destructor Documentation

◆ MaxQuantileOnAxisDataPointsFilter()

Constructor, uses parameter interface.

Definition at line 43 of file MaxQuantileOnAxis.cpp.

Member Function Documentation

◆ availableParameters()

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

Definition at line 56 of file MaxQuantileOnAxis.h.

◆ description()

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

Definition at line 52 of file MaxQuantileOnAxis.h.

◆ filter()

template<typename T >
PointMatcher< T >::DataPoints MaxQuantileOnAxisDataPointsFilter< 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 56 of file MaxQuantileOnAxis.cpp.

◆ inPlaceFilter()

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

Apply these filters to a point cloud without copying.

Implements PointMatcher< T >::DataPointsFilter.

Definition at line 66 of file MaxQuantileOnAxis.cpp.

Member Data Documentation

◆ dim

template<typename T >
const unsigned MaxQuantileOnAxisDataPointsFilter< T >::dim

Definition at line 65 of file MaxQuantileOnAxis.h.

◆ ratio

template<typename T >
const T MaxQuantileOnAxisDataPointsFilter< T >::ratio

Definition at line 66 of file MaxQuantileOnAxis.h.

◆ removeBeyond

template<typename T >
const bool MaxQuantileOnAxisDataPointsFilter< T >::removeBeyond

Definition at line 67 of file MaxQuantileOnAxis.h.


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


libpointmatcher
Author(s):
autogenerated on Mon Sep 16 2024 02:24:11