| OpenMS 2.5.0

ZhangSimilarityScore.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-2020.
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
37 #include <OpenMS/COMPARISON/SPECTRA/PeakSpectrumCompareFunctor.h>
38
39 namespace OpenMS
40 {
41
54 class OPENMS_DLLAPI ZhangSimilarityScore :
55 public PeakSpectrumCompareFunctor
56 {
57 public:
58
59 // @name Constructors and Destructors
60 // @{
62 ZhangSimilarityScore();
63
65 ZhangSimilarityScore(const ZhangSimilarityScore & source);
66
68 ~ZhangSimilarityScore() override;
69 // @}
70
71 // @name Operators
72 // @{
74 ZhangSimilarityScore & operator=(const ZhangSimilarityScore & source);
75
77 double operator()(const PeakSpectrum & spec1, const PeakSpectrum & spec2) const override;
78
79 double operator()(const PeakSpectrum & spec) const override;
80 // @}
81
82 // @name Accessors
83 // @{
85 static PeakSpectrumCompareFunctor * create() { return new ZhangSimilarityScore(); }
86
88 static const String getProductName()
89 {
90 return "ZhangSimilarityScore";
91 }
92
93 // @}
94
95 protected:
96
98 double getFactor_(double mz_tolerance, double mz_difference, bool is_gaussian = false) const;
99
100
101 };
102
103 }
OpenMS::ZhangSimilarityScore::getProductName
static const String getProductName()
Definition: ZhangSimilarityScore.h:88
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::ZhangSimilarityScore
Similarity score of Zhang.
Definition: ZhangSimilarityScore.h:54
OpenMS::MSSpectrum
The representation of a 1D spectrum.
Definition: MSSpectrum.h:67
OpenMS::ZhangSimilarityScore::create
static PeakSpectrumCompareFunctor * create()
Definition: ZhangSimilarityScore.h:85
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::PeakSpectrumCompareFunctor
Base class for compare functors of spectra, that return a similarity value for two spectra...
Definition: PeakSpectrumCompareFunctor.h:52
PeakSpectrumCompareFunctor.h