| OpenMS 2.5.0

Classes | Public Member Functions | Protected Attributes | Private Member Functions | List of all members
GumbelMaxLikelihoodFitter Class Reference
Math

Implements a fitter for the Gumbel distribution. More...

`#include <OpenMS/MATH/STATISTICS/GumbelMaxLikelihoodFitter.h>`

## Classes

struct | Functor
struct | GumbelDistributionFitResult
| struct to represent the parameters of a gumbel distribution More...
struct | GumbelDistributionFunctor

## Public Member Functions

| GumbelMaxLikelihoodFitter ()
| Default constructor. More...
| GumbelMaxLikelihoodFitter (GumbelDistributionFitResult init)
| Default constructor. More...
virtual | ~GumbelMaxLikelihoodFitter ()
| Destructor. More...
void | setInitialParameters (const GumbelDistributionFitResult &result)
| sets the gumbel distribution start parameters a and b for the fitting More...
GumbelDistributionFitResult | fitWeighted (const std::vector< double > &x, const std::vector< double > &w)
| Fits a gumbel distribution to the given data x values. Fills a weighted histogram first and generates y values. More...

## Protected Attributes

GumbelDistributionFitResult | init_param_

## Private Member Functions

| GumbelMaxLikelihoodFitter (const GumbelMaxLikelihoodFitter &rhs)
| Copy constructor (not implemented) More...
GumbelMaxLikelihoodFitter & | operator= (const GumbelMaxLikelihoodFitter &rhs)
| assignment operator (not implemented) More...

## Detailed Description

Implements a fitter for the Gumbel distribution.

This class fits a Gumbel distribution to a number of data points. The results as well as the initial guess are specified using the struct GumbelDistributionFitResult.

The formula with the fitted parameters can be transformed into a gnuplot formula using getGnuplotFormula() after fitting.

## Constructor & Destructor Documentation

## ◆ GumbelMaxLikelihoodFitter() [1/3]

GumbelMaxLikelihoodFitter | ( |  | ) |

Default constructor.

## ◆ GumbelMaxLikelihoodFitter() [2/3]

GumbelMaxLikelihoodFitter | ( | GumbelDistributionFitResult | init | ) |

Default constructor.

## ◆ ~GumbelMaxLikelihoodFitter()

virtual ~GumbelMaxLikelihoodFitter | ( |  | ) |

virtual

Destructor.

## ◆ GumbelMaxLikelihoodFitter() [3/3]

GumbelMaxLikelihoodFitter | ( | const GumbelMaxLikelihoodFitter & | rhs | ) |

private

Copy constructor (not implemented)

## Member Function Documentation

## ◆ fitWeighted()

GumbelDistributionFitResult fitWeighted | ( | const std::vector< double > & | x,
|  | const std::vector< double > & | w
| ) |  |

inline

Fits a gumbel distribution to the given data x values. Fills a weighted histogram first and generates y values.

Parameters

  x | Input x values
  w | Input weights

Exceptions

  Exception::UnableToFit | is thrown if fitting cannot be performed

## ◆ operator=()

GumbelMaxLikelihoodFitter& operator= | ( | const GumbelMaxLikelihoodFitter & | rhs | ) |

private

assignment operator (not implemented)

## ◆ setInitialParameters()

void setInitialParameters | ( | const GumbelDistributionFitResult & | result | ) |

sets the gumbel distribution start parameters a and b for the fitting

## Member Data Documentation

## ◆ init_param_

GumbelDistributionFitResult init_param_

protected