Point Cloud Library (PCL)  1.9.1-dev
List of all members | Public Member Functions
pcl::Fern< FeatureType, NodeType > Class Template Reference

Class representing a Fern. More...

#include <pcl/ml/ferns/fern.h>

Public Member Functions

 Fern ()
 Constructor. More...
 
virtual ~Fern ()
 Destructor. More...
 
void initialize (const std::size_t num_of_decisions)
 Initializes the fern. More...
 
std::size_t getNumOfNodes ()
 Returns the number of nodes the Fern has. More...
 
std::size_t getNumOfFeatures ()
 Returns the number of features the Fern has. More...
 
void serialize (::std::ostream &stream) const
 Serializes the fern. More...
 
void deserialize (::std::istream &stream)
 Deserializes the fern. More...
 
NodeType & operator[] (const std::size_t node_index)
 Access operator for nodes. More...
 
const NodeType & operator[] (const std::size_t node_index) const
 Access operator for nodes. More...
 
FeatureType & accessFeature (const std::size_t feature_index)
 Access operator for features. More...
 
const FeatureType & accessFeature (const std::size_t feature_index) const
 Access operator for features. More...
 
float & accessThreshold (const std::size_t threshold_index)
 Access operator for thresholds. More...
 
const float & accessThreshold (const std::size_t threshold_index) const
 Access operator for thresholds. More...
 

Detailed Description

template<class FeatureType, class NodeType>
class pcl::Fern< FeatureType, NodeType >

Class representing a Fern.

Definition at line 49 of file fern.h.

Constructor & Destructor Documentation

◆ Fern()

template<class FeatureType, class NodeType>
pcl::Fern< FeatureType, NodeType >::Fern ( )
inline

Constructor.

Definition at line 52 of file fern.h.

◆ ~Fern()

template<class FeatureType, class NodeType>
virtual pcl::Fern< FeatureType, NodeType >::~Fern ( )
inlinevirtual

Destructor.

Definition at line 55 of file fern.h.

Member Function Documentation

◆ accessFeature() [1/2]

template<class FeatureType, class NodeType>
FeatureType& pcl::Fern< FeatureType, NodeType >::accessFeature ( const std::size_t  feature_index)
inline

◆ accessFeature() [2/2]

template<class FeatureType, class NodeType>
const FeatureType& pcl::Fern< FeatureType, NodeType >::accessFeature ( const std::size_t  feature_index) const
inline

Access operator for features.

Parameters
feature_indexthe index of the feature to access

Definition at line 174 of file fern.h.

◆ accessThreshold() [1/2]

template<class FeatureType, class NodeType>
float& pcl::Fern< FeatureType, NodeType >::accessThreshold ( const std::size_t  threshold_index)
inline

◆ accessThreshold() [2/2]

template<class FeatureType, class NodeType>
const float& pcl::Fern< FeatureType, NodeType >::accessThreshold ( const std::size_t  threshold_index) const
inline

Access operator for thresholds.

Parameters
threshold_indexthe index of the threshold to access

Definition at line 194 of file fern.h.

◆ deserialize()

template<class FeatureType, class NodeType>
void pcl::Fern< FeatureType, NodeType >::deserialize ( ::std::istream &  stream)
inline

Deserializes the fern.

Parameters
[in]streamthe source for the deserialization

Definition at line 117 of file fern.h.

◆ getNumOfFeatures()

template<class FeatureType, class NodeType>
std::size_t pcl::Fern< FeatureType, NodeType >::getNumOfFeatures ( )
inline

◆ getNumOfNodes()

template<class FeatureType, class NodeType>
std::size_t pcl::Fern< FeatureType, NodeType >::getNumOfNodes ( )
inline

Returns the number of nodes the Fern has.

Definition at line 72 of file fern.h.

◆ initialize()

template<class FeatureType, class NodeType>
void pcl::Fern< FeatureType, NodeType >::initialize ( const std::size_t  num_of_decisions)
inline

Initializes the fern.

Parameters
num_of_decisionsthe number of decisions taken to access the nodes

Definition at line 62 of file fern.h.

Referenced by pcl::FernTrainer< FeatureType, DataSet, LabelType, ExampleIndex, NodeType >::train().

◆ operator[]() [1/2]

template<class FeatureType, class NodeType>
NodeType& pcl::Fern< FeatureType, NodeType >::operator[] ( const std::size_t  node_index)
inline

Access operator for nodes.

Parameters
node_indexthe index of the node to access

Definition at line 145 of file fern.h.

◆ operator[]() [2/2]

template<class FeatureType, class NodeType>
const NodeType& pcl::Fern< FeatureType, NodeType >::operator[] ( const std::size_t  node_index) const
inline

Access operator for nodes.

Parameters
node_indexthe index of the node to access

Definition at line 154 of file fern.h.

◆ serialize()

template<class FeatureType, class NodeType>
void pcl::Fern< FeatureType, NodeType >::serialize ( ::std::ostream &  stream) const
inline

Serializes the fern.

Parameters
[out]streamthe destination for the serialization

Definition at line 89 of file fern.h.


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