| OpenMS 2.5.0

Public Member Functions | List of all members
PeakPickerSH Class Reference

`#include <OpenMS/TRANSFORMATIONS/RAW2PEAK/PeakPickerSH.h>`

Inheritance diagram for PeakPickerSH:

## Public Member Functions

| PeakPickerSH ()
| ~PeakPickerSH () override
void | pick (const MSSpectrum &input, MSSpectrum &output, float fWindowWidth)
| Picks peaks in one spectrum. More...
void | pickExperiment (const PeakMap &input, PeakMap &output)
| Applies the peak-picking algorithm to a map (MSExperiment). 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 DefaultParamHandler & | operator= (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 Param & | getParameters () const
| Non-mutable access to the parameters. More...
const Param & | getDefaults () const
| Non-mutable access to the default parameters. More...
const String & | getName () 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...
| ProgressLogger (const ProgressLogger &other)
| Copy constructor. More...
ProgressLogger & | operator= (const ProgressLogger &other)
| Assignment Operator. 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...
void | nextProgress () const
| increment progress by 1 (according to range begin-end) More...

## Additional Inherited Members

Public Types inherited from ProgressLogger
enum | LogType { CMD, GUI, NONE }
| Possible log types. More...
Protected Member Functions inherited from DefaultParamHandler
virtual void | updateMembers_ ()
| This method is used to update extra member variables at the end of the setParameters() method. More...
void | defaultsToParam_ ()
| Updates the parameters after the defaults have been set in the constructor. More...
Static Protected Member Functions inherited from ProgressLogger
static String | logTypeToFactoryName_ (LogType type)
| Return the name of the factory product used for this log type. 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< String > | subsections_
| 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_
time_t | last_invoke_
ProgressLoggerImpl * | current_logger_
Static Protected Attributes inherited from ProgressLogger
static int | recursion_depth_

## Constructor & Destructor Documentation

## ◆ PeakPickerSH()

PeakPickerSH | ( |  | ) |

## ◆ ~PeakPickerSH()

~PeakPickerSH | ( |  | ) |

override

## Member Function Documentation

## ◆ pick()

void pick | ( | const MSSpectrum & | input,
|  | MSSpectrum & | output,
|  | float | fWindowWidth
| ) |  |

inline

Picks peaks in one spectrum.

References OpenMS::Constants::k, Peak1D::setIntensity(), and Peak1D::setMZ().

## ◆ pickExperiment()

void pickExperiment | ( | const PeakMap & | input,
|  | PeakMap & | output
| ) |  |

Applies the peak-picking algorithm to a map (MSExperiment).

This method picks peaks for each scan in the map consecutively. The resulting picked peaks are written to the output map.