Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes

LmaGaussModel Class Reference

Normal distribution model for elution profiles. More...

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

Inheritance diagram for LmaGaussModel:
InterpolationModel BaseModel< 1 > DefaultParamHandler

List of all members.

Public Types

typedef
InterpolationModel::CoordinateType 
CoordinateType
typedef Math::BasicStatistics
< CoordinateType
BasicStatistics

Public Member Functions

 LmaGaussModel ()
 Default constructor.
 LmaGaussModel (const LmaGaussModel &source)
 copy constructor
virtual ~LmaGaussModel ()
 destructor
virtual LmaGaussModeloperator= (const LmaGaussModel &source)
 assignment operator
void setOffset (CoordinateType offset)
 set offset without being computing all over and without any discrepancy
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 EmgModel 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_
CoordinateType scale_factor_
CoordinateType standard_deviation_
CoordinateType expected_value_

Detailed Description

Normal distribution model for elution profiles.

To be used in combination with the Levenberg-Marquardt algorithm fitting algorithm.

Parameters of this class are:

NameTypeDefaultRestrictionsDescription
cutoff float0  Low intensity cutoff of the model. Peaks below this intensity are not considered part of the model.
interpolation_step float0.1  Sampling rate for the interpolation of the model function
intensity_scaling float1  Scaling factor used to adjust the model distribution to the intensities of the data
bounding_box:min float0  Lower end of bounding box enclosing the data used to fit the model.
bounding_box:max float1  Upper end of bounding box enclosing the data used to fit the model.
statistics:mean float0  Centroid position of the model.
statistics:variance float1  The variance of the model.
lma:scale_factor float1000000  Scale factor for the intensity of the model.
lma:standard_deviation float5  The standard deviation (variance) of the model.
lma:expected_value float1200  The expected value (centroid position) of the model.

Note:

Member Typedef Documentation


Constructor & Destructor Documentation

LmaGaussModel (  ) 

Default constructor.

LmaGaussModel ( const LmaGaussModel source  ) 

copy constructor

virtual ~LmaGaussModel (  )  [virtual]

destructor


Member Function Documentation

static BaseModel<1>* create (  )  [inline, static]

create new EmgModel 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 LmaGaussModel& operator= ( const LmaGaussModel source  )  [virtual]

assignment operator

void setOffset ( CoordinateType  offset  )  [virtual]

set offset without being computing all over and without any discrepancy

Reimplemented from InterpolationModel.

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]

OpenMS / TOPP release 1.10.0 Documentation generated on Thu Mar 7 2013 09:42:57 using doxygen 1.7.1