| OpenMS 2.5.0

TransformationModelLinear.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-2020.
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 $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/config.h>
38
39 #include <OpenMS/ANALYSIS/MAPMATCHING/TransformationModel.h>
40 #include <OpenMS/KERNEL/StandardTypes.h>
41
42 namespace OpenMS
43 {
44
58 class OPENMS_DLLAPI TransformationModelLinear :
59 public TransformationModel
60 {
61 public:
67 TransformationModelLinear(const DataPoints& data, const Param& params);
68
70 ~TransformationModelLinear() override;
71
73 double evaluate(double value) const override;
74
75 using TransformationModel::getParameters;
76
78 void getParameters(double& slope, double& intercept, String& x_weight, String& y_weight, double& x_datum_min, double& x_datum_max, double& y_datum_min, double& y_datum_max) const;
79
81 static void getDefaultParameters(Param& params);
82
88 void invert();
89
90 protected:
92 double slope_, intercept_;
94 bool data_given_;
96 bool symmetric_;
97 };
98 } // namespace
99
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::TransformationModel::getParameters
const Param & getParameters() const
Gets the (actual) parameters.
StandardTypes.h
OpenMS::TransformationModelLinear::slope_
double slope_
Parameters of the linear model.
Definition: TransformationModelLinear.h:92
OpenMS::TransformationModelLinear::symmetric_
bool symmetric_
Use symmetric regression?
Definition: TransformationModelLinear.h:96
OpenMS::TransformationModel::DataPoints
std::vector< DataPoint > DataPoints
Vector of coordinate pairs.
Definition: TransformationModel.h:90
OpenMS::TransformationModel
Base class for transformation models.
Definition: TransformationModel.h:53
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::TransformationModelLinear
Linear model for transformations.
Definition: TransformationModelLinear.h:58
TransformationModel.h
OpenMS::Param
Management and storage of parameters / INI files.
Definition: Param.h:73
OpenMS::TransformationModelLinear::data_given_
bool data_given_
Was the model estimated from data?
Definition: TransformationModelLinear.h:94