Point Cloud Library (PCL)  1.9.1-dev
feature_handler.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 <vector>
43 #include <ostream>
44 
45 namespace pcl
46 {
47 
48  /** \brief Utility class interface which is used for creating and evaluating features. */
49  template <
50  class FeatureType,
51  class DataSet,
52  class ExampleIndex >
53  class PCL_EXPORTS FeatureHandler
54  {
55  public:
56 
57  /** \brief Destructor. */
58  virtual
60 
61  /** \brief Creates random features.
62  * \param[in] num_of_features The number of random features to create.
63  * \param[out] features The destination for the created features.
64  */
65  virtual void
66  createRandomFeatures (const size_t num_of_features, std::vector<FeatureType> & features) = 0;
67 
68  /** \brief Evaluates a feature on the specified data.
69  * \param[in] feature The features to evaluate.
70  * \param[in] data_set The data set on which the feature is evaluated.
71  * \param[in] examples The examples which specify on which parts of the data set the feature is evaluated.
72  * \param[out] results The destination for the results of the feature evaluation.
73  * \param[out] flags Flags that are supplied together with the results.
74  */
75  virtual void
76  evaluateFeature (const FeatureType & feature,
77  DataSet & data_set,
78  std::vector<ExampleIndex> & examples,
79  std::vector<float> & results,
80  std::vector<unsigned char> & flags) const = 0;
81 
82  /** \brief Evaluates a feature on the specified data.
83  * \param[in] feature The features to evaluate.
84  * \param[in] data_set The data set on which the feature is evaluated.
85  * \param[in] example The examples which specify on which parts of the data set the feature is evaluated.
86  * \param[out] result The destination for the results of the feature evaluation.
87  * \param[out] flag Flags that are supplied together with the results.
88  */
89  virtual void
90  evaluateFeature (const FeatureType & feature,
91  DataSet & data_set,
92  const ExampleIndex & example,
93  float & result,
94  unsigned char & flag) const = 0;
95 
96  /** \brief Generates evaluation code for the specified feature and writes it to the specified stream.
97  * \param[in] feature The feature for which code is generated.
98  * \param[out] stream The destination for the code.
99  */
100  virtual void
101  generateCodeForEvaluation (const FeatureType & feature,
102  ::std::ostream & stream) const = 0;
103 
104  };
105 
106 }
virtual ~FeatureHandler()
Destructor.
This file defines compatibility wrappers for low level I/O functions.
Definition: convolution.h:44
Utility class interface which is used for creating and evaluating features.