OpenMS
FeatureSummary.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-2023.
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: Axel Walter $
32 // $Authors: Axel Walter $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
38 #include <OpenMS/QC/QCBase.h>
39 
48 namespace OpenMS
49 {
50  class OPENMS_DLLAPI FeatureSummary : public QCBase
51  {
52  public:
54  FeatureSummary() = default;
55 
57  virtual ~FeatureSummary() = default;
58 
59  // stores feature summary values calculated by compute function
60  struct OPENMS_DLLAPI Result {
61  UInt feature_count = 0;
62  float rt_shift_mean = 0;
63 
64  bool operator==(const Result& rhs) const;
65  };
66 
75  Result compute(const FeatureMap& feature_map);
76 
77  const String& getName() const override;
78 
79  QCBase::Status requirements() const override;
80 
81  private:
82  const String name_ = "Summary of features from featureXML file";
83  };
84 } // namespace OpenMS
A container for features.
Definition: FeatureMap.h:106
Definition: FeatureSummary.h:51
virtual ~FeatureSummary()=default
Destructor.
FeatureSummary()=default
Constructor.
const String & getName() const override
Returns the name of the metric.
QCBase::Status requirements() const override
Returns the input data requirements of the compute(...) function.
Result compute(const FeatureMap &feature_map)
computes a summary of a featureXML file
Stores and handles combinations of enum values, e.g. a set of flags as bits flipped in an UInt64.
Definition: FlagSet.h:54
This class serves as an abstract base class for all QC classes.
Definition: QCBase.h:55
A more convenient string class.
Definition: String.h:60
unsigned int UInt
Unsigned integer type.
Definition: Types.h:94
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48
Definition: FeatureSummary.h:60
bool operator==(const Result &rhs) const