ThresholdMower Class Reference

ThresholdMower removes all peaks below a threshold. More...

#include <OpenMS/FILTERING/TRANSFORMERS/ThresholdMower.h>

Inheritance diagram for ThresholdMower:

Collaboration diagram for ThresholdMower:

Public Member Functions
	ThresholdMower ()
	default constructor More...
	~ThresholdMower () override
	destructor More...
	ThresholdMower (const ThresholdMower &source)
	copy constructor More...
ThresholdMower &	operator= (const ThresholdMower &source)
	assignment operator More...
template<typename SpectrumType >
void	filterSpectrum (SpectrumType &spectrum)
void	filterPeakSpectrum (PeakSpectrum &spectrum)
void	filterPeakMap (PeakMap &exp)
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...

Private Attributes
double	threshold_

Additional Inherited Members
Static Public Member Functions inherited from DefaultParamHandler
static void	writeParametersToMetaValues (const Param &write_this, MetaInfoInterface &write_here, const String &key_prefix="")
	Writes all parameters to meta values. 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...
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...

Detailed Description

ThresholdMower removes all peaks below a threshold.

Parameters of this class are:

Name	Type	Default	Restrictions	Description
threshold	float	0.05		Intensity threshold, peaks below this threshold are discarded

Note:

• If a section name is documented, the documentation is displayed as tooltip.
• Advanced parameter names are italic.

Constructor & Destructor Documentation

ThresholdMower() [1/2]

ThresholdMower

(

)

default constructor

~ThresholdMower()

~ThresholdMower ( )

override

destructor

ThresholdMower() [2/2]

ThresholdMower

(

const ThresholdMower &

source

)

copy constructor

Member Function Documentation

filterPeakMap()

void filterPeakMap

(

PeakMap &

exp

)

Referenced by NucleicAcidSearchEngine::preprocessSpectra_().

filterPeakSpectrum()

void filterPeakSpectrum

(

PeakSpectrum &

spectrum

)

filterSpectrum()

void filterSpectrum ( SpectrumType &  spectrum )

inline

References MSSpectrum::select().

operator=()

ThresholdMower& operator=

(

const ThresholdMower &

source

)

assignment operator

Member Data Documentation

threshold_

double threshold_

private