Point Cloud Library (PCL)  1.10.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 
42 #include <pcl/ml/feature_handler.h>
43 #include <pcl/ml/ferns/fern.h>
44 #include <pcl/ml/stats_estimator.h>
45 
46 #include <vector>
47 
48 namespace pcl {
49 
50 /** Utility class for evaluating a fern. */
51 template <class FeatureType,
52  class DataSet,
53  class LabelType,
54  class ExampleIndex,
55  class NodeType>
57 
58 public:
59  /** Constructor. */
60  FernEvaluator();
61 
62  /** Destructor. */
63  virtual ~FernEvaluator();
64 
65  /** Evaluates the specified examples using the supplied tree.
66  *
67  * \param[in] fern the decision tree
68  * \param[in] feature_handler the feature handler used to train the tree
69  * \param[in] stats_estimator the statistics estimation instance used while training
70  * the tree
71  * \param[in] data_set the data set used for evaluation
72  * \param[in] examples the examples that have to be evaluated
73  * \param[out] label_data the destination for the resulting label data
74  */
75  void
76  evaluate(
80  DataSet& data_set,
81  std::vector<ExampleIndex>& examples,
82  std::vector<LabelType>& label_data);
83 
84  /** Evaluates the specified examples using the supplied tree and adds the
85  * results to the supplied results array.
86  *
87  * \param[in] fern the decision tree
88  * \param[in] feature_handler the feature handler used to train the tree
89  * \param[in] stats_estimator the statistics estimation instance used while training
90  * the tree
91  * \param[in] data_set the data set used for evaluation
92  * \param[in] examples the examples that have to be evaluated
93  * \param[out] label_data the destination where the resulting label data is added to
94  */
95  void
100  DataSet& data_set,
101  std::vector<ExampleIndex>& examples,
102  std::vector<LabelType>& label_data);
103 
104  /** Evaluates the specified examples using the supplied tree.
105  *
106  * \param[in] fern the decision tree
107  * \param[in] feature_handler the feature handler used to train the tree
108  * \param[in] stats_estimator the statistics estimation instance used while training
109  * the tree
110  * \param[in] data_set the data set used for evaluation
111  * \param[in] examples the examples that have to be evaluated
112  * \param[out] nodes the leaf-nodes reached while evaluation
113  */
114  void
115  getNodes(
119  DataSet& data_set,
120  std::vector<ExampleIndex>& examples,
121  std::vector<NodeType*>& nodes);
122 };
123 
124 } // namespace pcl
125 
126 #include <pcl/ml/impl/ferns/fern_evaluator.hpp>
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.
Utility class for evaluating a fern.
This file defines compatibility wrappers for low level I/O functions.
Definition: convolution.h:45
FernEvaluator()
Constructor.
Define standard C methods and C++ classes that are common to all methods.
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
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...
virtual ~FernEvaluator()
Destructor.
Utility class interface which is used for creating and evaluating features.