OpenMS
TransformationModelBSpline.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-2023.
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: Hendrik Weisser $
32 // $Authors: Hendrik Weisser $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 #include <OpenMS/config.h> // is this needed?
38 
41 
42 namespace OpenMS
43 {
44 
50  class OPENMS_DLLAPI TransformationModelBSpline :
51  public TransformationModel
52  {
53 public:
60  TransformationModelBSpline(const DataPoints& data, const Param& params);
61 
64 
66  double evaluate(double value) const override;
67 
69 
71  static void getDefaultParameters(Param& params);
72 
73 protected:
76 
78  double xmin_, xmax_;
79 
81  enum { EX_LINEAR, EX_BSPLINE, EX_CONSTANT, EX_GLOBAL_LINEAR } extrapolate_;
82 
84  double offset_min_, offset_max_, slope_min_, slope_max_;
85  };
86 } // namespace
87 
b spline interpolation
Definition: BSpline2d.h:58
Management and storage of parameters / INI files.
Definition: Param.h:70
B-spline (non-linear) model for transformations.
Definition: TransformationModelBSpline.h:52
BSpline2d * spline_
Pointer to the actual B-spline.
Definition: TransformationModelBSpline.h:75
static void getDefaultParameters(Param &params)
Gets the default parameters.
double xmax_
Definition: TransformationModelBSpline.h:78
double evaluate(double value) const override
Evaluates the model at the given value.
TransformationModelBSpline(const DataPoints &data, const Param &params)
Constructor.
@ EX_BSPLINE
Definition: TransformationModelBSpline.h:81
double offset_max_
Definition: TransformationModelBSpline.h:84
~TransformationModelBSpline() override
Destructor.
Base class for transformation models.
Definition: TransformationModel.h:55
const Param & getParameters() const
Gets the (actual) parameters.
std::vector< DataPoint > DataPoints
Vector of coordinate pairs.
Definition: TransformationModel.h:91
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48