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