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-2013.
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 {
59  class OPENMS_DLLAPI TransformationDescription
60  {
61  // friend class MapAlignmentAlgorithm;
62 
63 public:
64 
69 
76 
81 
83  void fitModel(const String & model_type, const Param & params = Param());
84 
91  DoubleReal apply(DoubleReal value) const;
92 
94  const String & getModelType() const;
95 
97  static void getModelTypes(StringList & result);
98 
104  void setDataPoints(const DataPoints & data);
105 
107  const DataPoints & getDataPoints() const;
108 
110  void getModelParameters(Param & params) const;
111 
113  void invert();
114 
115 protected:
122  };
123 
124 } // end of namespace OpenMS
125 
126 #endif // OPENMS_ANALYSIS_MAPMATCHING_TRANSFORMATIONDESCRIPTION_H
A more convenient string class.
Definition: String.h:56
TransformationModel * model_
Pointer to model.
Definition: TransformationDescription.h:121
DataPoints data_
Data points.
Definition: TransformationDescription.h:117
TransformationModel::DataPoint DataPoint
Coordinate pair.
Definition: TransformationDescription.h:66
String model_type_
Type of model.
Definition: TransformationDescription.h:119
Management and storage of parameters / INI files.
Definition: Param.h:69
std::pair< DoubleReal, DoubleReal > DataPoint
Coordinate pair.
Definition: TransformationModel.h:56
String list.
Definition: StringList.h:56
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:59
TransformationModel::DataPoints DataPoints
Vector of coordinate pairs.
Definition: TransformationDescription.h:68

OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:22 using doxygen 1.8.5