Point Cloud Library (PCL)  1.14.0-dev
fern_evaluator.h
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Point Cloud Library (PCL) - www.pointclouds.org
5  * Copyright (c) 2010-2011, Willow Garage, Inc.
6  *
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * * Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  * * Redistributions in binary form must reproduce the above
16  * copyright notice, this list of conditions and the following
17  * disclaimer in the documentation and/or other materials provided
18  * with the distribution.
19  * * Neither the name of Willow Garage, Inc. nor the names of its
20  * contributors may be used to endorse or promote products derived
21  * from this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34  * POSSIBILITY OF SUCH DAMAGE.
35  *
36  */
37 
38 #pragma once
39 
40 #include <pcl/common/common.h>
41 #include <pcl/ml/feature_handler.h>
42 #include <pcl/ml/ferns/fern.h>
43 #include <pcl/ml/stats_estimator.h>
44 
45 #include <vector>
46 
47 namespace pcl {
48 
49 /** Utility class for evaluating a fern. */
50 template <class FeatureType,
51  class DataSet,
52  class LabelType,
53  class ExampleIndex,
54  class NodeType>
56 
57 public:
58  /** Constructor. */
59  FernEvaluator();
60 
61  /** Evaluates the specified examples using the supplied tree.
62  *
63  * \param[in] fern the decision tree
64  * \param[in] feature_handler the feature handler used to train the tree
65  * \param[in] stats_estimator the statistics estimation instance used while training
66  * the tree
67  * \param[in] data_set the data set used for evaluation
68  * \param[in] examples the examples that have to be evaluated
69  * \param[out] label_data the destination for the resulting label data
70  */
71  void
72  evaluate(
76  DataSet& data_set,
77  std::vector<ExampleIndex>& examples,
78  std::vector<LabelType>& label_data);
79 
80  /** Evaluates the specified examples using the supplied tree and adds the
81  * results to the supplied results array.
82  *
83  * \param[in] fern the decision tree
84  * \param[in] feature_handler the feature handler used to train the tree
85  * \param[in] stats_estimator the statistics estimation instance used while training
86  * the tree
87  * \param[in] data_set the data set used for evaluation
88  * \param[in] examples the examples that have to be evaluated
89  * \param[out] label_data the destination where the resulting label data is added to
90  */
91  void
96  DataSet& data_set,
97  std::vector<ExampleIndex>& examples,
98  std::vector<LabelType>& label_data);
99 
100  /** Evaluates the specified examples using the supplied tree.
101  *
102  * \param[in] fern the decision tree
103  * \param[in] feature_handler the feature handler used to train the tree
104  * \param[in] stats_estimator the statistics estimation instance used while training
105  * the tree
106  * \param[in] data_set the data set used for evaluation
107  * \param[in] examples the examples that have to be evaluated
108  * \param[out] nodes the leaf-nodes reached while evaluation
109  */
110  void
111  getNodes(
115  DataSet& data_set,
116  std::vector<ExampleIndex>& examples,
117  std::vector<NodeType*>& nodes);
118 };
119 
120 } // namespace pcl
121 
122 #include <pcl/ml/impl/ferns/fern_evaluator.hpp>
Utility class interface which is used for creating and evaluating features.
Utility class for evaluating a fern.
void evaluate(pcl::Fern< FeatureType, NodeType > &fern, pcl::FeatureHandler< FeatureType, DataSet, ExampleIndex > &feature_handler, pcl::StatsEstimator< LabelType, NodeType, DataSet, ExampleIndex > &stats_estimator, DataSet &data_set, std::vector< ExampleIndex > &examples, std::vector< LabelType > &label_data)
Evaluates the specified examples using the supplied tree.
void evaluateAndAdd(pcl::Fern< FeatureType, NodeType > &fern, pcl::FeatureHandler< FeatureType, DataSet, ExampleIndex > &feature_handler, pcl::StatsEstimator< LabelType, NodeType, DataSet, ExampleIndex > &stats_estimator, DataSet &data_set, std::vector< ExampleIndex > &examples, std::vector< LabelType > &label_data)
Evaluates the specified examples using the supplied tree and adds the results to the supplied results...
FernEvaluator()
Constructor.
void getNodes(pcl::Fern< FeatureType, NodeType > &fern, pcl::FeatureHandler< FeatureType, DataSet, ExampleIndex > &feature_handler, pcl::StatsEstimator< LabelType, NodeType, DataSet, ExampleIndex > &stats_estimator, DataSet &data_set, std::vector< ExampleIndex > &examples, std::vector< NodeType * > &nodes)
Evaluates the specified examples using the supplied tree.
Class representing a Fern.
Definition: fern.h:49
Define standard C methods and C++ classes that are common to all methods.