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

FeatureFinder Class Reference
[FeatureFinder]

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

Inheritance diagram for FeatureFinder:

ProgressLogger FeatureFinderDefs

List of all members.


Detailed Description

The main feature finder class.


Public Member Functions

 FeatureFinder ()
 Default constructor.
virtual ~FeatureFinder ()
 Destructor.
template<class PeakType, class FeatureType>
void run (const String &algorithm_name, MSExperiment< PeakType > const &input_map, FeatureMap< FeatureType > &features, const Param &param)
 Executes the FeatureFinder using the given algorithm.
const FlaggetPeakFlag (const IndexPair &index) const
 Returns a non-mutable reference to a peak flag.
FlaggetPeakFlag (const IndexPair &index)
 Returns mutable reference to a peak flag.
Param getParameters (const String &algorithm_name) const
 Returns the default parameters for the algorithm with name algorithm_name.

Protected Attributes

std::vector< std::vector< Flag > > flags_
 Container for flags attached to input data.

Constructor & Destructor Documentation

FeatureFinder (  ) 

Default constructor.

virtual ~FeatureFinder (  )  [virtual]

Destructor.


Member Function Documentation

void run ( const String algorithm_name,
MSExperiment< PeakType > const &  input_map,
FeatureMap< FeatureType > &  features,
const Param param 
) [inline]

Executes the FeatureFinder using the given algorithm.

There are several constraints for the input_map. They are tested before the algorithm starts. It must only contain MS 1 level scans and you have to call updateRanges() before passing it to this method.

Parameters:
algorithm_name Name of the feature finding algorithm to use
input_map Input peak map
features Output feature map
param Algorithm parameters
Implemented in FeatureFinder_impl.h

const Flag& getPeakFlag ( const IndexPair index  )  const [inline]

Returns a non-mutable reference to a peak flag.

Flag& getPeakFlag ( const IndexPair index  )  [inline]

Returns mutable reference to a peak flag.

Param getParameters ( const String algorithm_name  )  const

Returns the default parameters for the algorithm with name algorithm_name.


Member Data Documentation

std::vector< std::vector<Flag> > flags_ [protected]

Container for flags attached to input data.


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