IMTypes.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: Chris Bielow $
// $Authors: Chris Bielow $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/CONCEPT/CommonEnums.h>
#include <OpenMS/OpenMSConfig.h>
 
#include <string>
 
namespace OpenMS
{
  class MSExperiment;
  class MSSpectrum;
 
  enum class DriftTimeUnit
  {
    NONE,                      
    MILLISECOND,               
    VSSC,                      
    FAIMS_COMPENSATION_VOLTAGE,
    CCS,                       
    SIZE_OF_DRIFTTIMEUNIT
  };
 
  OPENMS_DLLAPI extern const std::string NamesOfDriftTimeUnit[(size_t) DriftTimeUnit::SIZE_OF_DRIFTTIMEUNIT];
 
  OPENMS_DLLAPI DriftTimeUnit toDriftTimeUnit(const std::string& dtu_string);
 
  OPENMS_DLLAPI const std::string& driftTimeUnitToString(const DriftTimeUnit value);
 
  enum class IMFormat
  {
    NONE,            
    IM_PEAK,         
    IM_SPECTRUM,     
    UNKNOWN,         
    SIZE_OF_IMFORMAT
  };
  OPENMS_DLLAPI extern const std::string NamesOfIMFormat[(size_t) IMFormat::SIZE_OF_IMFORMAT];
  
  OPENMS_DLLAPI IMFormat toIMFormat(const std::string& IM_format);
  OPENMS_DLLAPI const std::string& imFormatToString(const IMFormat value);
 
  enum class IMPeakType
  {
    IM_PROFILE,        
    IM_CENTROIDED,     
    UNKNOWN,           
    SIZE_OF_IMPEAKTYPE
  };
 
  OPENMS_DLLAPI extern const std::string NamesOfIMPeakType[(size_t) IMPeakType::SIZE_OF_IMPEAKTYPE];
 
  OPENMS_DLLAPI IMPeakType toIMPeakType(const std::string& im_peak_type);
 
  OPENMS_DLLAPI const std::string& imPeakTypeToString(IMPeakType im_peak_type);
 
  class OPENMS_DLLAPI IMTypes
  {
  public:
    inline static constexpr double DRIFTTIME_NOT_SET = -1.0;
 
    static IMFormat determineIMFormat(const MSExperiment& exp, int ms_level);
 
    static IMFormat determineIMFormat(const MSSpectrum& spec);
 
    static DIM_UNIT fromIMUnit(const DriftTimeUnit from);
  };
 
};