OpenMS
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
MarkerMower Class Reference

MarkerMower uses PeakMarker to find peaks, those that are not marked get removed. More...

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

Inheritance diagram for MarkerMower:
[legend]
Collaboration diagram for MarkerMower:
[legend]

Public Member Functions

 MarkerMower ()
 default constructor More...
 
 ~MarkerMower () override
 destructor More...
 
 MarkerMower (const MarkerMower &source)
 copy constructor More...
 
MarkerMoweroperator= (const MarkerMower &source)
 assignment operator More...
 
template<typename SpectrumType >
void filterSpectrum (SpectrumType &spectrum)
 
void filterPeakSpectrum (PeakSpectrum &spectrum)
 
void filterPeakMap (PeakMap &exp)
 
void insertmarker (PeakMarker *peak_marker)
 insert new Marker (violates the DefaultParamHandler interface) 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...
 
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...
 

Static Public Member Functions

static const String getProductName ()
 
- 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...
 

Private Attributes

std::vector< PeakMarker * > markers_
 used peak markers More...
 

Additional Inherited Members

- 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< 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...
 

Detailed Description

MarkerMower uses PeakMarker to find peaks, those that are not marked get removed.

Constructor & Destructor Documentation

◆ MarkerMower() [1/2]

default constructor

◆ ~MarkerMower()

~MarkerMower ( )
override

destructor

◆ MarkerMower() [2/2]

MarkerMower ( const MarkerMower source)

copy constructor

Member Function Documentation

◆ filterPeakMap()

void filterPeakMap ( PeakMap exp)

◆ filterPeakSpectrum()

void filterPeakSpectrum ( PeakSpectrum spectrum)

◆ filterSpectrum()

void filterSpectrum ( SpectrumType spectrum)
inline

◆ getProductName()

static const String getProductName ( )
inlinestatic

◆ insertmarker()

void insertmarker ( PeakMarker peak_marker)

insert new Marker (violates the DefaultParamHandler interface)

◆ operator=()

MarkerMower& operator= ( const MarkerMower source)

assignment operator

Member Data Documentation

◆ markers_

std::vector<PeakMarker *> markers_
private

used peak markers