Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

ExtendedIsotopeModel Class Reference
[FeatureFinder]

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

Inheritance diagram for ExtendedIsotopeModel:

InterpolationModel BaseModel< 1 > FactoryProduct DefaultParamHandler

List of all members.


Detailed Description

Extended isotope distribution approximated using linear interpolation.

ExtendedIsotopeModel Parameters are explained on a separate page.

Public Types

enum  Averagines {
  C = 0, H, N, O,
  S, AVERAGINE_NUM
}
typedef
InterpolationModel::CoordinateType 
CoordinateType
typedef
InterpolationModel::CoordinateType 
IntensityType

Public Member Functions

 ExtendedIsotopeModel ()
 Default constructor.
 ExtendedIsotopeModel (const ExtendedIsotopeModel &source)
 copy constructor
virtual ~ExtendedIsotopeModel ()
 destructor
virtual ExtendedIsotopeModeloperator= (const ExtendedIsotopeModel &source)
 assignment operator
UInt getCharge ()
void setOffset (CoordinateType offset)
 set the offset of the model
CoordinateType getOffset ()
void setSamples ()
 set sample/supporting points of interpolation
CoordinateType getCenter () const
 get the monoisotopic mass of the Isotope model

Static Public Member Functions

static BaseModel< 1 > * create ()
 create new ExtendedIsotopeModel 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 setParam() method.

Protected Attributes

CoordinateType isotope_stdev_
UInt charge_
CoordinateType monoisotopic_mz_
DoubleReal averagine_ [AVERAGINE_NUM]
Int max_isotope_
DoubleReal trim_right_cutoff_
DoubleReal isotope_distance_


Member Typedef Documentation

typedef InterpolationModel::CoordinateType CoordinateType

Reimplemented from InterpolationModel.

typedef InterpolationModel::CoordinateType IntensityType

Reimplemented from InterpolationModel.


Member Enumeration Documentation

enum Averagines

Enumerator:
C 
H 
N 
O 
S 
AVERAGINE_NUM 


Constructor & Destructor Documentation

ExtendedIsotopeModel (  ) 

Default constructor.

ExtendedIsotopeModel ( const ExtendedIsotopeModel source  ) 

copy constructor

virtual ~ExtendedIsotopeModel (  )  [virtual]

destructor


Member Function Documentation

virtual ExtendedIsotopeModel& operator= ( const ExtendedIsotopeModel source  )  [virtual]

assignment operator

UInt getCharge (  ) 

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

create new ExtendedIsotopeModel object (needed by Factory)

static const String getProductName (  )  [inline, static]

name of the model (needed by Factory)

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. This leaves a discrepancy which is minor in small shifts (i.e. shifting by one or two standard deviations) but can get significant otherwise. In that case use setParameters() which enforces a recomputation of the model.

CoordinateType getOffset (  ) 

void setSamples (  )  [virtual]

set sample/supporting points of interpolation

Implements InterpolationModel.

CoordinateType getCenter (  )  const [virtual]

get the monoisotopic mass of the Isotope model

Implements InterpolationModel.

void updateMembers_ (  )  [protected, virtual]

This method is used to update extra member variables at the end of the setParam() 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 isotope_stdev_ [protected]

UInt charge_ [protected]

CoordinateType monoisotopic_mz_ [protected]

DoubleReal averagine_[AVERAGINE_NUM] [protected]

Int max_isotope_ [protected]

DoubleReal trim_right_cutoff_ [protected]

DoubleReal isotope_distance_ [protected]


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:47 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1