Abstract base class for all D-dimensional models. More...
#include <OpenMS/TRANSFORMATIONS/FEATUREFINDER/BaseModel.h>
Public Types | |
| typedef DoubleReal | IntensityType |
| typedef DoubleReal | CoordinateType |
| typedef DPosition< D > | PositionType |
| typedef DPeak< D >::Type | PeakType |
| typedef std::vector< PeakType > | SamplesType |
Public Member Functions | |
| BaseModel () | |
| Default constructor. | |
| BaseModel (const BaseModel &source) | |
| copy constructor | |
| virtual | ~BaseModel () |
| Destructor. | |
| virtual BaseModel & | operator= (const BaseModel &source) |
| assignment operator | |
| virtual IntensityType | getIntensity (const PositionType &pos) const =0 |
access 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. | |
| template<typename PeakType > | |
| void | fillIntensity (PeakType &peak) const |
| Convenience function to set the intensity of a peak to the predicted intensity at its current position, calling virtual void getIntensity(). | |
| template<class PeakIterator > | |
| void | fillIntensities (PeakIterator begin, PeakIterator end) const |
| Convenience function that applies fillIntensity() to an iterator range. | |
| 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 () |
| template<> | |
| void | registerChildren () |
Static Public Member Functions | |
| static void | registerChildren () |
| register all derived classes here (implemented in file BaseModel_impl.h) | |
Protected Member Functions | |
| virtual void | updateMembers_ () |
| This method is used to update extra member variables at the end of the setParameters() method. | |
Protected Attributes | |
| IntensityType | cut_off_ |
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 DefaultParamHandler for details)
Member Typedef Documentation
| typedef DoubleReal CoordinateType |
Reimplemented in EGHModel, BiGaussModel, EmgModel, ExtendedIsotopeModel, GaussModel, InterpolationModel, IsotopeModel, LmaGaussModel, and LmaIsotopeModel.
| typedef DoubleReal IntensityType |
Reimplemented in ExtendedIsotopeModel, InterpolationModel, IsotopeModel, LmaIsotopeModel, and ProductModel< 2 >.
| typedef DPosition<D> PositionType |
Reimplemented in InterpolationModel, and ProductModel< 2 >.
| typedef std::vector<PeakType> SamplesType |
Reimplemented in ProductModel< 2 >.
Constructor & Destructor Documentation
| BaseModel | ( | ) | [inline] |
Default constructor.
| virtual ~BaseModel | ( | ) | [inline, virtual] |
Destructor.
Member Function Documentation
| void fillIntensities | ( | PeakIterator | begin, | |
| PeakIterator | end | |||
| ) | const [inline] |
Convenience function that applies fillIntensity() to an iterator range.
| void fillIntensity | ( | PeakType & | peak | ) | const [inline] |
Convenience function to set the intensity of a peak to the predicted intensity at its current position, calling virtual void getIntensity().
Referenced by BaseModel< 2 >::fillIntensities().
| virtual IntensityType getCutOff | ( | ) | const [inline, virtual] |
get cutoff value
| virtual IntensityType getIntensity | ( | const PositionType & | pos | ) | const [pure virtual] |
access model predicted intensity at position pos
Implemented in ProductModel< 2 >.
Referenced by BaseModel< 2 >::fillIntensity(), and BaseModel< 2 >::isContained().
| virtual void getSamples | ( | SamplesType & | cont | ) | const [pure virtual] |
get reasonable set of samples from the model (i.e. for printing)
Implemented in InterpolationModel, and ProductModel< 2 >.
Referenced by BaseModel< 2 >::getSamples().
| virtual void getSamples | ( | std::ostream & | os | ) | [inline, virtual] |
fill stream with reasonable set of samples from the model (i.e. for printing)
| virtual bool isContained | ( | const PositionType & | pos | ) | const [inline, virtual] |
check if position pos is part of the model regarding the models cut-off.
Referenced by ModelFitter< PeakType, FeatureType >::fit().
assignment operator
Referenced by BaseModel< 2 >::operator=().
| void registerChildren | ( | ) |
| static void registerChildren | ( | ) | [static] |
register all derived classes here (implemented in file BaseModel_impl.h)
| void registerChildren | ( | ) |
| virtual void setCutOff | ( | IntensityType | cut_off | ) | [inline, virtual] |
set cutoff value
Referenced by ModelFitter< PeakType, FeatureType >::fit().
| virtual void updateMembers_ | ( | ) | [inline, 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 DefaultParamHandler.
Reimplemented in EGHModel, BiGaussModel, EmgModel, ExtendedIsotopeModel, GaussModel, InterpolationModel, IsotopeModel, LmaGaussModel, LmaIsotopeModel, and ProductModel< 2 >.
Member Data Documentation
IntensityType cut_off_ [protected] |
| OpenMS / TOPP release 1.10.0 | Documentation generated on Thu Mar 7 2013 09:42:56 using doxygen 1.7.1 |