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

FeatureFinderAlgorithmPicked::MassTraces Struct Reference

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

Inheritance diagram for FeatureFinderAlgorithmPicked::MassTraces:

List of all members.


Detailed Description

template<class PeakType, class FeatureType>
struct OpenMS::FeatureFinderAlgorithmPicked< PeakType, FeatureType >::MassTraces

Helper struct for a collection of mass traces used in FeatureFinderAlgorithmPicked.

Public Member Functions

 MassTraces ()
 Constructor.
UInt getPeakCount () const
 Returns the peak count of all traces.
bool isValid (DoubleReal seed_mz, DoubleReal trace_tolerance)
 Checks if still valid (seed still contained and enough traces).
UInt getTheoreticalMax () const throw (Exception::Precondition)
 Returns the theoretical maximum trace index. Throws an error, if there are no traces.
void updateBaseline ()
 Sets the baseline to the lowest contained peak of the trace.
std::pair< DoubleReal, DoubleRealgetRTBounds () const throw (Exception::Precondition)
 Returns the RT boundaries of the mass traces.

Public Attributes

UInt max_trace
 Maximum intensity trace.
DoubleReal baseline
 Estimated baseline in the region of the feature (used for the fit).

Constructor & Destructor Documentation

MassTraces (  )  [inline]

Constructor.


Member Function Documentation

UInt getPeakCount (  )  const [inline]

Returns the peak count of all traces.

bool isValid ( DoubleReal  seed_mz,
DoubleReal  trace_tolerance 
) [inline]

Checks if still valid (seed still contained and enough traces).

UInt getTheoreticalMax (  )  const throw (Exception::Precondition) [inline]

Returns the theoretical maximum trace index. Throws an error, if there are no traces.

void updateBaseline (  )  [inline]

Sets the baseline to the lowest contained peak of the trace.

std::pair<DoubleReal,DoubleReal> getRTBounds (  )  const throw (Exception::Precondition) [inline]

Returns the RT boundaries of the mass traces.


Member Data Documentation

UInt max_trace

Maximum intensity trace.

DoubleReal baseline

Estimated baseline in the region of the feature (used for the fit).


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