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