Point Cloud Library (PCL)  1.14.0-dev
piecewise_linear_function.h
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2010, Willow Garage, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above
14  * copyright notice, this list of conditions and the following
15  * disclaimer in the documentation and/or other materials provided
16  * with the distribution.
17  * * Neither the name of the copyright holder(s) nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  */
35 
36 /* \author Bastian Steder */
37 
38 #pragma once
39 
40 #include <vector>
41 
42 namespace pcl
43 {
44  /**
45  * \brief This provides functionalities to efficiently return values for piecewise linear function
46  * \ingroup common
47  */
49  {
50  public:
51  // =====CONSTRUCTOR & DESTRUCTOR=====
52  //! Constructor
53  PiecewiseLinearFunction (float factor, float offset);
54 
55  // =====PUBLIC METHODS=====
56  //! Get the list of known data points
57  std::vector<float>&
59  {
60  return data_points_;
61  }
62 
63  //! Get the value of the function at the given point
64  inline float
65  getValue (float point) const;
66 
67  // =====PUBLIC MEMBER VARIABLES=====
68 
69  protected:
70  // =====PROTECTED MEMBER VARIABLES=====
71  std::vector<float> data_points_;
72  float factor_;
73  float offset_;
74  };
75 
76 } // end namespace pcl
77 
78 #include <pcl/common/impl/piecewise_linear_function.hpp>
This provides functionalities to efficiently return values for piecewise linear function.
std::vector< float > & getDataPoints()
Get the list of known data points.
float getValue(float point) const
Get the value of the function at the given point.
PiecewiseLinearFunction(float factor, float offset)
Constructor.