Scores.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: Julianus Pfeuffer $
// $Authors: Julianus Pfeuffer $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/DATASTRUCTURES/String.h>
#include <OpenMS/CONCEPT/Exception.h>
#include <OpenMS/OpenMSConfig.h>
 
#include <vector>
#include <set>
#include <map>
#include <algorithm>
 
namespace OpenMS
{
 
  class OPENMS_DLLAPI Scores
  {
  public:
    enum class IDType
    {
      RAW,      
      RAW_EVAL, 
      PP,       
      PEP,      
      FDR,      
      QVAL,     
    };
 
    static bool isScoreType(const String& score_name, IDType type);
 
    static IDType parseIDType(const String& score_type);
 
    static bool isHigherBetter(IDType type);
 
    static std::vector<String> getAllIDScoreNames();
 
    static const std::set<String>& getIDNamesForType(IDType type);
 
    static bool findIDTypeByName(const String& name, IDType& type);
 
    static String normalizeScoreName(const String& score_name);
 
    static bool isKnownScoreType(const String& score_name);
 
  private:
    struct Maps_
    {
      std::map<IDType, std::set<String>> type_to_str;
      std::map<IDType, bool> type_to_better;
    };
 
    static const Maps_& getMaps_();
  };
 
} // namespace OpenMS