Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

LevMarqFitter1D Class Reference
[FeatureFinder]

#include <OpenMS/TRANSFORMATIONS/FEATUREFINDER/LevMarqFitter1D.h>

Inheritance diagram for LevMarqFitter1D:

Fitter1D FactoryProduct FeatureFinderDefs DefaultParamHandler EmgFitter1D LmaGaussFitter1D LmaIsotopeFitter1D

List of all members.


Detailed Description

Abstract class for 1D-model fitter using Levenberg-Marquardt algorithm for parameter optimization.

Public Types

typedef std::vector< double > ContainerType

Public Member Functions

 LevMarqFitter1D ()
 Default constructor.
 LevMarqFitter1D (const LevMarqFitter1D &source)
 copy constructor
virtual ~LevMarqFitter1D ()
 destructor
virtual LevMarqFitter1Doperator= (const LevMarqFitter1D &source)
 assignment operator

Protected Member Functions

virtual void printState_ (Int iter, gsl_multifit_fdfsolver *s)=0
const String getGslStatus_ ()
 Return GSL status as string.
void optimize_ (const RawDataArrayType &set, Int num_params, CoordinateType x_init[], Int(*residual)(const gsl_vector *x, void *params, gsl_vector *f), Int(*jacobian)(const gsl_vector *x, void *params, gsl_matrix *J), Int(*evaluate)(const gsl_vector *x, void *params, gsl_vector *f, gsl_matrix *J), void *advanced_params)
 Optimize start parameter.
void updateMembers_ ()
 This method is used to update extra member variables at the end of the setParam() method.

Protected Attributes

Int gsl_status_
 GSL status.
bool symmetric_
 Parameter indicates symmetric peaks.
Int max_iteration_
 Maximum number of iterations.
CoordinateType abs_error_
 Absolute error.
CoordinateType rel_error_
 Relative error.
Math::BasicStatistics< Realstat_
 Statistic needed by pearson correlation coefficient.

Member Typedef Documentation

typedef std::vector< double > ContainerType


Constructor & Destructor Documentation

LevMarqFitter1D (  )  [inline]

Default constructor.

LevMarqFitter1D ( const LevMarqFitter1D source  )  [inline]

copy constructor

virtual ~LevMarqFitter1D (  )  [inline, virtual]

destructor


Member Function Documentation

virtual LevMarqFitter1D& operator= ( const LevMarqFitter1D source  )  [inline, virtual]

assignment operator

virtual void printState_ ( Int  iter,
gsl_multifit_fdfsolver *  s 
) [protected, pure virtual]

Diplay the intermediate state of the solution. The solver state contains the vector s->x which is the current position, and the vector s->f with corresponding function values

Implemented in EmgFitter1D, LmaGaussFitter1D, and LmaIsotopeFitter1D.

const String getGslStatus_ (  )  [inline, protected]

Return GSL status as string.

void optimize_ ( const RawDataArrayType set,
Int  num_params,
CoordinateType  x_init[],
Int(*)(const gsl_vector *x, void *params, gsl_vector *f)  residual,
Int(*)(const gsl_vector *x, void *params, gsl_matrix *J)  jacobian,
Int(*)(const gsl_vector *x, void *params, gsl_vector *f, gsl_matrix *J)  evaluate,
void *  advanced_params 
) [inline, protected]

Optimize start parameter.

void updateMembers_ (  )  [inline, protected, virtual]

This method is used to update extra member variables at the end of the setParam() method.

Also call it at the end of the derived classes' copy constructor and assignment operator.

The default implementation is empty.

Reimplemented from Fitter1D.

Reimplemented in EmgFitter1D, LmaGaussFitter1D, and LmaIsotopeFitter1D.


Member Data Documentation

Int gsl_status_ [protected]

GSL status.

bool symmetric_ [protected]

Parameter indicates symmetric peaks.

Int max_iteration_ [protected]

Maximum number of iterations.

CoordinateType abs_error_ [protected]

Absolute error.

Test for the convergence of the sequence by comparing the last iteration step dx with the absolute error epsabs and relative error epsrel to the current position x

CoordinateType rel_error_ [protected]

Relative error.

Math::BasicStatistics<Real> stat_ [protected]

Statistic needed by pearson correlation coefficient.


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:47 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1