Point Cloud Library (PCL)  1.9.1-dev
List of all members | Public Member Functions
pcl::FeatureHandler< FeatureType, DataSet, ExampleIndex > Class Template Referenceabstract

Utility class interface which is used for creating and evaluating features. More...

#include <pcl/ml/feature_handler.h>

Public Member Functions

virtual ~FeatureHandler ()
 Destructor. More...
 
virtual void createRandomFeatures (const std::size_t num_of_features, std::vector< FeatureType > &features)=0
 Creates random features. More...
 
virtual void evaluateFeature (const FeatureType &feature, DataSet &data_set, std::vector< ExampleIndex > &examples, std::vector< float > &results, std::vector< unsigned char > &flags) const =0
 Evaluates a feature on the specified data. More...
 
virtual void evaluateFeature (const FeatureType &feature, DataSet &data_set, const ExampleIndex &example, float &result, unsigned char &flag) const =0
 Evaluates a feature on the specified data. More...
 
virtual void generateCodeForEvaluation (const FeatureType &feature, ::std::ostream &stream) const =0
 Generates evaluation code for the specified feature and writes it to the specified stream. More...
 

Detailed Description

template<class FeatureType, class DataSet, class ExampleIndex>
class pcl::FeatureHandler< FeatureType, DataSet, ExampleIndex >

Utility class interface which is used for creating and evaluating features.

Definition at line 49 of file feature_handler.h.

Constructor & Destructor Documentation

◆ ~FeatureHandler()

template<class FeatureType, class DataSet, class ExampleIndex>
virtual pcl::FeatureHandler< FeatureType, DataSet, ExampleIndex >::~FeatureHandler ( )
inlinevirtual

Destructor.

Definition at line 52 of file feature_handler.h.

Member Function Documentation

◆ createRandomFeatures()

template<class FeatureType, class DataSet, class ExampleIndex>
virtual void pcl::FeatureHandler< FeatureType, DataSet, ExampleIndex >::createRandomFeatures ( const std::size_t  num_of_features,
std::vector< FeatureType > &  features 
)
pure virtual

Creates random features.

Parameters
[in]num_of_featuresthe number of random features to create
[out]featuresthe destination for the created features

Implemented in pcl::face_detection::FeatureHandlerDepthAverage< FT, DataSet, ExampleIndex >.

◆ evaluateFeature() [1/2]

template<class FeatureType, class DataSet, class ExampleIndex>
virtual void pcl::FeatureHandler< FeatureType, DataSet, ExampleIndex >::evaluateFeature ( const FeatureType &  feature,
DataSet &  data_set,
std::vector< ExampleIndex > &  examples,
std::vector< float > &  results,
std::vector< unsigned char > &  flags 
) const
pure virtual

◆ evaluateFeature() [2/2]

template<class FeatureType, class DataSet, class ExampleIndex>
virtual void pcl::FeatureHandler< FeatureType, DataSet, ExampleIndex >::evaluateFeature ( const FeatureType &  feature,
DataSet &  data_set,
const ExampleIndex &  example,
float &  result,
unsigned char &  flag 
) const
pure virtual

Evaluates a feature on the specified data.

Parameters
[in]featurethe features to evaluate
[in]data_setthe data set on which the feature is evaluated
[in]examplethe examples which specify on which parts of the data set the feature is evaluated
[out]resultthe destination for the results of the feature evaluation
[out]flagflags that are supplied together with the results

Implemented in pcl::ScaledMultiChannel2DComparisonFeatureHandler< DATA_TYPE, NUM_OF_CHANNELS, SCALE_CHANNEL, INVERT_SCALE >, pcl::face_detection::FeatureHandlerDepthAverage< FT, DataSet, ExampleIndex >, and pcl::MultiChannel2DComparisonFeatureHandler< DATA_TYPE, NUM_OF_CHANNELS >.

◆ generateCodeForEvaluation()

template<class FeatureType, class DataSet, class ExampleIndex>
virtual void pcl::FeatureHandler< FeatureType, DataSet, ExampleIndex >::generateCodeForEvaluation ( const FeatureType &  feature,
::std::ostream &  stream 
) const
pure virtual

Generates evaluation code for the specified feature and writes it to the specified stream.

Parameters
[in]featurethe feature for which code is generated
[out]streamthe destination for the code

Implemented in pcl::face_detection::FeatureHandlerDepthAverage< FT, DataSet, ExampleIndex >.


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