OpenMS  2.8.0
Public Member Functions | Static Public Member Functions | List of all members
IntensityBalanceFilter Class Reference

IntensityBalanceFilter divides the m/z-range into ten regions and sums the intensity in these regions. More...

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

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

Public Member Functions

 IntensityBalanceFilter ()
 default constructor More...
 
 IntensityBalanceFilter (const IntensityBalanceFilter &source)
 copy constructor More...
 
 ~IntensityBalanceFilter () override
 destructor More...
 
IntensityBalanceFilteroperator= (const IntensityBalanceFilter &source)
 assignment operator More...
 
template<typename SpectrumType >
double apply (SpectrumType &spectrum)
 
- Public Member Functions inherited from FilterFunctor
 FilterFunctor ()
 default constructor More...
 
 FilterFunctor (const FilterFunctor &source)
 copy constructor More...
 
 ~FilterFunctor () override
 destructor More...
 
FilterFunctoroperator= (const FilterFunctor &source)
 assignment operator More...
 
template<typename SpectrumType >
double apply (SpectrumType &)
 function call operator 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 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 FilterFunctorcreate ()
 
static const String getProductName ()
 
- Static Public Member Functions inherited from FilterFunctor
static void registerChildren ()
 
- 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...
 

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

IntensityBalanceFilter divides the m/z-range into ten regions and sums the intensity in these regions.

The result is the intensity of the two bins with the highest intensity minus the intensity of the seven bins with lowest intensity.

Constructor & Destructor Documentation

◆ IntensityBalanceFilter() [1/2]

default constructor

◆ IntensityBalanceFilter() [2/2]

copy constructor

◆ ~IntensityBalanceFilter()

~IntensityBalanceFilter ( )
override

destructor

Member Function Documentation

◆ apply()

double apply ( SpectrumType spectrum)
inline

◆ create()

static FilterFunctor* create ( )
inlinestatic

◆ getProductName()

static const String getProductName ( )
inlinestatic

◆ operator=()

IntensityBalanceFilter& operator= ( const IntensityBalanceFilter source)

assignment operator