OpenSwathPercolatorScoring.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Justin Sing $
// $Authors: Justin Sing $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/DATASTRUCTURES/DefaultParamHandler.h>
#include <OpenMS/KERNEL/StandardTypes.h>
#include <OpenMS/config.h>
 
#include <array>
#include <memory>
#include <string>
 
namespace OpenMS
{
  class OPENMS_DLLAPI OpenSwathPercolatorScoring :
    public DefaultParamHandler
  {
  public:
    enum class Level
    {
      MS1,
      MS2,
      MS1MS2,
      TRANSITION,
      SIZE_OF_LEVEL
    };
 
    static const std::array<std::string, static_cast<Size>(Level::SIZE_OF_LEVEL)> names_of_level;
 
    struct OPENMS_DLLAPI ScoreSummary
    {
      Size total_rows = 0;
      Size target_rows = 0;
      Size decoy_rows = 0;
      Size feature_count = 0;
    };
 
    OpenSwathPercolatorScoring();
    ~OpenSwathPercolatorScoring() override;
 
    ScoreSummary score(const std::string& input_path,
                       Level level,
                       const std::string& output_path = "");
 
  protected:
    void updateMembers_() override;
 
  private:
    struct Impl;
    std::unique_ptr<Impl> impl_;
  };
} // namespace OpenMS