Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
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-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: Clemens Groepl $
32 // $Authors: Clemens Groepl, Hendrik Weisser $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_ANALYSIS_MAPMATCHING_TRANSFORMATIONDESCRIPTION_H
36 #define OPENMS_ANALYSIS_MAPMATCHING_TRANSFORMATIONDESCRIPTION_H
37 
40 
41 namespace OpenMS
42 {
58  class OPENMS_DLLAPI TransformationDescription
59  {
60  // friend class MapAlignmentAlgorithm;
61 
62 public:
63 
68 
72  explicit TransformationDescription(const DataPoints& data);
75 
80 
82  void fitModel(const String& model_type, const Param& params = Param());
83 
90  double apply(double value) const;
91 
93  const String& getModelType() const;
94 
96  static void getModelTypes(StringList& result);
97 
103  void setDataPoints(const DataPoints& data);
104 
106  const DataPoints& getDataPoints() const;
107 
109  const Param& getModelParameters() const;
110 
112  void invert();
113 
114 protected:
116  DataPoints data_;
121  };
122 
123 } // end of namespace OpenMS
124 
125 #endif // OPENMS_ANALYSIS_MAPMATCHING_TRANSFORMATIONDESCRIPTION_H
A more convenient string class.
Definition: String.h:57
TransformationModel * model_
Pointer to model.
Definition: TransformationDescription.h:120
DataPoints data_
Data points.
Definition: TransformationDescription.h:116
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
TransformationModel::DataPoint DataPoint
Coordinate pair.
Definition: TransformationDescription.h:65
String model_type_
Type of model.
Definition: TransformationDescription.h:118
std::vector< String > StringList
Vector of String.
Definition: ListUtils.h:74
Management and storage of parameters / INI files.
Definition: Param.h:75
std::vector< DataPoint > DataPoints
Vector of coordinate pairs.
Definition: TransformationModel.h:58
Base class for transformation models.
Definition: TransformationModel.h:52
Generic description of a coordinate transformation.
Definition: TransformationDescription.h:58
std::pair< double, double > DataPoint
Coordinate pair.
Definition: TransformationModel.h:56
TransformationModel::DataPoints DataPoints
Vector of coordinate pairs.
Definition: TransformationDescription.h:67

OpenMS / TOPP release 2.0.0 Documentation generated on Wed Mar 30 2016 12:49:26 using doxygen 1.8.11