Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

PeakSpectrumCompareFunctor Class Reference
[Spectrum Comparison]

#include <OpenMS/COMPARISON/SPECTRA/PeakSpectrumCompareFunctor.h>

Inheritance diagram for PeakSpectrumCompareFunctor:

FactoryProduct DefaultParamHandler SpectrumAlignmentScore SpectrumCheapDPCorr SpectrumPrecursorComparator ZhangSimilarityScore

List of all members.


Detailed Description

Base class for compare functors of spectra; compare functors returns a similiarity value of two spectra.

PeakSpectrumCompareFunctor classes return a value for a pair of PeakSpectrum objects ideally the value should reflect the similarity of the pair similarities of spectra should be > 0

Public Member Functions

 PeakSpectrumCompareFunctor ()
 default constructor
 PeakSpectrumCompareFunctor (const PeakSpectrumCompareFunctor &source)
 copy constructor
virtual ~PeakSpectrumCompareFunctor ()
 destructor
PeakSpectrumCompareFunctoroperator= (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 ()


Constructor & Destructor Documentation

PeakSpectrumCompareFunctor (  ) 

default constructor

PeakSpectrumCompareFunctor ( const PeakSpectrumCompareFunctor source  ) 

copy constructor

virtual ~PeakSpectrumCompareFunctor (  )  [virtual]

destructor


Member Function Documentation

PeakSpectrumCompareFunctor& operator= ( const PeakSpectrumCompareFunctor source  ) 

assignment operator

virtual double operator() ( const PeakSpectrum a,
const PeakSpectrum b 
) const [pure virtual]

function call operator, calculates the similarity

Implemented in SpectrumAlignmentScore, SpectrumCheapDPCorr, SpectrumPrecursorComparator, and ZhangSimilarityScore.

virtual double operator() ( const PeakSpectrum a  )  const [pure virtual]

calculates self similarity

Implemented in SpectrumAlignmentScore, SpectrumCheapDPCorr, SpectrumPrecursorComparator, and ZhangSimilarityScore.

static void registerChildren (  )  [static]

registers all derived products

static const String getProductName (  )  [inline, static]

Reimplemented in SpectrumAlignmentScore, SpectrumCheapDPCorr, SpectrumPrecursorComparator, and ZhangSimilarityScore.


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:43 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1