OpenMS: BinnedSumAgreeingIntensities.h Source File

| OpenMS 2.5.0

BinnedSumAgreeingIntensities.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: Mathias Walzer $
32 // $Authors: $
33 // --------------------------------------------------------------------------
34 //
35 #pragma once
36
37 #include <OpenMS/COMPARISON/SPECTRA/BinnedSpectrumCompareFunctor.h>
38
39 #include <cmath>
40 #include <cfloat>
41
42 namespace OpenMS
43 {
44
64 class OPENMS_DLLAPI BinnedSumAgreeingIntensities :
65 public BinnedSpectrumCompareFunctor
66 {
67 public:
68
70 BinnedSumAgreeingIntensities();
71
73 BinnedSumAgreeingIntensities(const BinnedSumAgreeingIntensities& source);
74
76 ~BinnedSumAgreeingIntensities() override;
77
79 BinnedSumAgreeingIntensities& operator=(const BinnedSumAgreeingIntensities& source);
80
87 double operator()(const BinnedSpectrum& spec1, const BinnedSpectrum& spec2) const override;
88
90 double operator()(const BinnedSpectrum& spec) const override;
91
93 static BinnedSpectrumCompareFunctor* create() { return new BinnedSumAgreeingIntensities(); }
94
96 static const String getProductName()
97 {
98 return "BinnedSumAgreeingIntensities";
99 }
100
101 protected:
102 void updateMembers_() override;
103 double precursor_mass_tolerance_;
104 };
105
106 }
OpenMS::BinnedSumAgreeingIntensities::getProductName
static const String getProductName()
get the identifier for this DefaultParamHandler
Definition: BinnedSumAgreeingIntensities.h:96
OpenMS::BinnedSumAgreeingIntensities::precursor_mass_tolerance_
double precursor_mass_tolerance_
Definition: BinnedSumAgreeingIntensities.h:103
OpenMS::BinnedSumAgreeingIntensities
Sum of agreeing intensities for similarity measurement.
Definition: BinnedSumAgreeingIntensities.h:64
OpenMS::BinnedSumAgreeingIntensities::create
static BinnedSpectrumCompareFunctor * create()
Definition: BinnedSumAgreeingIntensities.h:93
OpenMS::BinnedSpectrumCompareFunctor
Base class for compare functors of BinnedSpectra.
Definition: BinnedSpectrumCompareFunctor.h:56
BinnedSpectrumCompareFunctor.h
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::BinnedSpectrum
This is a binned representation of a PeakSpectrum.
Definition: BinnedSpectrum.h:75