OpenMS
2.6.0
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
File Members
OpenMS
COMPARISON
SPECTRA
BinnedSpectrumCompareFunctor.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/DATASTRUCTURES/DefaultParamHandler.h
>
38
#include <
OpenMS/CONCEPT/Exception.h
>
39
#include <
OpenMS/COMPARISON/SPECTRA/BinnedSpectrum.h
>
40
41
#include <cmath>
42
43
namespace
OpenMS
44
{
45
56
class
OPENMS_DLLAPI
BinnedSpectrumCompareFunctor
:
57
public
DefaultParamHandler
58
{
59
60
private
:
61
62
public
:
64
BinnedSpectrumCompareFunctor
();
65
67
BinnedSpectrumCompareFunctor
(
const
BinnedSpectrumCompareFunctor
& source);
68
70
~
BinnedSpectrumCompareFunctor
()
override
;
71
73
BinnedSpectrumCompareFunctor
& operator=(
const
BinnedSpectrumCompareFunctor
& source);
74
76
virtual
double
operator()(
const
BinnedSpectrum
& spec1,
const
BinnedSpectrum
& spec2)
const
= 0;
77
79
virtual
double
operator()(
const
BinnedSpectrum
& spec)
const
= 0;
80
82
static
void
registerChildren();
83
85
static
const
String
getProductName
()
86
{
87
return
"BinnedSpectrumCompareFunctor"
;
88
}
89
90
};
91
92
}
93
DefaultParamHandler.h
OpenMS::BinnedSpectrum
This is a binned representation of a PeakSpectrum.
Definition:
BinnedSpectrum.h:75
OpenMS::String
A more convenient string class.
Definition:
String.h:59
OpenMS::BinnedSpectrumCompareFunctor
Base class for compare functors of BinnedSpectra.
Definition:
BinnedSpectrumCompareFunctor.h:56
BinnedSpectrum.h
OpenMS::DefaultParamHandler
A base class for all classes handling default parameters.
Definition:
DefaultParamHandler.h:92
OpenMS
Main OpenMS namespace.
Definition:
FeatureDeconvolution.h:46
Exception.h
OpenMS::BinnedSpectrumCompareFunctor::getProductName
static const String getProductName()
get the identifier for a DefaultParamHandler
Definition:
BinnedSpectrumCompareFunctor.h:85
Generated on Wed Sep 30 2020 13:52:53 for OpenMS by
1.8.16