OpenMS  3.0.0
GridFeature.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: Hendrik Weisser $
32 // $Authors: Steffen Sass, Hendrik Weisser $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 #include <OpenMS/CONCEPT/Types.h>
38 #include <OpenMS/OpenMSConfig.h>
39 
40 #include <set>
41 
42 namespace OpenMS
43 {
44  class BaseFeature;
45  class AASequence;
46 
52  class OPENMS_DLLAPI GridFeature
53  {
54 private:
57 
60 
63 
65  std::set<AASequence> annotations_;
66 
67 public:
74  GridFeature(const BaseFeature& feature, Size map_index, Size feature_index);
75 
77  const BaseFeature& getFeature() const;
78 
80  virtual ~GridFeature();
81 
83  Size getMapIndex() const;
84 
86  Size getFeatureIndex() const;
87 
89  Int getID() const;
90 
92  const std::set<AASequence>& getAnnotations() const;
93 
95  double getRT() const;
96 
98  double getMZ() const;
99  };
100 }
101 
Types.h
OpenMS::BaseFeature
A basic LC-MS feature.
Definition: BaseFeature.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::GridFeature
Representation of a feature in a hash grid.
Definition: GridFeature.h:52
OpenMS::Int
int Int
Signed integer type.
Definition: Types.h:102
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::GridFeature::annotations_
std::set< AASequence > annotations_
Set of peptide sequences annotated to the feature.
Definition: GridFeature.h:65
OpenMS::GridFeature::feature_index_
Size feature_index_
Index of the feature in the map.
Definition: GridFeature.h:62
OpenMS::GridFeature::map_index_
Size map_index_
Index of the feature map or consensus map.
Definition: GridFeature.h:59
OpenMS::GridFeature::feature_
const BaseFeature & feature_
Reference to the contained feature.
Definition: GridFeature.h:56