OpenMS  2.4.0
List of all members
Scaler Class Reference

Scaler scales the peak by ranking the peaks and assigning intensity according to rank. More...

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

Inheritance diagram for Scaler:
DefaultParamHandler

Public Member Functions

 Scaler ()
 default constructor More...
 
 ~Scaler () override
 destructor More...
 
 Scaler (const Scaler &source)
 copy constructor More...
 
Scaler & operator= (const Scaler &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...
 

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

Scaler scales the peak by ranking the peaks and assigning intensity according to rank.

Constructor & Destructor Documentation

◆ Scaler() [1/2]

Scaler ( )

default constructor

◆ ~Scaler()

~Scaler ( )
override

destructor

◆ Scaler() [2/2]

Scaler ( const Scaler &  source)

copy constructor

Member Function Documentation

◆ filterPeakMap()

void filterPeakMap ( PeakMap &  exp)

◆ filterPeakSpectrum()

void filterPeakSpectrum ( PeakSpectrum &  spectrum)

◆ filterSpectrum()

void filterSpectrum ( SpectrumType &  spectrum)
inline

◆ operator=()

Scaler& operator= ( const Scaler &  source)

assignment operator