OpenMS  2.4.0
MassExplainer.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 
38 
39 #include <OpenMS/CONCEPT/Types.h>
41 #include <OpenMS/OpenMSConfig.h>
42 
43 namespace OpenMS
44 {
45  class Compomer;
46 
53  class OPENMS_DLLAPI MassExplainer
54  {
55 
56 public:
57 
58  typedef Adduct::AdductsType AdductsType; //vector<Adduct>
59  typedef std::vector<Compomer>::const_iterator CompomerIterator;
60 
62 
63  MassExplainer();
65 
67  MassExplainer(AdductsType adduct_base);
68 
70  MassExplainer(Int q_min, Int q_max, Int max_span, double thresh_logp);
71 
73  MassExplainer(AdductsType adduct_base, Int q_min, Int q_max, Int max_span, double thresh_logp, Size max_neutrals);
74 
75 
76 private:
79  void init_(bool init_thresh_p);
80 public:
82  MassExplainer& operator=(const MassExplainer& rhs);
83 
85  virtual ~MassExplainer();
87 
88 
90  void compute();
91 
92 
93  //@name Accessors
95 
97  void setAdductBase(AdductsType adduct_base);
99  AdductsType getAdductBase() const;
100 
102  const Compomer& getCompomerById(Size id) const;
104 
105 
113  SignedSize query(const Int net_charge,
114  const float mass_to_explain,
115  const float mass_delta,
116  const float thresh_log_p,
117  std::vector<Compomer>::const_iterator& firstExplanation,
118  std::vector<Compomer>::const_iterator& lastExplanation) const;
119 protected:
120 
122  bool compomerValid_(const Compomer& cmp);
123 
125  Adduct createAdduct_(const String& formula, const Int charge, const double p) const;
126 
128  std::vector<Compomer> explanations_;
138  double thresh_p_;
141 
142  };
143 
144 
145 } // namespace OpenMS
146 
A more convenient string class.
Definition: String.h:57
Holds information on an edge connecting two features from a (putative) charge ladder.
Definition: Compomer.h:58
ptrdiff_t SignedSize
Signed Size type e.g. used as pointer difference.
Definition: Types.h:134
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
std::vector< Adduct > AdductsType
Definition: Adduct.h:48
Size max_neutrals_
Maximum number of neutral(q=0) adducts.
Definition: MassExplainer.h:140
std::vector< Compomer > explanations_
store possible explanations (as formula) for a certain ChargeDifference and MassDifference ...
Definition: MassExplainer.h:128
computes empirical formulas for given mass differences using a set of allowed elements ...
Definition: MassExplainer.h:53
Definition: Adduct.h:44
std::vector< Compomer >::const_iterator CompomerIterator
Definition: MassExplainer.h:59
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:127
Int max_span_
maximal span (in terms of charge) for co-features, e.g. a cluster with q={3,6} has span=4 ...
Definition: MassExplainer.h:136
Int q_max_
maximal expected charge
Definition: MassExplainer.h:134
AdductsType adduct_base_
all allowed adducts, whose combination explains the mass difference
Definition: MassExplainer.h:130
Adduct::AdductsType AdductsType
Definition: MassExplainer.h:58
double thresh_p_
minimum required probability of a compound (all other compounds are discarded)
Definition: MassExplainer.h:138
int Int
Signed integer type.
Definition: Types.h:102
Int q_min_
minimal expected charge
Definition: MassExplainer.h:132