Base class for compare functors of spectra, that return a similiarity value for two spectra. More...
#include <OpenMS/COMPARISON/SPECTRA/PeakSpectrumCompareFunctor.h>
Public Member Functions | |
| PeakSpectrumCompareFunctor () | |
| default constructor | |
| PeakSpectrumCompareFunctor (const PeakSpectrumCompareFunctor &source) | |
| copy constructor | |
| virtual | ~PeakSpectrumCompareFunctor () |
| destructor | |
| PeakSpectrumCompareFunctor & | operator= (const PeakSpectrumCompareFunctor &source) |
| assignment operator | |
| virtual double | operator() (const PeakSpectrum &a, const PeakSpectrum &b) const =0 |
| function call operator, calculates the similarity | |
| virtual double | operator() (const PeakSpectrum &a) const =0 |
| calculates self similarity | |
Static Public Member Functions | |
| static void | registerChildren () |
| registers all derived products | |
| static const String | getProductName () |
Detailed Description
Base class for compare functors of spectra, that return a similiarity value for two spectra.
PeakSpectrumCompareFunctor classes return a similarity value for a pair of PeakSpectrum objects. The value should be greater equal 0.
Constructor & Destructor Documentation
default constructor
| PeakSpectrumCompareFunctor | ( | const PeakSpectrumCompareFunctor & | source | ) |
copy constructor
| virtual ~PeakSpectrumCompareFunctor | ( | ) | [virtual] |
destructor
Member Function Documentation
| static const String getProductName | ( | ) | [inline, static] |
| virtual double operator() | ( | const PeakSpectrum & | a, | |
| const PeakSpectrum & | b | |||
| ) | const [pure virtual] |
function call operator, calculates the similarity
Implemented in CompareFouriertransform, PeakAlignment, SpectraSTSimilarityScore, SpectrumAlignmentScore, SpectrumCheapDPCorr, SpectrumPrecursorComparator, SteinScottImproveScore, and ZhangSimilarityScore.
| virtual double operator() | ( | const PeakSpectrum & | a | ) | const [pure virtual] |
calculates self similarity
Implemented in CompareFouriertransform, PeakAlignment, SpectraSTSimilarityScore, SpectrumAlignmentScore, SpectrumCheapDPCorr, SpectrumPrecursorComparator, SteinScottImproveScore, and ZhangSimilarityScore.
| PeakSpectrumCompareFunctor& operator= | ( | const PeakSpectrumCompareFunctor & | 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 |