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

FeatureFinderAlgorithm Class Template Reference
[FeatureFinder]

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

Inheritance diagram for FeatureFinderAlgorithm:

FactoryProduct DefaultParamHandler FeatureFinderAlgorithmPicked FeatureFinderAlgorithmSimple FeatureFinderAlgorithmSimplest

List of all members.


Detailed Description

template<class PeakType, class FeatureType>
class OpenMS::FeatureFinderAlgorithm< PeakType, FeatureType >

Abstract base class for FeatureFinder algorithms.

Public Types

typedef MSExperiment< PeakType > MapType
 Input map type.
typedef MapType::CoordinateType CoordinateType
 Coordinate/Position type of peaks.
typedef MapType::IntensityType IntensityType
 Intensity type of peaks.
typedef FeatureMap< FeatureType > FeatureMapType
 Output feature type.

Public Member Functions

 FeatureFinderAlgorithm ()
 default constructor
virtual ~FeatureFinderAlgorithm ()
 destructor
virtual void run ()=0
 Main method that implements the actual algorithm.
virtual Param getDefaultParameters () const
 Returns the default parameters. Reimplment.
void setData (const MapType &map, FeatureMapType &features, FeatureFinder &ff)
 Sets a reference to the calling FeatureFinder.

Static Public Member Functions

static void registerChildren ()
 register all derived classes here (see FeatureFinderAlgorithm_impl.h)

Protected Attributes

const MapTypemap_
 Input data pointer.
FeatureMapTypefeatures_
 Output data pointer.
FeatureFinderff_
 Pointer to the calling FeatureFinder that is used to access the feature flags.

Private Member Functions

FeatureFinderAlgorithmoperator= (const FeatureFinderAlgorithm &)
 Not implemented.
 FeatureFinderAlgorithm (const FeatureFinderAlgorithm &)
 Not implemented.

Member Typedef Documentation

typedef MSExperiment<PeakType> MapType

Input map type.

Reimplemented in FeatureFinderAlgorithmPicked.

typedef MapType::CoordinateType CoordinateType

Coordinate/Position type of peaks.

Reimplemented in FeatureFinderAlgorithmPicked.

typedef MapType::IntensityType IntensityType

Intensity type of peaks.

Reimplemented in FeatureFinderAlgorithmPicked.

typedef FeatureMap<FeatureType> FeatureMapType

Output feature type.


Constructor & Destructor Documentation

FeatureFinderAlgorithm (  )  [inline]

default constructor

virtual ~FeatureFinderAlgorithm (  )  [inline, virtual]

destructor

FeatureFinderAlgorithm ( const FeatureFinderAlgorithm< PeakType, FeatureType > &   )  [private]

Not implemented.


Member Function Documentation

void registerChildren (  )  [inline, static]

register all derived classes here (see FeatureFinderAlgorithm_impl.h)

virtual void run (  )  [pure virtual]

Main method that implements the actual algorithm.

Implemented in FeatureFinderAlgorithmPicked, FeatureFinderAlgorithmSimple, and FeatureFinderAlgorithmSimplest.

virtual Param getDefaultParameters (  )  const [inline, virtual]

Returns the default parameters. Reimplment.

Reimplment if you derive a class and have to incoopreate sub-algorithm default parameters.

Reimplemented in FeatureFinderAlgorithmSimple, and FeatureFinderAlgorithmSimplest.

void setData ( const MapType map,
FeatureMapType features,
FeatureFinder ff 
) [inline]

Sets a reference to the calling FeatureFinder.

FeatureFinderAlgorithm& operator= ( const FeatureFinderAlgorithm< PeakType, FeatureType > &   )  [private]

Not implemented.


Member Data Documentation

const MapType* map_ [protected]

Input data pointer.

FeatureMapType* features_ [protected]

Output data pointer.

FeatureFinder* ff_ [protected]

Pointer to the calling FeatureFinder that is used to access the feature flags.


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