OpenMS
GumbelDistributionFitter Class Reference

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

#include <OpenMS/MATH/STATISTICS/GumbelDistributionFitter.h>

Collaboration diagram for GumbelDistributionFitter:
[legend]

Classes

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

Public Member Functions

 GumbelDistributionFitter ()
 Default constructor. More...
 
virtual ~GumbelDistributionFitter ()
 Destructor. More...
 
void setInitialParameters (const GumbelDistributionFitResult &result)
 sets the gumbel distribution start parameters a and b for the fitting More...
 
GumbelDistributionFitResult fit (std::vector< DPosition< 2 > > &points) const
 Fits a gumbel distribution to the given data points. 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

 GumbelDistributionFitter (const GumbelDistributionFitter &rhs)
 Copy constructor (not implemented) More...
 
GumbelDistributionFitteroperator= (const GumbelDistributionFitter &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.

@ingroup Math

Constructor & Destructor Documentation

◆ GumbelDistributionFitter() [1/2]

Default constructor.

◆ ~GumbelDistributionFitter()

virtual ~GumbelDistributionFitter ( )
virtual

Destructor.

◆ GumbelDistributionFitter() [2/2]

Copy constructor (not implemented)

Member Function Documentation

◆ fit()

GumbelDistributionFitResult fit ( std::vector< DPosition< 2 > > &  points) const

Fits a gumbel distribution to the given data points.

Parameters
pointsInput parameter which represents the point used for the fitting
Exceptions
Exception::UnableToFitis thrown if fitting cannot be performed

◆ fitWeighted()

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.

Parameters
xInput x values
wInput weights
Exceptions
Exception::UnableToFitis thrown if fitting cannot be performed

◆ operator=()

GumbelDistributionFitter& operator= ( const GumbelDistributionFitter 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