Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
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-2015.
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 #ifndef OPENMS_MATH_MISC_BSPLINE2D_H
36 #define OPENMS_MATH_MISC_BSPLINE2D_H
37 
38 #include <vector>
39 
40 #include <OpenMS/config.h>
42 
43 // forward declaration of impl class BSpline
44 namespace eol_bspline
45 {
46 template <class T>
47 class BSpline;
48 }
49 
50 namespace OpenMS
51 {
55  class OPENMS_DLLAPI BSpline2d
56  {
57 public:
58 
59  // Note: Don't change boundary condition constants as these are passed through to the eol-bspline implementation.
61  {
63  BC_ZERO_ENDPOINTS = 0,
65  BC_ZERO_FIRST = 1,
67  BC_ZERO_SECOND = 2
68  };
69 
93  BSpline2d(const std::vector<double>& x, const std::vector<double>& y, double wavelength = 0, BoundaryCondition boundary_condition = BC_ZERO_SECOND, Size num_nodes = 0);
94 
98  virtual ~BSpline2d();
99 
107  bool solve(const std::vector<double>& y);
108 
113  double eval(const double x) const;
114 
119  double derivative(const double x) const;
120 
124  bool ok() const;
125 
129  static void debug(bool enable);
130 
131 private:
132  // Pointer to actual implementation. Note: This class follows the PIMPL idiom hiding the actual
133  // B-spline implementation behind this pointer to avoid any dependency of the interface to the
134  // implementation. Thus, the eol splines are only required during compilation of OpenMS and
135  // not when linking against OpenMS.
137  };
138 
139 }
140 
141 #endif
Definition: BSpline2d.h:44
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
b spline interpolation
Definition: BSpline2d.h:55
BoundaryCondition
Definition: BSpline2d.h:60
Definition: BSpline2d.h:47
eol_bspline::BSpline< double > * spline_
Definition: BSpline2d.h:136

OpenMS / TOPP release 2.0.0 Documentation generated on Fri May 29 2015 17:20:21 using doxygen 1.8.9.1