| OpenMS 2.5.0

Public Member Functions | Static Public Member Functions | List of all members
BinnedSpectrumCompareFunctor Class Referenceabstract
Spectrum Comparison

Base class for compare functors of BinnedSpectra. More...

`#include <OpenMS/COMPARISON/SPECTRA/BinnedSpectrumCompareFunctor.h>`

Inheritance diagram for BinnedSpectrumCompareFunctor:

## Public Member Functions

| BinnedSpectrumCompareFunctor ()
| default constructor More...
| BinnedSpectrumCompareFunctor (const BinnedSpectrumCompareFunctor &source)
| copy constructor More...
| ~BinnedSpectrumCompareFunctor () override
| destructor More...
BinnedSpectrumCompareFunctor & | operator= (const BinnedSpectrumCompareFunctor &source)
| assignment operator More...
virtual double | operator() (const BinnedSpectrum &spec1, const BinnedSpectrum &spec2) const =0
| function call operator, calculates the similarity of the given arguments More...
virtual double | operator() (const BinnedSpectrum &spec) const =0
| function call operator, calculates self similarity 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 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...

## Static Public Member Functions

static void | registerChildren ()
| registers all derived products More...
static const String | getProductName ()
| get the identifier for a DefaultParamHandler 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

Base class for compare functors of BinnedSpectra.

BinnedSpectrumCompareFunctor classes return a value for a pair of BinnedSpectrum objects (or a single one with itself). Ideally the value should reflect the similarity of the pair. For methods of computing the similarity see the documentation of the concrete functors. Functors normalized in the range [0,1] are identifiable at the set "normalized" parameter of the ParameterHandler

## Constructor & Destructor Documentation

## ◆ BinnedSpectrumCompareFunctor() [1/2]

BinnedSpectrumCompareFunctor | ( |  | ) |

default constructor

## ◆ BinnedSpectrumCompareFunctor() [2/2]

BinnedSpectrumCompareFunctor | ( | const BinnedSpectrumCompareFunctor & | source | ) |

copy constructor

## ◆ ~BinnedSpectrumCompareFunctor()

~BinnedSpectrumCompareFunctor | ( |  | ) |

override

destructor

## Member Function Documentation

## ◆ getProductName()

static const String getProductName | ( |  | ) |

inline static

get the identifier for a DefaultParamHandler

## ◆ operator()() [1/2]

virtual double operator() | ( | const BinnedSpectrum & | spec1,
|  | const BinnedSpectrum & | spec2
| ) |  | const

pure virtual

function call operator, calculates the similarity of the given arguments

Implemented in BinnedSumAgreeingIntensities, BinnedSharedPeakCount, and BinnedSpectralContrastAngle.

## ◆ operator()() [2/2]

virtual double operator() | ( | const BinnedSpectrum & | spec | ) | const

pure virtual

function call operator, calculates self similarity

Implemented in BinnedSumAgreeingIntensities, BinnedSharedPeakCount, and BinnedSpectralContrastAngle.

## ◆ operator=()

BinnedSpectrumCompareFunctor& operator= | ( | const BinnedSpectrumCompareFunctor & | source | ) |

assignment operator

## ◆ registerChildren()

static void registerChildren | ( |  | ) |

static

registers all derived products