Base class for compare functors of BinnedSpectra. More...
#include <OpenMS/COMPARISON/SPECTRA/BinnedSpectrumCompareFunctor.h>
Classes | |
| class | IncompatibleBinning |
| Exception thrown if compared spectra are incompatible. More... | |
Public Member Functions | |
| BinnedSpectrumCompareFunctor () | |
| default constructor | |
| BinnedSpectrumCompareFunctor (const BinnedSpectrumCompareFunctor &source) | |
| copy constructor | |
| virtual | ~BinnedSpectrumCompareFunctor () |
| destructor | |
| BinnedSpectrumCompareFunctor & | operator= (const BinnedSpectrumCompareFunctor &source) |
| assignment operator | |
| virtual double | operator() (const BinnedSpectrum &spec1, const BinnedSpectrum &spec2) const =0 |
| function call operator, calculates the similarity of the given arguments | |
| virtual double | operator() (const BinnedSpectrum &spec) const =0 |
| function call operator, calculates self similarity | |
Static Public Member Functions | |
| static void | registerChildren () |
| registers all derived products | |
| static const String | getProductName () |
| get the identifier for a DefaultParamHandler | |
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 documetation of the concrete functors. Functors normalized in the range [0,1] are identifiable at the set "normalized" parameter of the ParameterHandler
Constructor & Destructor Documentation
default constructor
| BinnedSpectrumCompareFunctor | ( | const BinnedSpectrumCompareFunctor & | source | ) |
copy constructor
| virtual ~BinnedSpectrumCompareFunctor | ( | ) | [virtual] |
destructor
Member Function Documentation
| static const String getProductName | ( | ) | [inline, static] |
get the identifier for a DefaultParamHandler
Reimplemented in BinnedSharedPeakCount, BinnedSpectralContrastAngle, and BinnedSumAgreeingIntensities.
| virtual double operator() | ( | const BinnedSpectrum & | spec1, | |
| const BinnedSpectrum & | spec2 | |||
| ) | const [pure virtual] |
function call operator, calculates the similarity of the given arguments
Implemented in BinnedSharedPeakCount, BinnedSpectralContrastAngle, and BinnedSumAgreeingIntensities.
| virtual double operator() | ( | const BinnedSpectrum & | spec | ) | const [pure virtual] |
function call operator, calculates self similarity
Implemented in BinnedSharedPeakCount, BinnedSpectralContrastAngle, and BinnedSumAgreeingIntensities.
| BinnedSpectrumCompareFunctor& operator= | ( | const BinnedSpectrumCompareFunctor & | source | ) |
assignment operator
| static void registerChildren | ( | ) | [static] |
registers all derived products
| OpenMS / TOPP release 1.10.0 | Documentation generated on Thu Mar 7 2013 09:42:51 using doxygen 1.7.1 |