Point Cloud Library (PCL)  1.14.1-dev
decision_tree_data_provider.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/memory.h>
42 #include <pcl/pcl_macros.h> // for PCL_EXPORTS
43 
44 namespace pcl {
45 template <class FeatureType,
46  class DataSet,
47  class LabelType,
48  class ExampleIndex,
49  class NodeType>
51 
52  /** The training data set. */
53  DataSet data_set_;
54  /** The label data. */
55  std::vector<LabelType> label_data_;
56 
57 public:
58  using Ptr = shared_ptr<DecisionTreeTrainerDataProvider<FeatureType,
59  DataSet,
60  LabelType,
61  ExampleIndex,
62  NodeType>>;
63  using ConstPtr = shared_ptr<const DecisionTreeTrainerDataProvider<FeatureType,
64  DataSet,
65  LabelType,
66  ExampleIndex,
67  NodeType>>;
68 
69  /** Constructor. */
71 
72  /** Destructor. */
73  virtual ~DecisionTreeTrainerDataProvider() = default;
74 
75  /** Virtual function called to obtain training examples and labels before
76  * training a specific tree */
77  virtual void
78  getDatasetAndLabels(DataSet& data_set,
79  std::vector<LabelType>& label_data,
80  std::vector<ExampleIndex>& examples) = 0;
81 };
82 
83 } // namespace pcl
DecisionTreeTrainerDataProvider()=default
Constructor.
virtual ~DecisionTreeTrainerDataProvider()=default
Destructor.
shared_ptr< const DecisionTreeTrainerDataProvider< FeatureType, DataSet, LabelType, ExampleIndex, NodeType > > ConstPtr
virtual void getDatasetAndLabels(DataSet &data_set, std::vector< LabelType > &label_data, std::vector< ExampleIndex > &examples)=0
Virtual function called to obtain training examples and labels before training a specific tree.
shared_ptr< DecisionTreeTrainerDataProvider< FeatureType, DataSet, LabelType, ExampleIndex, NodeType > > Ptr
Define standard C methods and C++ classes that are common to all methods.
Defines functions, macros and traits for allocating and using memory.
Defines all the PCL and non-PCL macros used.
#define PCL_EXPORTS
Definition: pcl_macros.h:323