GumbelDistributionFitter Class Reference [Math]

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

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

List of all members.

Classes
struct	GumbelDistributionFitResult
	struct to represent the parameters of a gumbel distribution More...
Public Member Functions
	GumbelDistributionFitter ()
	Default constructor.
virtual	~GumbelDistributionFitter ()
	Destructor.
void	setInitialParameters (const GumbelDistributionFitResult &result)
	sets the gumbel distribution start parameters a and b for the fitting
GumbelDistributionFitResult	fit (std::vector< DPosition< 2 > > &points)
	Fits a gumbel distribution to the given data points.
const String &	getGnuplotFormula () const
	returns the gnuplot formula of the fitted gumbel distribution
Protected Member Functions
void	printState_ (size_t iter, gsl_multifit_fdfsolver *s)
Static Protected Member Functions
static int	gumbelDistributionFitterf_ (const gsl_vector *x, void *params, gsl_vector *f)
static int	gumbelDistributionFitterdf_ (const gsl_vector *x, void *params, gsl_matrix *J)
static int	gumbelDistributionFitterfdf_ (const gsl_vector *x, void *params, gsl_vector *f, gsl_matrix *J)
Protected Attributes
GumbelDistributionFitResult	init_param_
String	gnuplot_formula_
Private Member Functions
	GumbelDistributionFitter (const GumbelDistributionFitter &rhs)
	Copy constructor (not implemented).
GumbelDistributionFitter &	operator= (const GumbelDistributionFitter &rhs)
	assignment operator (not implemented)

---

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.

The implementation is done using GSL fitting algorithms.

---

Constructor & Destructor Documentation

GumbelDistributionFitter

(

)

Default constructor.

virtual ~GumbelDistributionFitter

(

)

[virtual]

Destructor.

GumbelDistributionFitter

(

const GumbelDistributionFitter &

rhs

)

[private]

Copy constructor (not implemented).

---

Member Function Documentation

GumbelDistributionFitResult fit

(

std::vector< DPosition< 2 > > &

points

)

Fits a gumbel distribution to the given data points.

Parameters:

points

Input parameter which represents the point used for the fitting

Exceptions:

Exception::UnableToFit

is thrown if fitting cannot be performed

const String& getGnuplotFormula

(

)

const

returns the gnuplot formula of the fitted gumbel distribution

static int gumbelDistributionFitterdf_	(	const gsl_vector *	x,
		void *	params,
		gsl_matrix *	J
	)			[static, protected]

static int gumbelDistributionFitterf_	(	const gsl_vector *	x,
		void *	params,
		gsl_vector *	f
	)			[static, protected]

static int gumbelDistributionFitterfdf_	(	const gsl_vector *	x,
		void *	params,
		gsl_vector *	f,
		gsl_matrix *	J
	)			[static, protected]

GumbelDistributionFitter& operator=

(

const GumbelDistributionFitter &

rhs

)

[private]

assignment operator (not implemented)

void printState_	(	size_t	iter,
		gsl_multifit_fdfsolver *	s
	)			[protected]

void setInitialParameters

(

const GumbelDistributionFitResult &

result

)

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

---

Member Data Documentation

String gnuplot_formula_ [protected]

GumbelDistributionFitResult init_param_ [protected]