Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
FeatureDeconvolution.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-2017.
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: $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_ANALYSIS_DECHARGING_FEATUREDECONVOLUTION_H
36 #define OPENMS_ANALYSIS_DECHARGING_FEATUREDECONVOLUTION_H
37 
38 // OpenMS
44 
46 
47 namespace OpenMS
48 {
49 
50  class Compomer;
51 
60  class OPENMS_DLLAPI FeatureDeconvolution :
61  public DefaultParamHandler
62  {
63 public:
64 
65  enum CHARGEMODE {QFROMFEATURE = 1, QHEURISTIC, QALL};
66 
72 
78 
81 
83  FeatureDeconvolution& operator=(const FeatureDeconvolution& source);
84 
86  virtual ~FeatureDeconvolution();
88 
99  void compute(const FeatureMapType& fm_in, FeatureMapType& fm_out, ConsensusMap& cons_map, ConsensusMap& cons_map_p);
100 
101 protected:
102 
103  void updateMembers_();
104 
110  struct CmpInfo_;
111 
112  /*
113  @brief test for obviously wrong parameter settings and warn
114 
115  Currently supports the following scenarios:
116  * If the lower charge bound is too high, consensus features with gapped, even charges will occur (e.g. 30,32,34), instead of the true (15,16,17)
117  When more than 5% of the cf's look like this, we report it.
118 
119  */
120  void checkSolution_(const ConsensusMap& cons_map) const;
121 
126  void inferMoreEdges_(PairsType& edges, Map<Size, std::set<CmpInfo_> >& feature_adducts);
127 
129  void printEdgesOfConnectedFeatures_(Size idx_1, Size idx_2, const PairsType& feature_relation);
130 
137  inline bool intensityFilterPassed_(const Int q1, const Int q2, const Compomer& cmp, const FeatureType& f1, const FeatureType& f2);
138 
145  bool chargeTestworthy_(const Int feature_charge, const Int putative_charge, const bool other_unchanged) const;
146 
159 
160  };
161 } // namespace OpenMS
162 
163 #endif // OPENMS_ANALYSIS_DECHARGING_FEATUREDECONVOLUTION_H
Int verbose_level_
amount of debug information displayed
Definition: FeatureDeconvolution.h:158
Map< String, Size > map_label_inverse_
labeling table inverse
Definition: FeatureDeconvolution.h:152
FeatureMap FeatureMapType
Definition: FeatureDeconvolution.h:67
CHARGEMODE
Definition: FeatureDeconvolution.h:65
A container for features.
Definition: FeatureMap.h:94
Holds information on an edge connecting two features from a (putative) charge ladder.
Definition: Compomer.h:59
A container for consensus elements.
Definition: ConsensusMap.h:72
DPosition< 2 > ClusterPointType
Definition: FeatureDeconvolution.h:69
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
CHARGEMODE q_try_
status of charge discovery
Definition: FeatureDeconvolution.h:156
Feature::CoordinateType CoordinateType
Definition: AdditiveSeries.cpp:51
Map< Size, String > map_label_
labeling table
Definition: FeatureDeconvolution.h:150
An LC-MS feature.
Definition: Feature.h:70
Definition: FeatureDeconvolution.h:65
An algorithm to decharge features (i.e. as found by FeatureFinder).
Definition: FeatureDeconvolution.h:60
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:128
ILPDCWrapper::PairsType PairsType
Definition: FeatureDeconvolution.h:71
MassExplainer::AdductsType potential_adducts_
List of adducts used to explain mass differences.
Definition: FeatureDeconvolution.h:148
FeatureMapType::FeatureType::CoordinateType CoordinateType
Definition: FeatureDeconvolution.h:70
Feature FeatureType
Definition: FeatureDeconvolution.h:68
Adduct::AdductsType AdductsType
Definition: MassExplainer.h:59
bool enable_intensity_filter_
status of intensity filter for edges
Definition: FeatureDeconvolution.h:154
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:92
std::vector< ChargePair > PairsType
Definition: ILPDCWrapper.h:54
int Int
Signed integer type.
Definition: Types.h:103
Map class based on the STL map (containing several convenience functions)
Definition: Map.h:51

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:22:00 using doxygen 1.8.13