| OpenMS 2.5.0

Public Member Functions | Protected Member Functions | List of all members
MaxLikeliFitter1D Class Reference

Abstract base class for all 1D-model fitters using maximum likelihood optimization. More...

`#include <OpenMS/TRANSFORMATIONS/FEATUREFINDER/MaxLikeliFitter1D.h>`

Inheritance diagram for MaxLikeliFitter1D:

## Public Member Functions

| MaxLikeliFitter1D ()
| default constructor More...
| MaxLikeliFitter1D (const MaxLikeliFitter1D &source)
| copy constructor More...
| ~MaxLikeliFitter1D () override
| destructor More...
virtual MaxLikeliFitter1D & | operator= (const MaxLikeliFitter1D &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...
virtual Fitter1D & | operator= (const Fitter1D &source)
| assignment operator More...
virtual QualityType | fit1d (const RawDataArrayType &, 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...
virtual DefaultParamHandler & | operator= (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 Param & | getParameters () const
| Non-mutable access to the parameters. More...
const Param & | getDefaults () const
| Non-mutable access to the default parameters. More...
const String & | getName () 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

QualityType | fitOffset_ (InterpolationModel *model, const RawDataArrayType &set, const CoordinateType stdev1, const CoordinateType stdev2, const CoordinateType offset_step)
| fit an offset on the basis of the Pearson correlation coefficient 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...

## Additional Inherited Members

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< PeakType > | RawDataArrayType
| 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 Types inherited from FeatureFinderDefs
enum | Flag { UNUSED, USED }
| Flags that indicate if a peak is already used in a feature. More...
typedef IsotopeCluster::IndexPair | IndexPair
| Index to peak consisting of two UInts (scan index / peak index) More...
typedef IsotopeCluster::ChargedIndexSet | ChargedIndexSet
| Index to peak consisting of two UInts (scan index / peak index) with charge information. More...
typedef IsotopeCluster::IndexSet | IndexSet
| A set of peak indices. More...
Static Public Member Functions inherited from Fitter1D
static void | registerChildren ()
| register all derived classes here 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< String > | subsections_
| 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...

## Detailed Description

Abstract base class for all 1D-model fitters using maximum likelihood optimization.

## Constructor & Destructor Documentation

## ◆ MaxLikeliFitter1D() [1/2]

MaxLikeliFitter1D | ( |  | ) |

inline

default constructor

## ◆ MaxLikeliFitter1D() [2/2]

MaxLikeliFitter1D | ( | const MaxLikeliFitter1D & | source | ) |

inline

copy constructor

## ◆ ~MaxLikeliFitter1D()

~MaxLikeliFitter1D | ( |  | ) |

inline override

destructor

## Member Function Documentation

## ◆ fitOffset_()

QualityType fitOffset_ | ( | InterpolationModel * | model,
|  | const RawDataArrayType & | set,
|  | const CoordinateType | stdev1,
|  | const CoordinateType | stdev2,
|  | const CoordinateType | offset_step
| ) |  |

inline protected

fit an offset on the basis of the Pearson correlation coefficient

References InterpolationModel::getIntensity(), InterpolationModel::getInterpolation(), LinearInterpolation< Key, Value >::getOffset(), OpenMS::Math::pearsonCorrelationCoefficient(), InterpolationModel::setOffset(), and LinearInterpolation< Key, Value >::supportMin().

## ◆ operator=()

virtual MaxLikeliFitter1D& operator= | ( | const MaxLikeliFitter1D & | source | ) |

inline virtual

assignment operator

References Fitter1D::operator=().

## ◆ updateMembers_()

void updateMembers_ | ( |  | ) |

inline override protected virtual

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.

References Fitter1D::updateMembers_().