OpenMS
Loading...
Searching...
No Matches
RankScaler Class Reference

Scales each peak by ranking the peaks per spectrum and assigning intensity according to rank. More...

#include <OpenMS/PROCESSING/SCALING/RankScaler.h>

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

Public Member Functions

 RankScaler ()
 default constructor
 
 ~RankScaler () override
 destructor
 
 RankScaler (const RankScaler &source)
 copy constructor
 
RankScaleroperator= (const RankScaler &source)
 assignment operator
 
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.
 
 DefaultParamHandler (const DefaultParamHandler &rhs)
 Copy constructor.
 
virtual ~DefaultParamHandler ()
 Destructor.
 
DefaultParamHandleroperator= (const DefaultParamHandler &rhs)
 Assignment operator.
 
virtual bool operator== (const DefaultParamHandler &rhs) const
 Equality operator.
 
void setParameters (const Param &param)
 Sets the parameters.
 
const ParamgetParameters () const
 Non-mutable access to the parameters.
 
const ParamgetDefaults () const
 Non-mutable access to the default parameters.
 
const StringgetName () const
 Non-mutable access to the name.
 
void setName (const String &name)
 Mutable access to the name.
 
const std::vector< String > & getSubsections () const
 Non-mutable access to the registered subsections.
 

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.
 
- 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.
 
void defaultsToParam_ ()
 Updates the parameters after the defaults have been set in the constructor.
 
- Protected Attributes inherited from DefaultParamHandler
Param param_
 Container for current parameters.
 
Param defaults_
 Container for default parameters. This member should be filled in the constructor of derived classes!
 
std::vector< Stringsubsections_
 Container for registered subsections. This member should be filled in the constructor of derived classes!
 
String error_name_
 Name that is displayed in error messages during the parameter checking.
 
bool check_defaults_
 If this member is set to false no checking if parameters in done;.
 
bool warn_empty_defaults_
 If this member is set to false no warning is emitted when defaults are empty;.
 

Detailed Description

Scales each peak by ranking the peaks per spectrum and assigning intensity according to rank.

@ingroup SpectraPreprocessers

Constructor & Destructor Documentation

◆ RankScaler() [1/2]

default constructor

◆ ~RankScaler()

~RankScaler ( )
override

destructor

◆ RankScaler() [2/2]

RankScaler ( const RankScaler source)

copy constructor

Member Function Documentation

◆ filterPeakMap()

void filterPeakMap ( PeakMap exp)

◆ filterPeakSpectrum()

void filterPeakSpectrum ( PeakSpectrum spectrum)

◆ filterSpectrum()

template<typename SpectrumType >
void filterSpectrum ( SpectrumType spectrum)
inline

◆ operator=()

RankScaler & operator= ( const RankScaler source)

assignment operator