TauDefs.h

Go to the documentation of this file.

// Dear emacs, this is -*- c++ -*-
 
/*
  Copyright (C) 2002-2021 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef XAODTAU_TAUDEFS_H
#define XAODTAU_TAUDEFS_H
 
// Local include(s):
#include "Math/Vector4D.h"
#include <bitset>

namespace xAOD {
  typedef ROOT::Math::LorentzVector<ROOT::Math::PtEtaPhiM4D<float> > PtEtaPhiMVectorF;
 
    /* define type traits for xAOD Tau.
     * needs to be outside of the TauJet namespace
     */
    // empty return type for all types T.
    // Leads to a compilation failure if one tries to use it with other types then a specialization is given for.
    template <class T>
    struct xAODTAU_return_type;
 
    // specialization for ints
    template <>
    struct xAODTAU_return_type<int> { typedef int type; };
 
    // specialization for floats
    template <>
    struct xAODTAU_return_type<float> { typedef float type; };
 
 
namespace TauJetParameters
{
    //-------------------------------------------------------------------------
    // DO NOT CHANGE THE ORDER OF THE ENUMS!
    // You can add, but changing the order may lead to disaster!
    //-------------------------------------------------------------------------
 
    //-------------------------------------------------------------------------
    //-------------------------------------------------------------------------
    enum TauID
      {
    // = 0,
    EleMatchLikelihoodScore = 1, 
        Likelihood = 2, //deprecated
        // = 3,
        // = 4,
        // = 5,
        // = 6,
        // = 7,
        // = 8,
        // = 9,
        // = 10,
        // = 11,
        // = 12,
        // = 13,
        // = 14,
        BDTJetScore           = 15,
        BDTEleScore           = 16,
        SafeLikelihood = 17, //deprecated
        BDTJetScoreSigTrans   = 18, // new
        // = 19,  // new
        PanTauScore= 20, //deprecated
        RNNJetScore           = 21,
        RNNJetScoreSigTrans   = 22, // new
        RNNEleScore           = 23,
        RNNEleScoreSigTrans   = 24 // new
      };
 
    //-------------------------------------------------------------------------
    //-------------------------------------------------------------------------
    enum VetoFlags
    {
        ElectronFlag  = 0,
        EgammaFlag    = 1,
        MuonFlag      = 2
    };
 
    //-------------------------------------------------------------------------
    //-------------------------------------------------------------------------
    enum IsTauFlag
      {
    PassEleOLR = 0, 
    // = 1, 
    // = 2, 
    // = 3, 
        MuonVeto   = 4,
    // = 5, 
    // = 6, 
    // = 7, 
        // = 8, 
        // = 9, 
        // = 10,
        // = 11,
        // = 12,
        // = 13,
        // = 14,
        EleRNNLoose  = 15,
        EleRNNMedium = 16,
        EleRNNTight  = 17,
    JetBDTSigVeryLoose      = 18, // new in r21
        JetBDTSigLoose          = 19, // rename (add sig)
        JetBDTSigMedium         = 20, // rename (add sig)
        JetBDTSigTight          = 21, // rename (add sig)
        EleBDTLoose          = 22,
        EleBDTMedium         = 23,
        EleBDTTight          = 24,
        JetBDTBkgLoose       = 25, // new
        JetBDTBkgMedium      = 26, // new
        JetBDTBkgTight       = 27, // new
    JetRNNSigVeryLoose      = 28,
        JetRNNSigLoose          = 29,
        JetRNNSigMedium         = 30,
        JetRNNSigTight          = 31, // DON'T USE ANYTHING ABOVE 31, IsTauFlag is encoded on 32 bits!
      };
 
    //-------------------------------------------------------------------------
    //-------------------------------------------------------------------------
    enum Detail
    {
      ipZ0SinThetaSigLeadTrk=0,
      etOverPtLeadTrk=1,
      leadTrkPt=2,
      ipSigLeadTrk=3,
      massTrkSys=4,
      trkWidth2=5,
      trFlightPathSig=6,
      // etEflow=7,//r21 cleanup
      // mEflow=8,//r21 cleanup
      // /// name accessors for electron LLH variables
      // ele_E237E277=9,//r21 cleanup
      // ele_PresamplerFraction=10,//r21 cleanup
      // ele_ECALFirstFraction=11,//r21 cleanup
      //name accessors for topocluster ID variables
      numCells=12,
      numTopoClusters=13,
      numEffTopoClusters=14,
      topoInvMass=15,
      effTopoInvMass=16,
      topoMeanDeltaR=17,
      effTopoMeanDeltaR=18,
      //
      // Applicable for calo seeded tau reconstruction
      //
      EMRadius=19,
      hadRadius=20,
      etEMAtEMScale=21,
      etHadAtEMScale=22,
      isolFrac=23,
      centFrac=24,
      stripWidth2=25,
      nStrip=26,
      // etEMCalib=27,//r21 cleanup
      // etHadCalib=28,//r21 cleanup
      //      seedCalo_eta=29,//r21 cleanup same as detectorAxis Eta
      //      seedCalo_phi=30,//r21 cleanup same as detectorAxis Phi
      trkAvgDist=31,
      trkRmsDist=32,
      lead2ClusterEOverAllClusterE=33,
      lead3ClusterEOverAllClusterE=34,
      caloIso=35,
      caloIsoCorrected=36,
      dRmax=37,
    

      secMaxStripEt=38,
      sumEMCellEtOverLeadTrkPt=39,
      hadLeakEt=40,

      //EM_TES_scale=41,//r21 cleanup
      //LC_TES_precalib=42,//r21 cleanup
 
 
      //
      // Cell-based energies in rings getters/setters
      //
      cellBasedEnergyRing1=43,
      cellBasedEnergyRing2=44,
      cellBasedEnergyRing3=45,
      cellBasedEnergyRing4=46,
      cellBasedEnergyRing5=47,
      cellBasedEnergyRing6=48,
      cellBasedEnergyRing7=49,
      TRT_NHT_OVER_NLT=50,
      TauJetVtxFraction=51,
 
      //substructure details
      //nPi0=52,//r21 cleanup
      nCharged=53,
      //ptRatioEflow=54,//r21 cleanup
      
      //nPi0Topo=55, //deprecated//r21 cleanup
      //nChargedTopo=56,//r21 cleanup
      //etEflowTopo=57,//r21 cleanup
      //mEflowTopo=58,//r21 cleanup
      //ptRatioEflowTopo=59,//r21 cleanup
      
 
      //trigger details
      PSSFraction=60,
      ChPiEMEOverCaloEME=61,
      EMPOverTrkSysP=62,
      
      //for TES parameters
      TESOffset=63,
      TESCalibConstant=64,
 
      centFracCorrected=65,
      etOverPtLeadTrkCorrected=66,
      innerTrkAvgDist=67,
      innerTrkAvgDistCorrected=68,
      SumPtTrkFrac=69,
      SumPtTrkFracCorrected=70,
      
      mEflowApprox=71,
      ptRatioEflowApprox=72,

      ipSigLeadTrkCorrected=73,
      trFlightPathSigCorrected=74,
      massTrkSysCorrected=75,
      dRmaxCorrected=76,
      ChPiEMEOverCaloEMECorrected=77,
      EMPOverTrkSysPCorrected=78,
      ptRatioEflowApproxCorrected=79,
      mEflowApproxCorrected=80,
 
 
 
      //currently dynamic enums
      // CaloSamplingEtaEM
      // CaloSamplingEtaHad
      // CaloSamplingPhiEM
      // CaloSamplingPhiHad
      ClustersMeanCenterLambda=100,
      ClustersMeanEMProbability=101,
      ClustersMeanFirstEngDens=102,
      ClustersMeanSecondLambda=103,
      ClustersMeanPresamplerFrac=104,
      GhostMuonSegmentCount=105,//this is just a copy of the jet-seed detail
      PFOEngRelDiff=106,
      LC_pantau_interpolPt=107,
      electronLink=108,
      
      nChargedTracks=109,
      nIsolatedTracks=110,
      nModifiedIsolationTracks=111,//no static variable for now
      nAllTracks=112,
      nLargeRadiusTracks=113,
 
    };
 
 
  //-------------------------------------------------------------------------
    //-------------------------------------------------------------------------
    enum TauCalibType
    {
        JetSeed=0,
        DetectorAxis=1,
        IntermediateAxis=2,
        TauEnergyScale=3,
        TauEtaCalib=4,
        // =5,  
        // =6,   
        PanTauCellBasedProto=7, //4-vector by using CellBased pfos in seed
        PanTauCellBased=8,  //4-vector by adjusting CellBased pfos using decay mode
        TrigCaloOnly=9,
        FinalCalib=10,
    };
 
 
   
  //-------------------------------------------------------------------------
  //-------------------------------------------------------------------------
  enum PanTauDetails
    {
      //Flag whether this seed has pantau info
      PanTau_isPanTauCandidate=0,
      //decay modes (input mode [proto] and output mode )
      PanTau_DecayModeProto=1,
      PanTau_DecayMode=2,
      //BDT output distributions
      PanTau_BDTValue_1p0n_vs_1p1n=3,
      PanTau_BDTValue_1p1n_vs_1pXn=4,
      PanTau_BDTValue_3p0n_vs_3pXn=5,
      //Variables used in BDTs
      PanTau_BDTVar_Basic_NNeutralConsts=6,
      PanTau_BDTVar_Charged_JetMoment_EtDRxTotalEt=7,
      PanTau_BDTVar_Charged_StdDev_Et_WrtEtAllConsts=8,
      PanTau_BDTVar_Neutral_HLV_SumM=9,
      PanTau_BDTVar_Neutral_PID_BDTValues_BDTSort_1=10,
      PanTau_BDTVar_Neutral_PID_BDTValues_BDTSort_2=11,
      PanTau_BDTVar_Neutral_Ratio_1stBDTEtOverEtAllConsts=12,
      PanTau_BDTVar_Neutral_Ratio_EtOverEtAllConsts=13,
      PanTau_BDTVar_Neutral_Shots_NPhotonsInSeed=14,
      PanTau_BDTVar_Combined_DeltaR1stNeutralTo1stCharged=15,
      PanTau_DecayModeExtended=16,
      
      // new variables for pantau BDT
      PanTau_BDTVar_Charged_HLV_SumM=32,
 
    };
  
  
  enum DecayMode 
    {
      Mode_1p0n=0,
      Mode_1p1n=1,
      Mode_1pXn=2,
      Mode_3p0n=3,
      Mode_3pXn=4,
      Mode_Other=5,   // for 2p, 4p, 5p taus
      Mode_NotSet=6,  // for 0p, >= 6p
      Mode_Error=7,    // use this as initialisation
    };
 
  //-------------------------------------------------------------------------
  //-------------------------------------------------------------------------
  enum TauTrackFlag
    {
      isConversionOld    = 0,
      failTrackFilter = 1,
      coreTrack = 2, //all tracks dR<0.2
      wideTrack = 3, //all tracks 0.2<dR<0.4
      passTrkSelector = 4, // pass the old track selector tool;  old tau tracks are coreTrack&passTrkSelector
      classifiedCharged    = 5, // classified as charged track from tau decay
      classifiedIsolation  = 6, // track from the same interaction as the tau candidate: to be used for isolation
      classifiedConversion = 7, // classified as conversion by the global track classifier
      classifiedFake       = 8, // track classified as pileup or fake tracks (should not be used for isolation computation)
      unclassified         = 9,  // helper enum for not yet classified tracks
      passTrkSelectionTight = 10, //pass the xAOD Tight track selection
      modifiedIsolationTrack = 11, //passTrkSelector && !classifiedCharged
      LargeRadiusTrack = 12, // Large Radius Track
      //if you add another flag, you'll need to check the track sorting alg, it assumes unclassified is the last flag *This should be fixed in TauTrackClassifier now*
      //Track sorting just requires that the classifiedXXX bits are consecutive, charged is first (of classifiedXXX), and fake is last (of classifiedXXX)
    };
 
  enum TrackDetail
    {
      CaloSamplingEtaEM = 0,
      CaloSamplingEtaHad = 1,
      CaloSamplingPhiEM = 2,
      CaloSamplingPhiHad = 3,
    };
 
}//end namespace TauJetParameters
 
}
 
#endif // XAODTAU_TAUDEFS_H