OpenMS  2.5.0
Feature.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-2020.
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: Timo Sachsenberg $
32 // $Authors: $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
39 
40 #include <OpenMS/CONCEPT/Types.h>
41 #include <OpenMS/OpenMSConfig.h>
42 
43 #include <vector>
44 
45 namespace OpenMS
46 {
47 
70  class OPENMS_DLLAPI Feature :
71  public BaseFeature
72  {
73 public:
77  Feature();
79 
81  Feature(const Feature& feature);
82 
84  Feature(Feature&&) noexcept;
85 
87  ~Feature() override;
89 
91 
92  QualityType getOverallQuality() const;
94 
96  void setOverallQuality(QualityType q);
97 
99  QualityType getQuality(Size index) const;
101  void setQuality(Size index, QualityType q);
102 
105 
107 
109 
110  const std::vector<ConvexHull2D>& getConvexHulls() const;
113  std::vector<ConvexHull2D>& getConvexHulls();
115  void setConvexHulls(const std::vector<ConvexHull2D>& hulls);
116 
122  ConvexHull2D& getConvexHull() const;
123 
125  bool encloses(double rt, double mz) const;
127 
129  Feature& operator=(const Feature& rhs);
130 
132  Feature& operator=(Feature&&) & noexcept;
133 
135  bool operator==(const Feature& rhs) const;
136 
138  const std::vector<Feature>& getSubordinates() const;
139 
141  std::vector<Feature>& getSubordinates();
142 
144  void setSubordinates(const std::vector<Feature>& rhs);
145 
158  template <typename Type>
159  Size applyMemberFunction(Size (Type::* member_function)())
160  {
161  Size assignments = 0;
162  assignments += ((*this).*member_function)();
163  for (std::vector<Feature>::iterator iter = subordinates_.begin(); iter != subordinates_.end(); ++iter)
164  {
165  assignments += iter->applyMemberFunction(member_function);
166  }
167  return assignments;
168  }
169 
171  template <typename Type>
172  Size applyMemberFunction(Size (Type::* member_function)() const) const
173  {
174  Size assignments = 0;
175  assignments += ((*this).*member_function)();
176  for (std::vector<Feature>::const_iterator iter = subordinates_.begin(); iter != subordinates_.end(); ++iter)
177  {
178  assignments += iter->applyMemberFunction(member_function);
179  }
180  return assignments;
181  }
182 
183 protected:
184 
186  QualityType qualities_[2];
187 
189  std::vector<ConvexHull2D> convex_hulls_;
190 
193 
196 
198  std::vector<Feature> subordinates_;
199 
200  };
201 
202 } // namespace OpenMS
203 
OpenMS::Feature::OverallQualityLess
QualityLess OverallQualityLess
Compare by quality.
Definition: Feature.h:104
OpenMS::Feature::convex_hulls_modified_
bool convex_hulls_modified_
Flag that indicates if the overall convex hull needs to be recomputed (i.e. mass trace convex hulls w...
Definition: Feature.h:192
Types.h
OpenMS::BaseFeature
A basic LC-MS feature.
Definition: BaseFeature.h:56
OpenMS::Feature::subordinates_
std::vector< Feature > subordinates_
subordinate features (e.g. features that represent alternative explanations, usually with lower quali...
Definition: Feature.h:198
OpenMS::Size
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:127
OpenMS::Feature::applyMemberFunction
Size applyMemberFunction(Size(Type::*member_function)() const) const
The "const" variant.
Definition: Feature.h:172
OpenMS::Feature::convex_hulls_
std::vector< ConvexHull2D > convex_hulls_
Array of convex hulls (one for each mass trace)
Definition: Feature.h:189
OpenMS::ConvexHull2D
A 2-dimensional hull representation in [counter]clockwise direction - depending on axis labelling.
Definition: ConvexHull2D.h:72
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
ConvexHull2D.h
BaseFeature.h
OpenMS::Feature::convex_hull_
ConvexHull2D convex_hull_
Overall convex hull of the feature.
Definition: Feature.h:195
KDTree::operator==
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806
OpenMS::Feature
An LC-MS feature.
Definition: Feature.h:70
OpenMS::BaseFeature::QualityLess
Compare by quality.
Definition: BaseFeature.h:115
OpenMS::Feature::applyMemberFunction
Size applyMemberFunction(Size(Type::*member_function)())
Applies a member function of Type to the feature (including subordinates). The returned values are ac...
Definition: Feature.h:159