Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
MRMFeature.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: Hannes Roest $
32 // $Authors: Hannes Roest $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_KERNEL_MRMFEATURE_H
36 #define OPENMS_KERNEL_MRMFEATURE_H
37 
38 #include <OpenMS/KERNEL/Feature.h>
39 
40 namespace OpenMS
41 {
50  class OPENMS_DLLAPI MRMFeature :
51  public Feature
52  {
53 public:
54 
56 
57  typedef std::vector<Feature> FeatureListType;
60  typedef std::map<String, double> PGScoresType;
62 
64 
65  MRMFeature();
67 
69  MRMFeature(const MRMFeature &rhs);
70 
72  MRMFeature & operator=(const MRMFeature & rhs);
73 
75  virtual ~MRMFeature();
77 
79 
80  const PGScoresType & getScores() const;
82 
84  double getScore(const String & score_name);
85 
87  Feature & getFeature(String key);
88 
90  void setScores(const PGScoresType & scores);
91 
93  void addScore(const String & score_name, double score);
94 
96  void addFeature(Feature & feature, const String& key);
97 
99  const std::vector<Feature> & getFeatures() const;
100 
102  void getFeatureIDs(std::vector<String> & result) const;
103 
105  void addPrecursorFeature(Feature & feature, const String& key);
106 
108  void getPrecursorFeatureIDs(std::vector<String> & result) const;
109 
111  Feature & getPrecursorFeature(String key);
112 
114 
115 protected:
116 
117  FeatureListType features_;
118 
119  FeatureListType precursor_features_;
120 
122  PGScoresType pg_scores_;
123 
125  std::map<String, int> feature_map_;
126 
128  std::map<String, int> precursor_feature_map_;
129 
130  };
131 }
132 
133 #endif // OPENMS_KERNEL_MRMFEATURE_H
134 
A more convenient string class.
Definition: String.h:57
std::map< String, double > PGScoresType
Peak group score type.
Definition: MRMFeature.h:60
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
std::map< String, int > precursor_feature_map_
map native ids to the precursor features
Definition: MRMFeature.h:128
FeatureListType precursor_features_
Definition: MRMFeature.h:119
An LC-MS feature.
Definition: Feature.h:70
FeatureListType features_
Definition: MRMFeature.h:117
std::map< String, int > feature_map_
map native ids to the features
Definition: MRMFeature.h:125
A multi-chromatogram MRM feature.
Definition: MRMFeature.h:50
std::vector< Feature > FeatureListType
Type definitions.
Definition: MRMFeature.h:58
PGScoresType pg_scores_
peak group scores
Definition: MRMFeature.h:122

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