OpenMS: PeakAlignment.h Source File

| OpenMS 2.5.0

PeakAlignment.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/PeakSpectrumCompareFunctor.h>
38 #include <vector>
39
40 namespace OpenMS
41 {
42
53 class OPENMS_DLLAPI PeakAlignment :
54 public PeakSpectrumCompareFunctor
55 {
56 public:
57
59 PeakAlignment();
60
62 PeakAlignment(const PeakAlignment & source);
63
65 ~PeakAlignment() override;
66
68 PeakAlignment & operator=(const PeakAlignment & source);
69
75 double operator()(const PeakSpectrum & spec1, const PeakSpectrum & spec2) const override;
76
78 double operator()(const PeakSpectrum & spec) const override;
79
81 static PeakSpectrumCompareFunctor * create() { return new PeakAlignment(); }
82
84 static const String getProductName()
85 {
86 return "PeakAlignment";
87 }
88
90 std::vector<std::pair<Size, Size> > getAlignmentTraceback(const PeakSpectrum & spec1, const PeakSpectrum & spec2) const;
91
92 private:
93
95 double peakPairScore_(double & pos1, double & intens1, double & pos2, double & intens2, const double & sigma) const;
96
97
98 };
99
100 }
OpenMS::PeakAlignment::create
static PeakSpectrumCompareFunctor * create()
Definition: PeakAlignment.h:81
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::MSSpectrum
The representation of a 1D spectrum.
Definition: MSSpectrum.h:67
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
OpenMS::PeakAlignment
make a PeakAlignment of two PeakSpectra
Definition: PeakAlignment.h:53
OpenMS::PeakAlignment::getProductName
static const String getProductName()
get the identifier for this DefaultParamHandler
Definition: PeakAlignment.h:84