OpenMS  3.0.0
TransformationModelInterpolated.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, Hendrik Weisser $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 #include <OpenMS/config.h>
38 
41 
42 namespace OpenMS
43 {
69  class OPENMS_DLLAPI TransformationModelInterpolated :
70  public TransformationModel
71  {
72 public:
73 
82  TransformationModelInterpolated(const DataPoints& data, const Param& params);
83  TransformationModelInterpolated(const std::vector<std::pair<double,double>>& data, const Param& params, bool preprocess);
84 
87 
95  double evaluate(double value) const override;
96 
98  static void getDefaultParameters(Param& params);
99 
108  {
109 public:
110 
117  virtual void init(std::vector<double>& x, std::vector<double>& y) = 0;
118 
126  virtual double eval(const double& x) const = 0;
127 
131  virtual ~Interpolator() {}
132  };
133 
134 private:
136  std::vector<double> x_;
137 
139  std::vector<double> y_;
140 
143 
146 
149 
151  void preprocessDataPoints_(const DataPoints& data);
152 
154  void preprocessDataPoints_(const std::vector<std::pair<double,double>>& data);
155  };
156 
157 } // namespace
158 
OpenMS::TransformationModelInterpolated::lm_back_
TransformationModelLinear * lm_back_
Linear model for extrapolation (back)
Definition: TransformationModelInterpolated.h:148
TransformationModel.h
OpenMS::TransformationModelLinear
Linear model for transformations.
Definition: TransformationModelLinear.h:58
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
TransformationModelLinear.h
OpenMS::TransformationModel
Base class for transformation models.
Definition: TransformationModel.h:54
OpenMS::TransformationModelInterpolated::Interpolator::~Interpolator
virtual ~Interpolator()
d'tor.
Definition: TransformationModelInterpolated.h:131
OpenMS::TransformationModelInterpolated::interp_
Interpolator * interp_
Interpolation function.
Definition: TransformationModelInterpolated.h:142
OpenMS::TransformationModelInterpolated::y_
std::vector< double > y_
Data coordinates y.
Definition: TransformationModelInterpolated.h:139
OpenMS::TransformationModelInterpolated::Interpolator
The class defines a generic interpolation technique used in the TransformationModelInterpolated.
Definition: TransformationModelInterpolated.h:107
OpenMS::TransformationModelInterpolated::x_
std::vector< double > x_
Data coordinates x.
Definition: TransformationModelInterpolated.h:136
OpenMS::TransformationModelInterpolated
Interpolation model for transformations.
Definition: TransformationModelInterpolated.h:69
OpenMS::Param
Management and storage of parameters / INI files.
Definition: Param.h:69
OpenMS::TransformationModel::DataPoints
std::vector< DataPoint > DataPoints
Vector of coordinate pairs.
Definition: TransformationModel.h:91
OpenMS::TransformationModelInterpolated::lm_front_
TransformationModelLinear * lm_front_
Linear model for extrapolation (front)
Definition: TransformationModelInterpolated.h:145