| OpenMS 2.5.0

EmgModel.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: $
33 // --------------------------------------------------------------------------
34
35
36 #pragma once
37
38 #include <OpenMS/TRANSFORMATIONS/FEATUREFINDER/InterpolationModel.h>
39 #include <OpenMS/MATH/STATISTICS/BasicStatistics.h>
40
41
42 namespace OpenMS
43 {
49 class OPENMS_DLLAPI EmgModel :
50 public InterpolationModel
51 {
52
53 public:
54 typedef InterpolationModel::CoordinateType CoordinateType;
55 typedef Math::BasicStatistics<CoordinateType> BasicStatistics;
56 typedef LinearInterpolation::container_type ContainerType;
57
59 EmgModel();
60
62 EmgModel(const EmgModel & source);
63
65 ~EmgModel() override;
66
68 virtual EmgModel & operator=(const EmgModel & source);
69
71 static BaseModel<1> * create()
72 {
73 return new EmgModel();
74 }
75
77 static const String getProductName()
78 {
79 return "EmgModel";
80 }
81
83 void setOffset(CoordinateType offset) override;
84
86 void setSamples() override;
87
89 CoordinateType getCenter() const override;
90
91 protected:
92 CoordinateType min_;
93 CoordinateType max_;
94 BasicStatistics statistics_;
95 CoordinateType height_;
96 CoordinateType width_;
97 CoordinateType symmetry_;
98 CoordinateType retention_;
99
100 void updateMembers_() override;
101 };
102 }
103
OpenMS::EmgModel::ContainerType
LinearInterpolation::container_type ContainerType
Definition: EmgModel.h:56
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::EmgModel::CoordinateType
InterpolationModel::CoordinateType CoordinateType
Definition: EmgModel.h:54
OpenMS::EmgModel::width_
CoordinateType width_
Definition: EmgModel.h:96
OpenMS::EmgModel
Exponentially modified gaussian distribution model for elution profiles.
Definition: EmgModel.h:49
OpenMS::Math::BasicStatistics< CoordinateType >
OpenMS::EmgModel::min_
CoordinateType min_
Definition: EmgModel.h:92
OpenMS::InterpolationModel
Abstract class for 1D-models that are approximated using linear interpolation.
Definition: InterpolationModel.h:54
BasicStatistics.h
OpenMS::EmgModel::statistics_
BasicStatistics statistics_
Definition: EmgModel.h:94
OpenMS::BaseModel< 1 >
OpenMS::EmgModel::create
static BaseModel< 1 > * create()
create new EmgModel object (needed by Factory)
Definition: EmgModel.h:71
OpenMS::EmgModel::retention_
CoordinateType retention_
Definition: EmgModel.h:98
InterpolationModel.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::EmgModel::max_
CoordinateType max_
Definition: EmgModel.h:93
OpenMS::Math::LinearInterpolation< double >::container_type
std::vector< value_type > container_type
Definition: LinearInterpolation.h:84
double
OpenMS::EmgModel::getProductName
static const String getProductName()
name of the model (needed by Factory)
Definition: EmgModel.h:77
OpenMS::EmgModel::BasicStatistics
Math::BasicStatistics< CoordinateType > BasicStatistics
Definition: EmgModel.h:55
OpenMS::EmgModel::height_
CoordinateType height_
Definition: EmgModel.h:95
OpenMS::EmgModel::symmetry_
CoordinateType symmetry_
Definition: EmgModel.h:97