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

ProductModel Class Template Reference
[FeatureFinder]

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

Inheritance diagram for ProductModel:

BaseModel FactoryProduct DefaultParamHandler

List of all members.


Detailed Description

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

Class for product models i.e. models with D independent dimensions.

The predicted intensity is simply the product of the intensities in each dimension

ProductModel Parameters are explained on a separate page.

Public Types

typedef DPeak< D >::IntensityType IntensityType
typedef DPosition< D > PositionType
typedef DPeakArray< DPeak< D > > SamplesType

Public Member Functions

 ProductModel ()
 Default constructor.
 ProductModel (const ProductModel &source)
 copy constructor
virtual ~ProductModel ()
 destructor
virtual ProductModeloperator= (const ProductModel &source)
 assignment operator
IntensityType getIntensity (const PositionType &pos) const
 intensity equals product of intensities in each dimension
ProductModelsetModel (UInt dim, BaseModel< 1 > *dist)
 set model dist for dimension dim
BaseModel< 1 > * getModel (UInt dim) const
IntensityType getScale () const
 return the intensity scaling factor
void setScale (IntensityType scale)
 set the intensity scaling factor
void getSamples (SamplesType &cont) const
 get reasonable set of samples from the model (i.e. for printing)

Static Public Member Functions

static BaseModel< D > * create ()
 create new ProductModel object (needed by Factory)
static const String getProductName ()
 Returns the name of the model.

Protected Member Functions

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

Protected Attributes

std::vector< BaseModel< 1 > * > distributions_
IntensityType scale_


Member Typedef Documentation

typedef DPeak<D>::IntensityType IntensityType

Reimplemented from BaseModel.

typedef DPosition<D> PositionType

Reimplemented from BaseModel.

typedef DPeakArray<DPeak<D> > SamplesType

Reimplemented from BaseModel.


Constructor & Destructor Documentation

ProductModel (  )  [inline]

Default constructor.

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

copy constructor

virtual ~ProductModel (  )  [inline, virtual]

destructor


Member Function Documentation

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

assignment operator

IntensityType getIntensity ( const PositionType pos  )  const [inline, virtual]

intensity equals product of intensities in each dimension

Implements BaseModel.

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

create new ProductModel object (needed by Factory)

static const String getProductName (  )  [inline, static]

Returns the name of the model.

ProductModel& setModel ( UInt  dim,
BaseModel< 1 > *  dist 
) [inline]

set model dist for dimension dim

dist is supposed to be allocated by new because it will be freed if ProductModel is destroyed or the model for that dimensions changes. For that reason no model dist should be assigned to multiple ProductModels.
ProductModel parameters are set when calling ProductModel::getParameters().

BaseModel<1>* getModel ( UInt  dim  )  const [inline]

IntensityType getScale (  )  const [inline]

return the intensity scaling factor

void setScale ( IntensityType  scale  )  [inline]

set the intensity scaling factor

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

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

Implements BaseModel.

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.


Member Data Documentation

std::vector< BaseModel<1>* > distributions_ [protected]

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