#include <OpenMS/TRANSFORMATIONS/FEATUREFINDER/FeatureFinder.h>
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 ¶m) |
Executes the FeatureFinder using the given algorithm. | |
const Flag & | getPeakFlag (const IndexPair &index) const |
Returns a non-mutable reference to a peak flag. | |
Flag & | getPeakFlag (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. |
FeatureFinder | ( | ) |
Default constructor.
virtual ~FeatureFinder | ( | ) | [virtual] |
Destructor.
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.
algorithm_name | Name of the feature finding algorithm to use | |
input_map | Input peak map | |
features | Output feature map | |
param | Algorithm parameters |
Returns a non-mutable reference to a peak flag.
Returns the default parameters for the algorithm with name algorithm_name
.
Generated Tue Apr 1 15:36:47 2008 -- using doxygen 1.5.4 | OpenMS / TOPP 1.1 |