eFexTauRoI_v1.h

Go to the documentation of this file.

// Dear emacs, this is -*- c++ -*-
 
/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef XAODTRIGGER_VERSIONS_EFEXTAUROI_V1_H
#define XAODTRIGGER_VERSIONS_EFEXTAUROI_V1_H
 
// System include(s):
extern "C" {
#   include <stdint.h>
}
#include <vector>
#include <string>
 
// xAOD include(s):
#include "AthContainers/AuxElement.h"
 
namespace xAOD {

   class eFexTauRoI_v1 : public SG::AuxElement {
 
   public:
      eFexTauRoI_v1();

      void initialize( unsigned int eFexNumber, unsigned int shelf, uint32_t word0 );
      void initialize( uint32_t word0, uint32_t word1 );

      enum ObjectType {
         xTOB  = 0, 
         TOB   = 1  
      };

      enum AlgoType {
         Heuristic = 0, 
         BDT   = 1  
      };

      uint32_t word0() const;
      uint32_t word1() const;
      void setWord0( uint32_t value );
      void setWord1( uint32_t value );
 
      // Shelf number (decoded from second xTOB word)
      // Usually 0 or 1, but can be 12 for Surface Test Facility.
      unsigned int shelfNumber() const;
 
      // eFEX number (decoded from second xTOB word)
      unsigned int eFexNumber() const;

      float    et() const; 
      void     setEt( float value); 

      float   eta() const; 
      void    setEta( float value); 
      int     iEta() const;  
      unsigned int seed() const; 

      float   phi() const; 
      void    setPhi( float value); 
      int     iPhi() const; 

      int iEtaTopo() const;
      int iPhiTopo() const;
      
      float rCore() const;
      float rHad() const;

      uint16_t rCoreNumerator() const;
      uint16_t rCoreDenominator() const;
      void  setRCoreNumerator( uint16_t value);
      void  setRCoreDenominator( uint16_t value);
      uint16_t rHadNumerator() const;
      uint16_t rHadDenominator() const;
      void  setRHadNumerator( uint16_t value);
      void  setRHadDenominator( uint16_t value);

      char isTOB() const;
      void setIsTOB( char value);

      uint32_t tobWord() const;
      


      unsigned int tobVersion() const;

      ObjectType type() const;
 

      unsigned int fpga() const;

      unsigned int fpgaEta() const;

      unsigned int fpgaPhi() const;

      bool upNotDown() const;

      unsigned int etTOB() const;

      unsigned int etXTOB() const;

      unsigned int rCoreThresholds() const;

      unsigned int bdtThresholds() const;

      unsigned int rHadThresholds() const;

      unsigned int tauOneThresholds() const;

      unsigned int tauTwoThresholds() const;

      unsigned int tauThreeThresholds() const;

      bool seedMax() const;
 
      //? Bunch crossing number (last 4 bits, xTOB only)
      unsigned int bcn4() const;

      unsigned int bdtScore() const;
 
   private:

      float computeEta() const;

      static const float s_tobEtScale;
      static const float s_xTobEtScale;
      static const float s_towerEtaWidth;
 

 
      //  Data locations within word
      static const int s_fpgaBit         = 30;
      static const int s_etaBit          = 27;
      static const int s_phiBit          = 24;
      static const int s_veto3Bit        = 22;
      static const int s_veto2Bit        = 20;
      static const int s_veto1Bit        = 18;
      static const int s_seedBit         = 16;
      static const int s_updownBit       = 15;
      static const int s_maxBit          = 14;
      static const int s_versionBit      = 12;
      static const int s_etBit           =  0;
      static const int s_etBitXTOB       =  2;
      static const int s_bcn4Bit         = 28;
      static const int s_shelfBit        = 24;
      static const int s_eFexBit         = 20;
      static const int s_bdtScoreBit     =  0;
 
      //  Data masks
      static const int s_fpgaMask        = 0x3;
      static const int s_etaMask         = 0x7;
      static const int s_phiMask         = 0x7;
      static const int s_veto1Mask       = 0x3;
      static const int s_veto2Mask       = 0x3;
      static const int s_veto3Mask       = 0x3;
      static const int s_seedMask        = 0x3;
      static const int s_updownMask      = 0x1;
      static const int s_maxMask         = 0x1;
      static const int s_versionMask     = 0x3;
      static const int s_etMask          = 0xfff;
      static const int s_etFullMask      = 0xffff;
      static const int s_bcn4Mask        = 0xf;
      static const int s_eFexMask        = 0xf;
      static const int s_shelfMask       = 0xf;
      static const int s_bdtScoreMask    = 0xfff;
 
      // For decoding coordinates
      // 
      static const int s_numPhi          = 64;
      static const int s_eFexPhiMask     = 0xf;
      static const int s_eFexPhiBit      =  0;
      static const int s_eFexPhiWidth    =  8;
      static const int s_eFexPhiOffset   =  2;
      static const int s_eFexEtaMask     = 0xf;
      static const int s_eFexEtaBit      =  4;
      static const int s_eFexEtaWidth    =  16;
      static const int s_fpgaEtaWidth    =  4;
      static const int s_shelfPhiWidth   =  4;
      static const int s_minEta          = -25;
 
   }; // class eFexTauRoI_v1
 
} // namespace xAOD
 
// Declare the inheritance of the type:
#include "xAODCore/BaseInfo.h"
SG_BASE( xAOD::eFexTauRoI_v1, SG::AuxElement );
 
#endif // XAODTRIGGER_VERSIONS_EFEXTAUROI_V1_H