CbmDefs.h

Go to the documentation of this file.

/* Copyright (C) 2017-2025 GSI Helmholtzzentrum fuer Schwerionenforschung, Darmstadt
   SPDX-License-Identifier: GPL-3.0-only
   Authors: Florian Uhlig, Volker Friese [committer], Semen Lebedev */

 
#ifndef CBMDEFS_H
#define CBMDEFS_H 1
 
#include "CbmEnumDict.h"  // for CBM_ENUM_DICT
 
#include <iosfwd>  // for ostream
#include <string>
#include <type_traits>  // for underlying_type
 
#include <xpu/defines.h>  // for XPU_D

// FIXME: SZh 02.06.2025: This function should be moved to CbmUtility library
template<typename T>
XPU_D constexpr auto ToIntegralType(T enumerator) -> typename std::underlying_type<T>::type
{
  return static_cast<typename std::underlying_type<T>::type>(enumerator);
}

enum class ECbmModuleId
{
  kRef        = 0,   
  kMvd        = 1,   
  kSts        = 2,   
  kRich       = 3,   
  kMuch       = 4,   
  kTrd        = 5,   
  kTof        = 6,   
  kMust       = 7,   
  kPsd        = 8,   
  kHodo       = 9,   
  kDummyDet   = 10,  
  kBmon       = 11,  
  kTrd2d      = 12,  
  kFsd        = 13,  
  kNofSystems = 14,  
  kMagnet     = 17,  
  kTarget     = 18,  
  kPipe       = 19,  
  kShield     = 20,  
  kPlatform   = 21,  
  kCave       = 22,  
  kLastModule = 23,  
  kNotExist   = -1   
};

CBM_ENUM_DICT(ECbmModuleId,
  {"Ref", ECbmModuleId::kRef},
  {"Mvd", ECbmModuleId::kMvd},
  {"Sts", ECbmModuleId::kSts},
  {"Rich", ECbmModuleId::kRich},
  {"Much", ECbmModuleId::kMuch},
  {"Trd", ECbmModuleId::kTrd},
  {"Tof", ECbmModuleId::kTof},
  {"Must", ECbmModuleId::kMust},
  {"Psd", ECbmModuleId::kPsd},
  {"Hodo", ECbmModuleId::kHodo},
  {"DummyDet", ECbmModuleId::kDummyDet},
  {"Bmon", ECbmModuleId::kBmon},
  {"Trd2d", ECbmModuleId::kTrd2d},
  {"Fsd", ECbmModuleId::kFsd},
  {"NofSystems", ECbmModuleId::kNofSystems},
  {"Magnet", ECbmModuleId::kMagnet},
  {"Target", ECbmModuleId::kTarget},
  {"Pipe", ECbmModuleId::kPipe},
  {"Shield", ECbmModuleId::kShield},
  {"Platform", ECbmModuleId::kPlatform},
  {"Cave", ECbmModuleId::kCave},
  {"LastModule", ECbmModuleId::kLastModule},
  {"NotExist", ECbmModuleId::kNotExist}
);

ECbmModuleId& operator++(ECbmModuleId&);
 

enum class ECbmDataType
{
  kUnknown  = -1,
  kMCTrack  = 0,
  kMvdPoint = ToIntegralType(ECbmModuleId::kMvd) * 100,
  kMvdDigi,
  kMvdCluster,
  kMvdHit,  // MVD
  kStsPoint = ToIntegralType(ECbmModuleId::kSts) * 100,
  kStsDigi,
  kStsCluster,
  kStsHit,
  kStsTrack,  // STS
  kRichPoint = ToIntegralType(ECbmModuleId::kRich) * 100,
  kRichDigi,
  kRichHit,
  kRichRing,
  kRichTrackParamZ,
  kRichTrackProjection,  // RICH
  kMuchPoint = ToIntegralType(ECbmModuleId::kMuch) * 100,
  kMuchDigi,
  kMuchCluster,
  kMuchPixelHit,
  kMuchStrawHit,
  kMuchTrack,  // MUCH
  kMustPoint = ToIntegralType(ECbmModuleId::kMust) * 100,
  kMustDigi,
  kMustCluster,
  kMustPixelHit,
  kMustStrawHit,
  kMustTrack,  // MUST
  kTrdPoint = ToIntegralType(ECbmModuleId::kTrd) * 100,
  kTrdDigi,
  kTrdCluster,
  kTrdHit,
  kTrdTrack,  // TRD
  kTofPoint = ToIntegralType(ECbmModuleId::kTof) * 100,
  kTofDigi,
  kTofCalDigi,
  kTofHit,
  kTofTrack,
  kTofUHit,
  kTofTracklet,  // TOF
  kPsdPoint = ToIntegralType(ECbmModuleId::kPsd) * 100,
  kPsdDigi,
  kPsdHit,  // PSD
  kBmonPoint = ToIntegralType(ECbmModuleId::kBmon) * 100,
  kBmonDigi,
  kBmonCalDigi,
  kBmonHit,  // BMON
  kFsdPoint = ToIntegralType(ECbmModuleId::kFsd) * 100,
  kFsdDigi,
  kFsdHit,             // Fsd
  kGlobalTrack = 2000  // Global
};

std::ostream& operator<<(std::ostream&, const ECbmDataType&);

enum class ECbmTreeAccess
{
  kRegular,
  kRepeat,
  kRandom
};

enum class ECbmRecoMode
{
  Timeslice,
  EventByEvent,
  Undefined
};

namespace cbm::algo::ca
{
  enum class EDetectorID
  {
    kMvd = 0,
    kSts,
    kMuch,
    kTrd,
    kTof,
    END
  };
 

  constexpr ECbmModuleId ToCbmModuleId(EDetectorID detID)
  {
    switch (detID) {
      case EDetectorID::kMvd: return ECbmModuleId::kMvd;
      case EDetectorID::kSts: return ECbmModuleId::kSts;
      case EDetectorID::kMuch: return ECbmModuleId::kMuch;
      case EDetectorID::kTrd: return ECbmModuleId::kTrd;
      case EDetectorID::kTof: return ECbmModuleId::kTof;
      default: return ECbmModuleId::kNotExist;
    }
  }

  constexpr EDetectorID ToCaDetectorID(ECbmModuleId modId)
  {
    switch (modId) {
      case ECbmModuleId::kMvd: return EDetectorID::kMvd;
      case ECbmModuleId::kSts: return EDetectorID::kSts;
      case ECbmModuleId::kMuch: return EDetectorID::kMuch;
      case ECbmModuleId::kTrd: return EDetectorID::kTrd;
      case ECbmModuleId::kTof: return EDetectorID::kTof;
      default: return EDetectorID::END;
    }
  }
}  // namespace cbm::algo::ca

// FIXME: SZh 02.06.2025:
//   These functions should to be static constexpr. Also they should be moved to a common
//   data-base of physics constants.
inline double CbmProtonMass() { return 0.938272046; }
inline double CbmNeutronMass() { return 0.939565379; }
inline double CbmElectronMass() { return 0.000510998928; }
 
#endif