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

BinnedRepCompareFunctor Class Reference
[Spectrum Comparison]

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

Inheritance diagram for BinnedRepCompareFunctor:

FactoryProduct DefaultParamHandler BinnedRepMutualInformation BinnedRepSharedPeakCount BinnedRepSpectrumContrastAngle BinnedRepSumAgreeingIntensities

List of all members.


Detailed Description

Base class for compare functors of binned spectra which report the spectra similarity.

The similarity of two binned spectra is calculated with the operator (). The self similarity can also be calculated with this operator by skipping the second argument.

Accessors

virtual double operator() (const BinnedRep &s1, const BinnedRep &s2) const =0
 function call operator, calculates the similarity
virtual double operator() (const BinnedRep &a) const =0
 function call operator, calculates the self similarity
static void registerChildren ()
 registers all derived products
static const String getProductName ()

Public Member Functions

Constructors and Destructors
 BinnedRepCompareFunctor ()
 default constructor
 BinnedRepCompareFunctor (const BinnedRepCompareFunctor &source)
 copy constructor
virtual ~BinnedRepCompareFunctor ()
 destructor
Assigment
BinnedRepCompareFunctoroperator= (const BinnedRepCompareFunctor &source)
 assignment operator


Constructor & Destructor Documentation

BinnedRepCompareFunctor (  ) 

default constructor

BinnedRepCompareFunctor ( const BinnedRepCompareFunctor source  ) 

copy constructor

virtual ~BinnedRepCompareFunctor (  )  [virtual]

destructor


Member Function Documentation

BinnedRepCompareFunctor& operator= ( const BinnedRepCompareFunctor source  ) 

assignment operator

virtual double operator() ( const BinnedRep s1,
const BinnedRep s2 
) const [pure virtual]

function call operator, calculates the similarity

Implemented in BinnedRepMutualInformation, BinnedRepSharedPeakCount, BinnedRepSpectrumContrastAngle, and BinnedRepSumAgreeingIntensities.

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

function call operator, calculates the self similarity

Implemented in BinnedRepMutualInformation, BinnedRepSharedPeakCount, BinnedRepSpectrumContrastAngle, and BinnedRepSumAgreeingIntensities.

static void registerChildren (  )  [static]

registers all derived products

static const String getProductName (  )  [inline, static]

Reimplemented in BinnedRepMutualInformation, BinnedRepSharedPeakCount, BinnedRepSpectrumContrastAngle, and BinnedRepSumAgreeingIntensities.


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