Normal distribution approximated using linear interpolation. More...
#include <OpenMS/TRANSFORMATIONS/FEATUREFINDER/GaussModel.h>
Public Types | |
| typedef InterpolationModel::CoordinateType | CoordinateType |
| typedef Math::BasicStatistics < CoordinateType > | BasicStatistics |
| typedef InterpolationModel | InterpolationModel |
Public Member Functions | |
| GaussModel () | |
| Default constructor. | |
| GaussModel (const GaussModel &source) | |
| copy constructor | |
| virtual | ~GaussModel () |
| destructor | |
| virtual GaussModel & | operator= (const GaussModel &source) |
| assignment operator | |
| void | setOffset (CoordinateType offset) |
| set the offset of the model | |
| void | setSamples () |
| set sample/supporting points of interpolation | |
| CoordinateType | getCenter () const |
| get the center of the Gaussian model i.e. the position of the maximum | |
Static Public Member Functions | |
| static BaseModel< 1 > * | create () |
| create new GaussModel object (needed by Factory) | |
| static const String | getProductName () |
| name of the model (needed by Factory) | |
Protected Member Functions | |
| void | updateMembers_ () |
| This method is used to update extra member variables at the end of the setParameters() method. | |
Protected Attributes | |
| CoordinateType | min_ |
| CoordinateType | max_ |
| BasicStatistics | statistics_ |
Detailed Description
Normal distribution approximated using linear interpolation.
Parameters of this class are:| Name | Type | Default | Restrictions | Description |
|---|---|---|---|---|
| cutoff | float | 0 | Low intensity cutoff of the model. Peaks below this intensity are not considered part of the model. | |
| interpolation_step | float | 0.1 | Sampling rate for the interpolation of the model function | |
| intensity_scaling | float | 1 | Scaling factor used to adjust the model distribution to the intensities of the data | |
| bounding_box:min | float | 0 | Lower end of bounding box enclosing the data used to fit the model. | |
| bounding_box:max | float | 1 | Upper end of bounding box enclosing the data used to fit the model. | |
| statistics:mean | float | 0 | Centroid position of the model (Gaussian). | |
| statistics:variance | float | 1 | The variance of the Gaussian. |
Note:
- If a section name is documented, the documentation is displayed as tooltip.
- Advanced parameter names are italic.
Member Typedef Documentation
Reimplemented from InterpolationModel.
| typedef InterpolationModel InterpolationModel |
Constructor & Destructor Documentation
| GaussModel | ( | ) |
Default constructor.
| GaussModel | ( | const GaussModel & | source | ) |
copy constructor
| virtual ~GaussModel | ( | ) | [virtual] |
destructor
Member Function Documentation
| static BaseModel<1>* create | ( | ) | [inline, static] |
create new GaussModel object (needed by Factory)
| CoordinateType getCenter | ( | ) | const [virtual] |
get the center of the Gaussian model i.e. the position of the maximum
Reimplemented from InterpolationModel.
| static const String getProductName | ( | ) | [inline, static] |
name of the model (needed by Factory)
Referenced by BaseModel< D >::registerChildren().
| virtual GaussModel& operator= | ( | const GaussModel & | source | ) | [virtual] |
assignment operator
| void setOffset | ( | CoordinateType | offset | ) |
set the offset of the model
The whole model will be shifted to the new offset without being computing all over. and without any discrepancy.
| void setSamples | ( | ) | [virtual] |
set sample/supporting points of interpolation
Reimplemented from InterpolationModel.
| void updateMembers_ | ( | ) | [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 InterpolationModel.
Member Data Documentation
CoordinateType max_ [protected] |
CoordinateType min_ [protected] |
BasicStatistics statistics_ [protected] |
| OpenMS / TOPP release 1.10.0 | Documentation generated on Thu Mar 7 2013 09:42:57 using doxygen 1.7.1 |