OpenMS  3.0.0
SpectrumPrecursorComparator.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 
39 namespace OpenMS
40 {
41 
49  class OPENMS_DLLAPI SpectrumPrecursorComparator :
51  {
52 public:
53 
54  // @name Constructors and Destructors
55  // @{
58 
61 
63  ~SpectrumPrecursorComparator() override;
64  // @}
65 
66  // @name Operators
67  // @{
69  SpectrumPrecursorComparator & operator=(const SpectrumPrecursorComparator & source);
70 
71  double operator()(const PeakSpectrum & a, const PeakSpectrum & b) const override;
72 
73  double operator()(const PeakSpectrum & a) const override;
74  // @}
75 
76  // @name Accessors
77  // @{
80 
82  static const String getProductName()
83  {
84  return "SpectrumPrecursorComparator";
85  }
86 
87  // @}
88 
89  };
90 
91 }
92 
OpenMS::SpectrumPrecursorComparator::create
static PeakSpectrumCompareFunctor * create()
Definition: SpectrumPrecursorComparator.h:79
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::SpectrumPrecursorComparator::getProductName
static const String getProductName()
Definition: SpectrumPrecursorComparator.h:82
OpenMS::PeakSpectrumCompareFunctor
Base class for compare functors of spectra, that return a similarity value for two spectra.
Definition: PeakSpectrumCompareFunctor.h:52
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
PeakSpectrumCompareFunctor.h
OpenMS::SpectrumPrecursorComparator
SpectrumPrecursorComparator compares just the parent mass of two spectra.
Definition: SpectrumPrecursorComparator.h:49
OpenMS::MSSpectrum
The representation of a 1D spectrum.
Definition: MSSpectrum.h:66