| OpenMS 2.5.0

BiGaussModel.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 namespace OpenMS
42 {
51 class OPENMS_DLLAPI BiGaussModel :
52 public InterpolationModel
53 {
54 public:
55 typedef InterpolationModel::CoordinateType CoordinateType;
56
58 BiGaussModel();
59
61 BiGaussModel(const BiGaussModel & source);
62
64 ~BiGaussModel() override;
65
67 virtual BiGaussModel & operator=(const BiGaussModel & source);
68
70 static BaseModel<1> * create()
71 {
72 return new BiGaussModel();
73 }
74
76 static const String getProductName()
77 {
78 return "BiGaussModel";
79 }
80
86 void setOffset(CoordinateType offset) override;
87
89 void setSamples() override;
90
92 CoordinateType getCenter() const override;
93
94 protected:
95 CoordinateType min_;
96 CoordinateType max_;
97 Math::BasicStatistics<> statistics1_;
98 Math::BasicStatistics<> statistics2_;
99
100 void updateMembers_() override;
101 };
102 }
103
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::BiGaussModel::CoordinateType
InterpolationModel::CoordinateType CoordinateType
Definition: BiGaussModel.h:55
OpenMS::BiGaussModel::max_
CoordinateType max_
Definition: BiGaussModel.h:96
OpenMS::Math::BasicStatistics
Calculates some basic statistical parameters of a distribution: sum, mean, variance, and provides the normal approximation.
Definition: BasicStatistics.h:67
OpenMS::InterpolationModel
Abstract class for 1D-models that are approximated using linear interpolation.
Definition: InterpolationModel.h:54
OpenMS::BiGaussModel::min_
CoordinateType min_
Definition: BiGaussModel.h:95
BasicStatistics.h
OpenMS::BaseModel< 1 >
OpenMS::BiGaussModel::statistics1_
Math::BasicStatistics statistics1_
Definition: BiGaussModel.h:97
OpenMS::BiGaussModel
BiGaussian distribution approximated using linear interpolation.
Definition: BiGaussModel.h:51
OpenMS::BiGaussModel::statistics2_
Math::BasicStatistics statistics2_
Definition: BiGaussModel.h:98
InterpolationModel.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::BiGaussModel::create
static BaseModel< 1 > * create()
create new BiGaussModel object (function needed by Factory)
Definition: BiGaussModel.h:70
double
OpenMS::BiGaussModel::getProductName
static const String getProductName()
name of the model (needed by Factory)
Definition: BiGaussModel.h:76