SREnums.h

 
// \file    SREnums.h
// \brief   Consolidated headers so that they can be included by Proxy
// \author  J. Wolcott <jwolcott@fnal.gov>
// \date    Mar. 2023
 
#ifndef DUNEANAOBJ_SRENUMS_H
#define DUNEANAOBJ_SRENUMS_H
 
#include <cstddef>
#include <limits>
 
namespace caf
{
  enum Detector : std::size_t
  {
    kUnknownDet = 0,
 
    // full NDs in Phase I or Phase II
    kND_LAr  = 1,  
    kND_TMS  = 2,  
    kND_SAND = 3,  
    kND_GAr  = 4,  
 
    // ND prototypes (more to add?)
    k2x2     = 5,  
    kMINERvA = 6,  
 
    // leaving some space for expansion ...
 
    // full FDs (Phase II modules TBD...)
    kFD_HD = 10,   
    kFD_VD = 11,   
 
    // space for modules 3 and 4...
 
    // FD prototypes  (we don't have any ProtoDUNE-VD data that will be CAFfed?)
    kProtoDUNE = 15,  
 
    _kLastDetector = 24  
  };
 
 
  enum Generator
  {
    kUnknownGenerator = 0,
    kGENIE            = 1,
    kGIBUU            = 2,
    kNEUT             = 3,
    kCRY              = 4,
    kNuWro            = 5,
    kMARLEY           = 6,
    kCORSIKA          = 7,
    kGEANT            = 8
 
  };
 
  enum PartEMethod
  {
    kUnknownMethod,
    kRange,         
    kMCS,           
    kCalorimetry,   
    kVisibleEnergy, 
  };
 
  enum ScatteringMode
  {
    kUnknownMode               = -100,
    kQE                        = 1,
    kSingleKaon                = 2,
    kDIS                       = 3,
    kRes                       = 4,
    kCoh                       = 5,
    kDiffractive               = 6,
    kNuElectronElastic         = 7,
    kInvMuonDecay              = 8,
    kAMNuGamma                 = 9,
    kMEC                       = 10,
    kCohElastic                = 11,
    kInverseBetaDecay          = 12,
    kGlashowResonance          = 13,
    kIMDAnnihilation           = 14,
    kPhotonCoh                 = 15,
    kPhotonRes                 = 16,
    kDarkMatterElastic         = 101,
    kDarkMatterDIS             = 102,
    kDarkMatterElectron        = 103,
  };
 
  // ----------------------------------------------------------------------
  // now some enums that are used internally so one branch can easily refer to another
 
  class TrueParticleID
  {
    public:
    
      enum PartType { kUnknown, kPrimary, kPrimaryBeforeFSI, kSecondary };
 
      int      ixn  = -1;       
      PartType type = kUnknown; 
      int      part = -1;       
  };
  
  class FlashMatch
  {
    private:
 
      static constexpr float NaN = std::numeric_limits<float>::signaling_NaN();
 
    public:
    
      int   id            = -1;  
      float time          = NaN; 
      float total_pe      = NaN; 
      float hypothesis_pe = NaN; 
  };
 
  class SRRecoParticleID
  {
    public:
      enum SRRecoParticleCollectionType
      {
        kUnknown,
        kSPINE,
        kPandora,
        kPida,
        kSandreco
      };
 
    int ixn = -1;                                                               
    SRRecoParticleCollectionType type = SRRecoParticleCollectionType::kUnknown; 
    int ipart = -1;                                                             
 
    inline operator bool() const { return !(type == SRRecoParticleCollectionType::kUnknown || ixn < 0 || ipart < 0); }; 
  };
 
  class SRRecoBaseID
  {
    public:
      enum SRRecoBaseCollectionType {
          kUnknown             = 0,
          // FD
          kFDHDPandoraTrack    = 1,
          KFDHDPandoraShower   = 2,
          KFDHDPandoraPFP      = 3,
          kFDVDPandoraTrack    = 4,
          KFDVDPandoraShower   = 5,
          KFDVDPandoraPFP      = 6,
          kFDPDHDPandoraTrack  = 7,
          KFDPDHDPandoraShower = 8,
          KFDPDHDPandoraPFP    = 9,
          kFDPDVDPandoraTrack  = 10,
          KFDPDVDPandoraShower = 11,
          KFDPDVDPandoraPFP    = 12,
          // NDLAr
          kNDLArDLPTrack       = 13,
          kNDLArDLPShower      = 14,
          kNDLArPandoraTrack   = 15,
          kNDLARPandoraShower  = 16,
          // TMS
          kTMSTrack            = 17,
          // SAND
          // NB: a new SAND subdetector collection must also be added to SRSANDObjID::operator bool()
          kSANDGRAINTrack      = 18,
          kSANDGRAINShower     = 19,
          kSANDTrackerTrack    = 20,
          kSANDTrackerShower   = 21,
          kSANDECalCluster     = 22,
          kSANDAssn            = 25,  
          // GAr
          kGArTrack            = 23,
          kGArEcalCluster      = 24
      };
 
    int      ixn   = -1;                                                 
    SRRecoBaseCollectionType type = SRRecoBaseCollectionType::kUnknown;  
    int      irecoobj = -1;                                              
 
    inline operator bool() const { return !(type == SRRecoBaseCollectionType::kUnknown || ixn < 0 || irecoobj < 0); }; 
  };
 
  class SRSANDObjID
  {
    public:
      SRRecoBaseID::SRRecoBaseCollectionType type = SRRecoBaseID::kUnknown; 
      int                                    idx  = -1;                     
 
      inline operator bool() const 
      {
        bool isSANDSubdet = type == SRRecoBaseID::kSANDGRAINTrack || type == SRRecoBaseID::kSANDGRAINShower
                            || type == SRRecoBaseID::kSANDTrackerTrack || type == SRRecoBaseID::kSANDTrackerShower
                            || type == SRRecoBaseID::kSANDECalCluster;
        return isSANDSubdet && idx >= 0;
      }
  };
 
  enum FD_RECO_STACK
  {
    kUnknownFDReco,
    kPandoraFD
  };
 
  enum NDLAR_RECO_STACK
  {
    kUnknownNDLArReco,
    kDeepLearnPhys,
    kPandoraNDLAr
  };
 
 
    enum NDRecoMatchType
  {
    kUndeclared = 0, 
    kSimple = 1,  
    kUniqueNoTime = 2,  
    kUniqueWithTime = 3 
  };
  
  enum RecoObjType
  {
    kUnknownRecoObj = -1, 
    kTrack          = 1,  
    kShower         = 2,  
    kHitCollection  = 3,  
  };
 
}
 
 
#endif //DUNEANAOBJ_SRENUMS_H