OpenMS  2.4.0
ILPDCWrapper.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-2018.
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: Chris Bielow $
32 // $Authors: Chris Bielow $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
39 
40 #include <vector>
41 #include <set>
42 
43 namespace OpenMS
44 {
45 
46  class MassExplainer;
47  class FeatureMap;
48 
49  class OPENMS_DLLAPI ILPDCWrapper
50  {
51 
52 public:
53  typedef std::vector<ChargePair> PairsType;
54  typedef PairsType::size_type PairsIndex;
55 
57  ILPDCWrapper();
58 
60  virtual ~ILPDCWrapper();
61 
66  double compute(const FeatureMap fm, PairsType& pairs, Size verbose_level) const;
67 
68 private:
69 
71  double computeSlice_(const FeatureMap fm,
72  PairsType& pairs,
73  const PairsIndex margin_left,
74  const PairsIndex margin_right,
75  const Size verbose_level) const;
76 
78  double computeSliceOld_(const FeatureMap fm,
79  PairsType& pairs,
80  const PairsIndex margin_left,
81  const PairsIndex margin_right,
82  const Size verbose_level) const;
83 
85  double getLogScore_(const PairsType::value_type& pair, const FeatureMap& fm) const;
86 
88 
89  // add another charge annotation variant for a feature
90  void updateFeatureVariant_(FeatureType_& f_set, const String& rota_l, const Size& v) const;
91 
92 
93 
94  }; // !class
95 
96 } // !namespace
97 
PairsType::size_type PairsIndex
Definition: ILPDCWrapper.h:54
A more convenient string class.
Definition: String.h:57
Definition: ILPDCWrapper.h:49
A container for features.
Definition: FeatureMap.h:93
Map< String, std::set< Size > > FeatureType_
Definition: ILPDCWrapper.h:87
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:127
std::vector< ChargePair > PairsType
Definition: ILPDCWrapper.h:53
Map class based on the STL map (containing several convenience functions)
Definition: Map.h:50