OpenMS  3.0.0
SpectrumAlignmentScore.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2022.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Timo Sachsenberg $
32 // $Authors: $
33 // --------------------------------------------------------------------------
34 //
35 #pragma once
36 
38 #include <OpenMS/KERNEL/Peak1D.h>
43 
44 #include <cmath>
45 
46 namespace OpenMS
47 {
48 
68  class OPENMS_DLLAPI SpectrumAlignmentScore :
70  {
71 public:
72 
73  // @name Constructors and Destructors
74  // @{
77 
80 
82  ~SpectrumAlignmentScore() override;
83  // @}
84 
85  // @name Operators
86  // @{
88  SpectrumAlignmentScore & operator=(const SpectrumAlignmentScore & source);
89 
91  double operator()(const PeakSpectrum & spec1, const PeakSpectrum & spec2) const override;
92 
93  double operator()(const PeakSpectrum & spec) const override;
94  // @}
95 
96  // @name Accessors
97  // @{
100 
102  static const String getProductName()
103  {
104  return "SpectrumAlignmentScore";
105  }
106 
107  // @}
108 
109  };
110 
111 }
OpenMS::String
A more convenient string class.
Definition: String.h:58
Peak1D.h
OpenMS::SpectrumAlignmentScore::getProductName
static const String getProductName()
Definition: SpectrumAlignmentScore.h:102
OpenMS::PeakSpectrumCompareFunctor
Base class for compare functors of spectra, that return a similarity value for two spectra.
Definition: PeakSpectrumCompareFunctor.h:52
ListUtils.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
PeakSpectrumCompareFunctor.h
OpenMS::SpectrumAlignmentScore
Similarity score via spectra alignment.
Definition: SpectrumAlignmentScore.h:68
OpenMS::SpectrumAlignmentScore::create
static PeakSpectrumCompareFunctor * create()
Definition: SpectrumAlignmentScore.h:99
SpectrumAlignment.h
OpenMS::MSSpectrum
The representation of a 1D spectrum.
Definition: MSSpectrum.h:66
StandardTypes.h
MSSpectrum.h