FeatureSummary.h

Go to the documentation of this file.

// Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Axel Walter $
// $Authors: Axel Walter $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/KERNEL/FeatureMap.h>
#include <OpenMS/QC/QCBase.h>
 
namespace OpenMS
{
  class OPENMS_DLLAPI FeatureSummary : public QCBase
  {
  public:
    FeatureSummary() = default;
 
    virtual ~FeatureSummary() = default;
 
    // stores feature summary values calculated by compute function
    struct OPENMS_DLLAPI Result {
      UInt feature_count = 0;
      float rt_shift_mean = 0;
 
      bool operator==(const Result& rhs) const;
    };
 
    Result compute(const FeatureMap& feature_map);
 
    const String& getName() const override;
 
    QCBase::Status requirements() const override;
 
  private:
    const String name_ = "Summary of features from featureXML file";
  };
} // namespace OpenMS