OpenMS  3.0.0
SpectrumCheapDPCorr.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 
39 
42 
43 #include <map>
44 
45 namespace OpenMS
46 {
47 
61  class OPENMS_DLLAPI SpectrumCheapDPCorr :
63  {
64 public:
65 
66  // @name Constructors and Destructors
67  // @{
70 
73 
75  ~SpectrumCheapDPCorr() override;
76  // @}
77 
78  // @name Operators
79  // @{
81  SpectrumCheapDPCorr & operator=(const SpectrumCheapDPCorr & source);
82 
83  double operator()(const PeakSpectrum & a, const PeakSpectrum & b) const override;
84 
85  double operator()(const PeakSpectrum & a) const override;
86  // @}
87 
88  // @name Accessors
89  // @{
92 
94  static const String getProductName()
95  {
96  return "SpectrumCheapDPCorr";
97  }
98 
100  const PeakSpectrum & lastconsensus() const;
101 
103  std::map<UInt, UInt> getPeakMap() const;
104 
106  void setFactor(double f);
107  // @}
108 
109 private:
110 
112  double dynprog_(const PeakSpectrum &, const PeakSpectrum &, int, int, int, int) const;
113 
115  double comparepeaks_(double posa, double posb, double inta, double intb) const;
116 
117  static const String info_;
118 
121 
124 
126  mutable double factor_;
127 
129  mutable std::map<UInt, UInt> peak_map_;
130  };
131 
132 }
OpenMS::SpectrumCheapDPCorr
SpectrumCheapDPCorr calculates an optimal alignment on stick spectra.
Definition: SpectrumCheapDPCorr.h:61
OpenMS::SpectrumCheapDPCorr::peak_map_
std::map< UInt, UInt > peak_map_
last peak map
Definition: SpectrumCheapDPCorr.h:129
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::SpectrumCheapDPCorr::create
static PeakSpectrumCompareFunctor * create()
Definition: SpectrumCheapDPCorr.h:91
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
OpenMS::SpectrumCheapDPCorr::info_
static const String info_
Definition: SpectrumCheapDPCorr.h:117
OpenMS::SpectrumCheapDPCorr::lastconsensus_
PeakSpectrum lastconsensus_
consensus spectrum of the last comparison
Definition: SpectrumCheapDPCorr.h:120
PeakSpectrumCompareFunctor.h
OpenMS::SpectrumCheapDPCorr::factor_
double factor_
weighting factor for the next consensus spectrum
Definition: SpectrumCheapDPCorr.h:126
MSExperiment.h
OpenMS::SpectrumCheapDPCorr::getProductName
static const String getProductName()
Definition: SpectrumCheapDPCorr.h:94
OpenMS::MSSpectrum
The representation of a 1D spectrum.
Definition: MSSpectrum.h:66
StandardTypes.h
MSSpectrum.h
OpenMS::SpectrumCheapDPCorr::keeppeaks_
bool keeppeaks_
should peaks with no alignment partner be kept in the consensus?
Definition: SpectrumCheapDPCorr.h:123