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

InterpolationModel Class Reference
[FeatureFinder]

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

Inheritance diagram for InterpolationModel:

BaseModel< 1 > FactoryProduct DefaultParamHandler BiGaussModel EmgModel ExtendedIsotopeModel GaussModel IsotopeModel LmaGaussModel LmaIsotopeModel

List of all members.


Detailed Description

Abstract class for 1D-models that are approximated using linear interpolation.

Model wrapping LinearInterpolation for speed-up in calculation of predicted intensities Derived classes have to implement setSamples()

Parameters:
interpolation_step step size used to interpolate model
intensity_scaling factor used to scale the calculated intensities

Public Types

typedef DPeak< 1 >::IntensityType IntensityType
typedef DPosition< 1 > PositionType
typedef
PositionType::CoordinateType 
CoordinateType
typedef
Math::LinearInterpolation
< CoordinateType,
IntensityType
LinearInterpolation
typedef
LinearInterpolation::container_type 
ContainerType
typedef DPeakArray< DPeak< 1 > > SamplesType

Public Member Functions

 InterpolationModel ()
 Default constructor.
 InterpolationModel (const InterpolationModel &source)
 copy constructor
virtual ~InterpolationModel ()
 destructor
virtual InterpolationModeloperator= (const InterpolationModel &source)
 assignment operator
IntensityType getIntensity (const PositionType &pos) const
 access model predicted intensity at position pos
IntensityType getIntensity (CoordinateType coord) const
 access model predicted intensity at position pos
const LinearInterpolationgetInterpolation () const
 Returns the interpolation class.
CoordinateType getScalingFactor () const
 get the scaling for the model
virtual void setOffset (CoordinateType offset)
 set the offset of the model
void getSamples (SamplesType &cont) const
 get reasonable set of samples from the model (i.e. for printing)
virtual CoordinateType getCenter () const =0
 "center" of the model, particular definition (depends on the derived model)
virtual void setSamples ()=0
 set sample/supporting points of interpolation wrt params.
void setInterpolationStep (CoordinateType interpolation_step)
 Set the interpolation step for the linear interpolation of the model.
void setScalingFactor (CoordinateType scaling)

Protected Member Functions

void updateMembers_ ()
 This method is used to update extra member variables at the end of the setParam() method.

Protected Attributes

LinearInterpolation interpolation_
CoordinateType interpolation_step_
CoordinateType scaling_


Member Typedef Documentation

typedef DPeak<1>::IntensityType IntensityType

Reimplemented from BaseModel< 1 >.

Reimplemented in ExtendedIsotopeModel, IsotopeModel, and LmaIsotopeModel.

typedef DPosition<1> PositionType

Reimplemented from BaseModel< 1 >.

typedef PositionType::CoordinateType CoordinateType

Reimplemented from BaseModel< 1 >.

Reimplemented in BiGaussModel, EmgModel, ExtendedIsotopeModel, GaussModel, IsotopeModel, LmaGaussModel, and LmaIsotopeModel.

typedef Math::LinearInterpolation<CoordinateType,IntensityType> LinearInterpolation

typedef LinearInterpolation::container_type ContainerType

typedef DPeakArray<DPeak<1> > SamplesType

Reimplemented from BaseModel< 1 >.


Constructor & Destructor Documentation

InterpolationModel (  )  [inline]

Default constructor.

InterpolationModel ( const InterpolationModel source  )  [inline]

copy constructor

virtual ~InterpolationModel (  )  [inline, virtual]

destructor


Member Function Documentation

virtual InterpolationModel& operator= ( const InterpolationModel source  )  [inline, virtual]

assignment operator

IntensityType getIntensity ( const PositionType pos  )  const [inline]

access model predicted intensity at position pos

IntensityType getIntensity ( CoordinateType  coord  )  const [inline]

access model predicted intensity at position pos

const LinearInterpolation& getInterpolation (  )  const [inline]

Returns the interpolation class.

CoordinateType getScalingFactor (  )  const [inline]

get the scaling for the model

A scaling factor of scaling means that the area under the model equals scaling. Default is 1.

virtual void setOffset ( CoordinateType  offset  )  [inline, virtual]

set the offset of the model

The whole model will be shifted to the new offset without being recomputed all over. Setting takes affect immediately.

void getSamples ( SamplesType cont  )  const [inline, virtual]

get reasonable set of samples from the model (i.e. for printing)

Implements BaseModel< 1 >.

virtual CoordinateType getCenter (  )  const [pure virtual]

"center" of the model, particular definition (depends on the derived model)

Implemented in BiGaussModel, EmgModel, ExtendedIsotopeModel, GaussModel, IsotopeModel, LmaGaussModel, and LmaIsotopeModel.

virtual void setSamples (  )  [pure virtual]

set sample/supporting points of interpolation wrt params.

Implemented in BiGaussModel, EmgModel, ExtendedIsotopeModel, GaussModel, IsotopeModel, LmaGaussModel, and LmaIsotopeModel.

void setInterpolationStep ( CoordinateType  interpolation_step  )  [inline]

Set the interpolation step for the linear interpolation of the model.

For setting to take affect, call setSamples().

void setScalingFactor ( CoordinateType  scaling  )  [inline]

void updateMembers_ (  )  [inline, 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 BaseModel< 1 >.

Reimplemented in BiGaussModel, EmgModel, ExtendedIsotopeModel, GaussModel, IsotopeModel, LmaGaussModel, and LmaIsotopeModel.


Member Data Documentation

LinearInterpolation interpolation_ [protected]

CoordinateType interpolation_step_ [protected]

CoordinateType scaling_ [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