Abstract base class for all 1D-dimensional model fitter. More...
#include <OpenMS/TRANSFORMATIONS/FEATUREFINDER/Fitter1D.h>
Public Types | |
| typedef IsotopeCluster::IndexSet | IndexSet |
| IndexSet. | |
| typedef IsotopeCluster::ChargedIndexSet | ChargedIndexSet |
| IndexSet with charge information. | |
| typedef Feature::CoordinateType | CoordinateType |
| Single coordinate. | |
| typedef Feature::QualityType | QualityType |
| Quality of a feature. | |
| typedef Peak1D | PeakType |
| Raw data point type. | |
| typedef std::vector< PeakType > | RawDataArrayType |
| Raw data container type using for the temporary storage of the input data. | |
| typedef RawDataArrayType::iterator | PeakIterator |
| Raw data iterator. | |
Public Member Functions | |
| Fitter1D () | |
| Default constructor. | |
| Fitter1D (const Fitter1D &source) | |
| copy constructor | |
| virtual | ~Fitter1D () |
| destructor | |
| virtual Fitter1D & | operator= (const Fitter1D &source) |
| assignment operator | |
| virtual QualityType | fit1d (const RawDataArrayType &, InterpolationModel *&) |
| return interpolation model | |
Static Public Member Functions | |
| static void | registerChildren () |
| register all derived classes here | |
Protected Member Functions | |
| virtual void | updateMembers_ () |
Protected Attributes | |
| CoordinateType | tolerance_stdev_box_ |
| standard derivation in bounding box | |
| CoordinateType | min_ |
| minimum of the bounding box | |
| CoordinateType | max_ |
| maximum of the bounding box | |
| CoordinateType | stdev1_ |
| standard derivation | |
| CoordinateType | stdev2_ |
| standard derivation | |
| Math::BasicStatistics | statistics_ |
| basic statistics | |
| CoordinateType | interpolation_step_ |
| interpolation step size | |
Detailed Description
Abstract base class for all 1D-dimensional model fitter.
Every derived class has to implement the static functions "T* create()" and "const String getProductName()" (see DefaultParamHandler for details)
Parameters of this class are:| Name | Type | Default | Restrictions | Description |
|---|---|---|---|---|
| interpolation_step | float | 0.2 | Sampling rate for the interpolation of the model function. | |
| tolerance_stdev_bounding_box | float | 3 | Bounding box has range [minimim of data, maximum of data] enlarged by tolerance_stdev_bounding_box times the standard deviation of the data. | |
| statistics:mean | float | 1 | Centroid position of the model. | |
| statistics:variance | float | 1 | The variance of the model. |
Note:
- If a section name is documented, the documentation is displayed as tooltip.
- Advanced parameter names are italic.
Member Typedef Documentation
IndexSet with charge information.
Reimplemented from FeatureFinderDefs.
Single coordinate.
| typedef IsotopeCluster::IndexSet IndexSet |
IndexSet.
Reimplemented from FeatureFinderDefs.
| typedef RawDataArrayType::iterator PeakIterator |
Raw data iterator.
| typedef Feature::QualityType QualityType |
Quality of a feature.
| typedef std::vector<PeakType> RawDataArrayType |
Raw data container type using for the temporary storage of the input data.
Constructor & Destructor Documentation
| Fitter1D | ( | ) |
Default constructor.
| virtual ~Fitter1D | ( | ) | [inline, virtual] |
destructor
Member Function Documentation
| virtual QualityType fit1d | ( | const RawDataArrayType & | , | |
| InterpolationModel *& | ||||
| ) | [inline, virtual] |
return interpolation model
Reimplemented in EGHFitter1D, BiGaussFitter1D, EmgFitter1D, ExtendedIsotopeFitter1D, GaussFitter1D, IsotopeFitter1D, LmaGaussFitter1D, and LmaIsotopeFitter1D.
Referenced by ModelFitter< PeakType, FeatureType >::fitMZ_(), and ModelFitter< PeakType, FeatureType >::fitRT_().
assignment operator
Referenced by MaxLikeliFitter1D::operator=(), and LevMarqFitter1D::operator=().
| static void registerChildren | ( | ) | [static] |
register all derived classes here
| virtual void updateMembers_ | ( | ) | [protected, virtual] |
Reimplemented in EGHFitter1D, BiGaussFitter1D, EmgFitter1D, ExtendedIsotopeFitter1D, GaussFitter1D, IsotopeFitter1D, LevMarqFitter1D, LmaGaussFitter1D, LmaIsotopeFitter1D, and MaxLikeliFitter1D.
Referenced by MaxLikeliFitter1D::updateMembers_(), and LevMarqFitter1D::updateMembers_().
Member Data Documentation
CoordinateType interpolation_step_ [protected] |
interpolation step size
CoordinateType max_ [protected] |
maximum of the bounding box
CoordinateType min_ [protected] |
minimum of the bounding box
Math::BasicStatistics statistics_ [protected] |
basic statistics
CoordinateType stdev1_ [protected] |
standard derivation
CoordinateType stdev2_ [protected] |
standard derivation
CoordinateType tolerance_stdev_box_ [protected] |
standard derivation in bounding box
| OpenMS / TOPP release 1.10.0 | Documentation generated on Thu Mar 7 2013 09:42:57 using doxygen 1.7.1 |