Point Cloud Library (PCL)  1.9.1-dev
decision_forest_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/dt/decision_tree_evaluator.h>
43 #include <pcl/ml/dt/decision_forest.h>
44 #include <pcl/ml/feature_handler.h>
45 #include <pcl/ml/stats_estimator.h>
46 
47 #include <vector>
48 
49 namespace pcl
50 {
51 
52  /** \brief Utility class for evaluating a decision forests. */
53  template <
54  class FeatureType,
55  class DataSet,
56  class LabelType,
57  class ExampleIndex,
58  class NodeType >
60  {
61  public:
62  /** \brief Constructor. */
64  /** \brief Destructor. */
65  virtual
67 
68  /** \brief Evaluates the specified examples using the supplied forest.
69  * \param[in] DecisionForestEvaluator The decision forest.
70  * \param[in] feature_handler The feature handler used to train the tree.
71  * \param[in] stats_estimator The statistics estimation instance used while training the tree.
72  * \param[in] data_set The data set used for evaluation.
73  * \param[in] examples The examples that have to be evaluated.
74  * \param[out] label_data The destination for the resulting label data.
75  */
76  void
80  DataSet & data_set,
81  std::vector<ExampleIndex> & examples,
82  std::vector<LabelType> & label_data);
83 
84  /** \brief Evaluates a specific patch using the supplied forest.
85  * \param[in] DecisionForestEvaluator The decision forest.
86  * \param[in] feature_handler The feature handler used to train the tree.
87  * \param[in] stats_estimator The statistics estimation instance used while training the tree.
88  * \param[in] data_set The data set used for evaluation.
89  * \param[in] example The examples that have to be evaluated.
90  * \param[out] leaves The leaves where the patch arrives
91  */
92  void
93  evaluate (pcl::DecisionForest<NodeType> & DecisionForestEvaluator,
96  DataSet & data_set,
97  ExampleIndex example,
98  std::vector<NodeType> & leaves);
99 
100  private:
101  /** \brief Evaluator for decision trees. */
103  };
104 
105 }
106 
107 #include <pcl/ml/impl/dt/decision_forest_evaluator.hpp>
Class representing a decision forest.
Utility class for evaluating a decision tree.
This file defines compatibility wrappers for low level I/O functions.
Definition: convolution.h:45
virtual ~DecisionForestEvaluator()
Destructor.
void evaluate(pcl::DecisionForest< NodeType > &DecisionForestEvaluator, 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 forest.
Utility class for evaluating a decision forests.
Utility class interface which is used for creating and evaluating features.