OpenMS
GammaDistributionFitter.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-2023.
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: Andreas Bertsch $
33 // --------------------------------------------------------------------------
34 //
35 #pragma once
36 
39 
40 #include <vector>
41 
42 
43 namespace OpenMS
44 {
45  namespace Math
46  {
60  class OPENMS_DLLAPI GammaDistributionFitter
61  {
62 public:
63 
66  {
67 public:
68 
69  GammaDistributionFitResult(double bIn, double pIn) :
70  b(bIn),
71  p(pIn)
72  {
73  }
74 
76  double b;
77 
79  double p;
80  };
81 
86 
89 
97  GammaDistributionFitResult fit(const std::vector<DPosition<2> >& points) const;
98 
99 protected:
100 
102 
103 private:
108  };
109  }
110 }
111 
Implements a fitter for the Gamma distribution.
Definition: GammaDistributionFitter.h:61
GammaDistributionFitter()
Default constructor.
void setInitialParameters(const GammaDistributionFitResult &result)
sets the gamma distribution start parameters b and p for the fitting
virtual ~GammaDistributionFitter()
Destructor.
GammaDistributionFitResult init_param_
Definition: GammaDistributionFitter.h:101
GammaDistributionFitter(const GammaDistributionFitter &rhs)
Copy constructor (not implemented to prevent usage)
GammaDistributionFitter & operator=(const GammaDistributionFitter &rhs)
assignment operator (not implemented to prevent usage)
GammaDistributionFitResult fit(const std::vector< DPosition< 2 > > &points) const
Fits a gamma distribution to the given data points.
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48
struct to represent the parameters of a gamma distribution
Definition: GammaDistributionFitter.h:66
double b
parameter b of the gamma distribution
Definition: GammaDistributionFitter.h:76
GammaDistributionFitResult(double bIn, double pIn)
Definition: GammaDistributionFitter.h:69
double p
parameter p of the gamma distribution
Definition: GammaDistributionFitter.h:79