OpenMS
PeakSpectrumCompareFunctor.h
Go to the documentation of this file.
1 // Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
2 // SPDX-License-Identifier: BSD-3-Clause
3 //
4 // --------------------------------------------------------------------------
5 // $Maintainer: Timo Sachsenberg $
6 // $Authors: $
7 // --------------------------------------------------------------------------
8 //
9 #pragma once
10 
13 
14 namespace OpenMS
15 {
16 
26  class OPENMS_DLLAPI PeakSpectrumCompareFunctor :
27  public DefaultParamHandler
28  {
29 
30 public:
31 
34 
37 
40 
43 
45  virtual double operator()(const PeakSpectrum & a, const PeakSpectrum & b) const = 0;
46 
48  virtual double operator()(const PeakSpectrum & a) const = 0;
49 
51  static void registerChildren();
52 
54  static const String getProductName()
55  {
56  return "PeakSpectrumCompareFunctor";
57  }
58 
59  };
60 
61 }
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:66
The representation of a 1D spectrum.
Definition: MSSpectrum.h:44
Base class for compare functors of spectra, that return a similarity value for two spectra.
Definition: PeakSpectrumCompareFunctor.h:28
PeakSpectrumCompareFunctor & operator=(const PeakSpectrumCompareFunctor &source)
assignment operator
virtual double operator()(const PeakSpectrum &a, const PeakSpectrum &b) const =0
function call operator, calculates the similarity
PeakSpectrumCompareFunctor(const PeakSpectrumCompareFunctor &source)
copy constructor
virtual double operator()(const PeakSpectrum &a) const =0
calculates self similarity
~PeakSpectrumCompareFunctor() override
destructor
static void registerChildren()
registers all derived products
PeakSpectrumCompareFunctor()
default constructor
static const String getProductName()
Definition: PeakSpectrumCompareFunctor.h:54
A more convenient string class.
Definition: String.h:34
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:22