OpenMS
LevMarqFitter1D Class Reference

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

#include <OpenMS/FEATUREFINDER/LevMarqFitter1D.h>

Inheritance diagram for LevMarqFitter1D:
[legend]
Collaboration diagram for LevMarqFitter1D:
[legend]

Classes

class  GenericFunctor
 

Public Types

typedef std::vector< double > ContainerType
 
- Public Types inherited from Fitter1D
typedef IsotopeCluster::IndexSet IndexSet
 IndexSet. More...
 
typedef IsotopeCluster::ChargedIndexSet ChargedIndexSet
 IndexSet with charge information. More...
 
typedef Feature::CoordinateType CoordinateType
 Single coordinate. More...
 
typedef Feature::QualityType QualityType
 Quality of a feature. More...
 
typedef Peak1D PeakType
 Peak type data point type. More...
 
typedef std::vector< PeakTypeRawDataArrayType
 Peak type data container type using for the temporary storage of the input data. More...
 
typedef RawDataArrayType::iterator PeakIterator
 Peak type data iterator. More...
 

Public Member Functions

 LevMarqFitter1D ()
 Default constructor. More...
 
 LevMarqFitter1D (const LevMarqFitter1D &source)
 copy constructor More...
 
 ~LevMarqFitter1D () override
 destructor More...
 
LevMarqFitter1Doperator= (const LevMarqFitter1D &source)
 assignment operator More...
 
- Public Member Functions inherited from Fitter1D
 Fitter1D ()
 Default constructor. More...
 
 Fitter1D (const Fitter1D &source)
 copy constructor More...
 
 ~Fitter1D () override
 destructor More...
 
Fitter1Doperator= (const Fitter1D &source)
 assignment operator More...
 
virtual QualityType fit1d (const RawDataArrayType &, std::unique_ptr< InterpolationModel > &)
 return interpolation model More...
 
- Public Member Functions inherited from DefaultParamHandler
 DefaultParamHandler (const String &name)
 Constructor with name that is displayed in error messages. More...
 
 DefaultParamHandler (const DefaultParamHandler &rhs)
 Copy constructor. More...
 
virtual ~DefaultParamHandler ()
 Destructor. More...
 
DefaultParamHandleroperator= (const DefaultParamHandler &rhs)
 Assignment operator. More...
 
virtual bool operator== (const DefaultParamHandler &rhs) const
 Equality operator. More...
 
void setParameters (const Param &param)
 Sets the parameters. More...
 
const ParamgetParameters () const
 Non-mutable access to the parameters. More...
 
const ParamgetDefaults () const
 Non-mutable access to the default parameters. More...
 
const StringgetName () const
 Non-mutable access to the name. More...
 
void setName (const String &name)
 Mutable access to the name. More...
 
const std::vector< String > & getSubsections () const
 Non-mutable access to the registered subsections. More...
 

Protected Member Functions

void optimize_ (Eigen::VectorXd &x_init, GenericFunctor &functor) const
 Optimize start parameter. More...
 
void updateMembers_ () override
 This method is used to update extra member variables at the end of the setParameters() method. More...
 
- Protected Member Functions inherited from DefaultParamHandler
void defaultsToParam_ ()
 Updates the parameters after the defaults have been set in the constructor. More...
 

Protected Attributes

bool symmetric_
 Parameter indicates symmetric peaks. More...
 
Int max_iteration_
 Maximum number of iterations. More...
 
- Protected Attributes inherited from Fitter1D
CoordinateType tolerance_stdev_box_
 standard derivation in bounding box More...
 
Math::BasicStatistics statistics_
 basic statistics More...
 
CoordinateType interpolation_step_
 interpolation step size More...
 
- Protected Attributes inherited from DefaultParamHandler
Param param_
 Container for current parameters. More...
 
Param defaults_
 Container for default parameters. This member should be filled in the constructor of derived classes! More...
 
std::vector< Stringsubsections_
 Container for registered subsections. This member should be filled in the constructor of derived classes! More...
 
String error_name_
 Name that is displayed in error messages during the parameter checking. More...
 
bool check_defaults_
 If this member is set to false no checking if parameters in done;. More...
 
bool warn_empty_defaults_
 If this member is set to false no warning is emitted when defaults are empty;. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from DefaultParamHandler
static void writeParametersToMetaValues (const Param &write_this, MetaInfoInterface &write_here, const String &key_prefix="")
 Writes all parameters to meta values. More...
 

Detailed Description

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

Member Typedef Documentation

◆ ContainerType

typedef std::vector<double> ContainerType

Constructor & Destructor Documentation

◆ LevMarqFitter1D() [1/2]

LevMarqFitter1D ( )
inline

Default constructor.

◆ LevMarqFitter1D() [2/2]

LevMarqFitter1D ( const LevMarqFitter1D source)
inline

copy constructor

◆ ~LevMarqFitter1D()

~LevMarqFitter1D ( )
inlineoverride

destructor

Member Function Documentation

◆ operator=()

LevMarqFitter1D& operator= ( const LevMarqFitter1D source)
inline

assignment operator

References LevMarqFitter1D::max_iteration_, and Fitter1D::operator=().

◆ optimize_()

void optimize_ ( Eigen::VectorXd x_init,
GenericFunctor functor 
) const
protected

Optimize start parameter.

Exceptions
Exception::UnableToFitis thrown if fitting cannot be performed

◆ updateMembers_()

void updateMembers_ ( )
overrideprotectedvirtual

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

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

The default implementation is empty.

Reimplemented from Fitter1D.

Member Data Documentation

◆ max_iteration_

Int max_iteration_
protected

Maximum number of iterations.

Referenced by LevMarqFitter1D::operator=().

◆ symmetric_

bool symmetric_
protected

Parameter indicates symmetric peaks.