| OpenMS 2.5.0

GumbelDistributionFitter.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 #pragma once
36
37 #include <OpenMS/DATASTRUCTURES/String.h>
38 #include <OpenMS/DATASTRUCTURES/DPosition.h>
39
40 #include <vector>
41
42
43 namespace OpenMS
44 {
45 namespace Math
46 {
59 class OPENMS_DLLAPI GumbelDistributionFitter
60 {
61 public:
62
64 struct GumbelDistributionFitResult
65 {
66 GumbelDistributionFitResult(double local_a = 1.0, double local_b = 2.0) :
67 a(local_a),
68 b(local_b)
69 {
70 }
71
73 double a;
75 double b;
76
77 double eval(double x) const;
78 double log_eval_no_normalize(double x) const ;
79 };
80
82 GumbelDistributionFitter();
84 virtual ~GumbelDistributionFitter();
85
87 void setInitialParameters(const GumbelDistributionFitResult & result);
88
96 GumbelDistributionFitResult fit(std::vector<DPosition<2> > & points);
97
107 GumbelDistributionFitResult fitWeighted(const std::vector<double> & x, const std::vector<double> & w);
108
109 protected:
110
111 GumbelDistributionFitResult init_param_;
112
113 private:
115 GumbelDistributionFitter(const GumbelDistributionFitter & rhs);
117 GumbelDistributionFitter & operator=(const GumbelDistributionFitter & rhs);
118 };
119 }
120 }
121
OpenMS::Math::GumbelDistributionFitter::GumbelDistributionFitResult::a
double a
location parameter a
Definition: GumbelDistributionFitter.h:73
OpenMS::Math::GumbelDistributionFitter::GumbelDistributionFitResult::GumbelDistributionFitResult
GumbelDistributionFitResult(double local_a=1.0, double local_b=2.0)
Definition: GumbelDistributionFitter.h:66
OpenMS::Math::GumbelDistributionFitter
Implements a fitter for the Gumbel distribution.
Definition: GumbelDistributionFitter.h:59
String.h
DPosition.h
OpenMS::Math::GumbelDistributionFitter::init_param_
GumbelDistributionFitResult init_param_
Definition: GumbelDistributionFitter.h:111
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::Math::GumbelDistributionFitter::GumbelDistributionFitResult
struct to represent the parameters of a gumbel distribution
Definition: GumbelDistributionFitter.h:64
Math
OpenMS::Math::GumbelDistributionFitter::GumbelDistributionFitResult::b
double b
scale parameter b
Definition: GumbelDistributionFitter.h:75
OpenMS::DPosition< 2 >