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

BaseModel Class Template Reference
[FeatureFinder]

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

Inheritance diagram for BaseModel:

FactoryProduct DefaultParamHandler ProductModel

List of all members.


Detailed Description

template<UInt D>
class OpenMS::BaseModel< D >

Abstract base class for all D-dimensional models.

Every derived class has to implement the static functions "T* create()" and "const String getProductName()" (see FactoryProduct for details)

Public Types

typedef int Flag
typedef std::vector< FlagFlags
typedef DPeak< D >::IntensityType IntensityType
typedef DPeak< D >::CoordinateType CoordinateType
typedef DPosition< D > PositionType
typedef DPeak< D > PeakType
typedef DPeakArray< DPeak< D > > SamplesType

Public Member Functions

 BaseModel ()
 Default constructor.
 BaseModel (const BaseModel &source)
 copy constructor
virtual ~BaseModel ()
 Destructor.
virtual BaseModeloperator= (const BaseModel &source)
 assignment operator
virtual IntensityType getIntensity (const PositionType &pos) const =0
 acess model predicted intensity at position pos
virtual bool isContained (const PositionType &pos) const
 check if position pos is part of the model regarding the models cut-off.
virtual void fillIntensity (PeakType &peak) const
 set DPeaks intensity to model predicted intensity.
template<class PeakIterator>
void fillIntensities (PeakIterator beg, PeakIterator end) const
virtual IntensityType getCutOff () const
 get cutoff value
virtual void setCutOff (IntensityType cut_off)
 set cutoff value
virtual void getSamples (SamplesType &cont) const =0
 get reasonable set of samples from the model (i.e. for printing)
virtual void getSamples (std::ostream &os)
 fill stream with reasonable set of samples from the model (i.e. for printing)
template<>
void registerChildren ()

Static Public Member Functions

static void registerChildren ()
 register all derived classes here

Protected Member Functions

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

Protected Attributes

IntensityType cut_off_


Member Typedef Documentation

typedef int Flag

typedef std::vector<Flag> Flags

typedef DPeak<D>::IntensityType IntensityType

Reimplemented in ExtendedIsotopeModel, InterpolationModel, IsotopeModel, LmaIsotopeModel, ProductModel, and ProductModel< 2 >.

typedef DPeak<D>::CoordinateType CoordinateType

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

typedef DPosition<D> PositionType

Reimplemented in InterpolationModel, ProductModel, and ProductModel< 2 >.

typedef DPeak<D> PeakType

typedef DPeakArray<DPeak<D> > SamplesType

Reimplemented in InterpolationModel, ProductModel, and ProductModel< 2 >.


Constructor & Destructor Documentation

BaseModel (  )  [inline]

Default constructor.

BaseModel ( const BaseModel< D > &  source  )  [inline]

copy constructor

virtual ~BaseModel (  )  [inline, virtual]

Destructor.


Member Function Documentation

virtual BaseModel& operator= ( const BaseModel< D > &  source  )  [inline, virtual]

assignment operator

static void registerChildren (  )  [static]

register all derived classes here

virtual IntensityType getIntensity ( const PositionType pos  )  const [pure virtual]

acess model predicted intensity at position pos

Implemented in ProductModel, and ProductModel< 2 >.

virtual bool isContained ( const PositionType pos  )  const [inline, virtual]

check if position pos is part of the model regarding the models cut-off.

virtual void fillIntensity ( PeakType peak  )  const [inline, virtual]

set DPeaks intensity to model predicted intensity.

void fillIntensities ( PeakIterator  beg,
PeakIterator  end 
) const [inline]

virtual IntensityType getCutOff (  )  const [inline, virtual]

get cutoff value

virtual void setCutOff ( IntensityType  cut_off  )  [inline, virtual]

set cutoff value

virtual void getSamples ( SamplesType cont  )  const [pure virtual]

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

Implemented in InterpolationModel, ProductModel, and ProductModel< 2 >.

virtual void getSamples ( std::ostream &  os  )  [inline, virtual]

fill stream with reasonable set of samples from the model (i.e. for printing)

virtual 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 DefaultParamHandler.

Reimplemented in BiGaussModel, EmgModel, ExtendedIsotopeModel, GaussModel, InterpolationModel, IsotopeModel, LmaGaussModel, LmaIsotopeModel, ProductModel, and ProductModel< 2 >.

void registerChildren (  )  [inline]


Member Data Documentation

IntensityType cut_off_ [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