OpenMS  2.4.0
TransformationDescription.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-2018.
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: Clemens Groepl, Hendrik Weisser $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
39 #include <iostream>
40 
41 namespace OpenMS
42 {
60  class OPENMS_DLLAPI TransformationDescription
61  {
62  // friend class MapAlignmentAlgorithm;
63 
64 public:
65 
70 
74  explicit TransformationDescription(const DataPoints& data);
77 
82 
84  void fitModel(const String& model_type, const Param& params = Param());
85 
92  double apply(double value) const;
93 
95  const String& getModelType() const;
96 
98  static void getModelTypes(StringList& result);
99 
105  void setDataPoints(const DataPoints& data);
106 
112  void setDataPoints(const std::vector<std::pair<double, double> >& data);
113 
115  const DataPoints& getDataPoints() const;
116 
118  const Param& getModelParameters() const;
119 
121  void invert();
122 
130  void getDeviations(std::vector<double>& diffs, bool do_apply = false,
131  bool do_sort = true) const;
132 
134  void printSummary(std::ostream& os = std::cout) const;
135 
136 protected:
143  };
144 
145 } // end of namespace OpenMS
146 
A more convenient string class.
Definition: String.h:57
TransformationModel * model_
Pointer to model.
Definition: TransformationDescription.h:142
DataPoints data_
Data points.
Definition: TransformationDescription.h:138
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
TransformationModel::DataPoint DataPoint
Coordinate pair.
Definition: TransformationDescription.h:67
String model_type_
Type of model.
Definition: TransformationDescription.h:140
std::vector< String > StringList
Vector of String.
Definition: ListUtils.h:73
Management and storage of parameters / INI files.
Definition: Param.h:74
std::vector< DataPoint > DataPoints
Vector of coordinate pairs.
Definition: TransformationModel.h:88
Base class for transformation models.
Definition: TransformationModel.h:51
Generic description of a coordinate transformation.
Definition: TransformationDescription.h:60
TransformationModel::DataPoints DataPoints
Vector of coordinate pairs.
Definition: TransformationDescription.h:69
Coordinate pair (with optional annotation)
Definition: TransformationModel.h:55