OpenMS  3.0.0
BSpline2d.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2022.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Timo Sachsenberg $
32 // $Authors: Stephan Aiche, Timo Sachsenberg $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 #include <vector>
38 
39 #include <OpenMS/config.h>
41 #include <OpenMS/CONCEPT/Types.h>
43 #include <OpenMS/CONCEPT/Macros.h>
44 
45 // forward declaration of impl class BSpline
46 namespace eol_bspline
47 {
48 template <class T>
49 class BSpline;
50 }
51 
52 namespace OpenMS
53 {
57  class OPENMS_DLLAPI BSpline2d
58  {
59 public:
60 
61  // Note: Don't change boundary condition constants as these are passed through to the eol-bspline implementation.
63  {
65  BC_ZERO_ENDPOINTS = 0,
67  BC_ZERO_FIRST = 1,
69  BC_ZERO_SECOND = 2
70  };
71 
95  BSpline2d(const std::vector<double>& x, const std::vector<double>& y,
96  double wavelength = 0, BoundaryCondition boundary_condition = BC_ZERO_SECOND,
97  Size num_nodes = 0);
98 
102  virtual ~BSpline2d();
103 
111  bool solve(const std::vector<double>& y);
112 
117  double eval(const double x) const;
118 
123  double derivative(const double x) const;
124 
128  bool ok() const;
129 
133  static void debug(bool enable);
134 
135 private:
136 
137  // Pointer to actual implementation. Note: This class follows the PIMPL idiom hiding the actual
138  // B-spline implementation behind this pointer to avoid any dependency of the interface to the
139  // implementation. Thus, the eol splines are only required during compilation of OpenMS and
140  // not when linking against OpenMS.
142  };
143 
144 }
145 
Types.h
OpenMS::Size
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:127
eol_bspline::BSpline< double >
Macros.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
Exception.h
OpenMS::BSpline2d::BoundaryCondition
BoundaryCondition
Definition: BSpline2d.h:62
OpenMS::BSpline2d::spline_
eol_bspline::BSpline< double > * spline_
Definition: BSpline2d.h:141
StandardDeclarations.h
eol_bspline::BSpline
Definition: BSpline2d.h:49
eol_bspline
Definition: BSpline2d.h:46
OpenMS::BSpline2d
b spline interpolation
Definition: BSpline2d.h:57