Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Member Functions | List of all members
ElutionPeakDetection Class Reference

Extracts chromatographic peaks from a mass trace. More...

#include <OpenMS/FILTERING/DATAREDUCTION/ElutionPeakDetection.h>

Inheritance diagram for ElutionPeakDetection:
DefaultParamHandler ProgressLogger

Public Member Functions

 ElutionPeakDetection ()
 Default Constructor. More...
 
virtual ~ElutionPeakDetection ()
 Destructor. More...
 
- Public Member Functions inherited from DefaultParamHandler
 DefaultParamHandler (const String &name)
 Constructor with name that is displayed in error messages. More...
 
 DefaultParamHandler (const DefaultParamHandler &rhs)
 Copy constructor. More...
 
virtual ~DefaultParamHandler ()
 Destructor. More...
 
virtual DefaultParamHandleroperator= (const DefaultParamHandler &rhs)
 Assignment operator. More...
 
virtual bool operator== (const DefaultParamHandler &rhs) const
 Equality operator. More...
 
void setParameters (const Param &param)
 Sets the parameters. More...
 
const ParamgetParameters () const
 Non-mutable access to the parameters. More...
 
const ParamgetDefaults () const
 Non-mutable access to the default parameters. More...
 
const StringgetName () const
 Non-mutable access to the name. More...
 
void setName (const String &name)
 Mutable access to the name. More...
 
const std::vector< String > & getSubsections () const
 Non-mutable access to the registered subsections. More...
 
- Public Member Functions inherited from ProgressLogger
 ProgressLogger ()
 Constructor. More...
 
 ~ProgressLogger ()
 Destructor. More...
 
void setLogType (LogType type) const
 Sets the progress log that should be used. The default type is NONE! More...
 
LogType getLogType () const
 Returns the type of progress log being used. More...
 
void startProgress (SignedSize begin, SignedSize end, const String &label) const
 Initializes the progress display. More...
 
void setProgress (SignedSize value) const
 Sets the current progress. More...
 
void endProgress () const
 Ends the progress display. More...
 

Main computation methods

Getter & setter methods

DoubleReal chrom_fwhm_
 
DoubleReal chrom_peak_snr_
 
DoubleReal noise_threshold_int_
 
DoubleReal sample_rate_
 
DoubleReal min_fwhm_
 
DoubleReal max_fwhm_
 
String pw_filtering_
 
bool mt_snr_filtering_
 
void detectPeaks (MassTrace &, std::vector< MassTrace > &)
 Extracts chromatographic peaks from a single MassTrace and stores the splits into a vector of new mass traces. More...
 
void detectPeaks (std::vector< MassTrace > &, std::vector< MassTrace > &)
 Applies the aforementioned detection method on a series of mass traces as input. More...
 
void filterByPeakWidth (std::vector< MassTrace > &, std::vector< MassTrace > &)
 
DoubleReal computeMassTraceNoise (const MassTrace &)
 
DoubleReal computeMassTraceSNR (const MassTrace &)
 
DoubleReal computeApexSNR (const MassTrace &)
 
void findLocalExtrema (const MassTrace &, const Size &, std::vector< Size > &, std::vector< Size > &)
 
virtual void updateMembers_ ()
 This method is used to update extra member variables at the end of the setParameters() method. More...
 
void detectElutionPeaks_ (MassTrace &, std::vector< MassTrace > &)
 

Additional Inherited Members

- Public Types inherited from ProgressLogger
enum  LogType { CMD, GUI, NONE }
 Possible log types. More...
 
- Protected Member Functions inherited from DefaultParamHandler
void defaultsToParam_ ()
 Updates the parameters after the defaults have been set in the constructor. More...
 
- Protected Attributes inherited from DefaultParamHandler
Param param_
 Container for current parameters. More...
 
Param defaults_
 Container for default parameters. This member should be filled in the constructor of derived classes! More...
 
std::vector< Stringsubsections_
 Container for registered subsections. This member should be filled in the constructor of derived classes! More...
 
String error_name_
 Name that is displayed in error messages during the parameter checking. More...
 
bool check_defaults_
 If this member is set to false no checking if parameters in done;. More...
 
bool warn_empty_defaults_
 If this member is set to false no warning is emitted when defaults are empty;. More...
 
- Protected Attributes inherited from ProgressLogger
LogType type_
 
SignedSize begin_
 
SignedSize end_
 
SignedSize value_
 
QProgressDialog * dlg_
 
StopWatch stop_watch_
 
time_t last_invoke_
 
- Static Protected Attributes inherited from ProgressLogger
static int recursion_depth_
 

Detailed Description

Extracts chromatographic peaks from a mass trace.

Mass traces may consist of several consequitively (partly overlapping) eluting peaks, e.g., stemming from isomeric compounds with exactly the same mass but different retentional behaviour. This method first applies LOWESS smoothing on the mass trace's intensities, then detects local minima/maxima in order to separate the chromatographic peaks from each other. This results in a vector that gathers the splitted mass traces (see ElutionPeakDetection parameters).

Constructor & Destructor Documentation

Default Constructor.

virtual ~ElutionPeakDetection ( )
virtual

Destructor.

Member Function Documentation

DoubleReal computeApexSNR ( const MassTrace )
DoubleReal computeMassTraceNoise ( const MassTrace )
DoubleReal computeMassTraceSNR ( const MassTrace )
void detectElutionPeaks_ ( MassTrace ,
std::vector< MassTrace > &   
)
private
void detectPeaks ( MassTrace ,
std::vector< MassTrace > &   
)

Extracts chromatographic peaks from a single MassTrace and stores the splits into a vector of new mass traces.

void detectPeaks ( std::vector< MassTrace > &  ,
std::vector< MassTrace > &   
)

Applies the aforementioned detection method on a series of mass traces as input.

void filterByPeakWidth ( std::vector< MassTrace > &  ,
std::vector< MassTrace > &   
)
void findLocalExtrema ( const MassTrace ,
const Size ,
std::vector< Size > &  ,
std::vector< Size > &   
)
virtual void updateMembers_ ( )
protectedvirtual

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.

Member Data Documentation

DoubleReal chrom_fwhm_
private
DoubleReal chrom_peak_snr_
private
DoubleReal max_fwhm_
private
DoubleReal min_fwhm_
private
bool mt_snr_filtering_
private
DoubleReal noise_threshold_int_
private
String pw_filtering_
private
DoubleReal sample_rate_
private

OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:29 using doxygen 1.8.5