OpenMS
FeatureSummary.h
Go to the documentation of this file.
1 // Copyright (c) 2002-present, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
2 // SPDX-License-Identifier: BSD-3-Clause
3 //
4 // --------------------------------------------------------------------------
5 // $Maintainer: Axel Walter $
6 // $Authors: Axel Walter $
7 // --------------------------------------------------------------------------
8 
9 #pragma once
10 
12 #include <OpenMS/QC/QCBase.h>
13 
22 namespace OpenMS
23 {
24  class OPENMS_DLLAPI FeatureSummary : public QCBase
25  {
26  public:
28  FeatureSummary() = default;
29 
31  virtual ~FeatureSummary() = default;
32 
33  // stores feature summary values calculated by compute function
34  struct OPENMS_DLLAPI Result {
35  UInt feature_count = 0;
36  float rt_shift_mean = 0;
37 
38  bool operator==(const Result& rhs) const;
39  };
40 
49  Result compute(const FeatureMap& feature_map);
50 
51  const String& getName() const override;
52 
53  QCBase::Status requirements() const override;
54 
55  private:
56  const String name_ = "Summary of features from featureXML file";
57  };
58 } // namespace OpenMS
A container for features.
Definition: FeatureMap.h:80
Definition: FeatureSummary.h:25
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:28
This class serves as an abstract base class for all QC classes.
Definition: QCBase.h:29
A more convenient string class.
Definition: String.h:34
unsigned int UInt
Unsigned integer type.
Definition: Types.h:64
Main OpenMS namespace.
Definition: openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19
Definition: FeatureSummary.h:34
bool operator==(const Result &rhs) const