jFexSRJetRoI_v1.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
 
// System include(s):
#include <stdexcept>
// xAOD include(s):
#include "xAODCore/AuxStoreAccessorMacros.h"
 
// Local include(s):
#include "xAODTrigger/jFexSRJetRoI.h"
#include "getQuadrant.h"
 
namespace xAOD {
 
  // globalEta/Phi calculation in the FCAL varies depending on position in eta space due to TT granularity change.
  //| Region          |      eta region     | TT (eta x phi)
  //---------------------------------------------------------
  // Region 1  EMB    |      |eta| <  25    | (1 x 1)
  // Region 2  EMIE   | 25 < |eta| < 31     | (2 x 2)
  // Region 3  TRANS  | 31 < |eta| < 32     | (1 x 2)
  // Region 4  FCAL   |      |eta| > 32     | (2 x 4)                 
 
  //eta position in FCAL FPGAs
  const std::vector<int> jFexSRJetRoI_v1::s_FWD_EtaPosition =   {0,  8,   //Region 1 
                                                                 9, 11,   //Region 2
                                                                    12,   //Region 3
                                                                13, 24};  //Region 4
    //eta position of FCAL EM layer as an integer
    //Needs to be modified with firmware values
    const std::vector<int> jFexSRJetRoI_v1::s_FCAL_EtaPosition = {32,34,35,37,38,40,41,43,44,46,47,49};
 
  jFexSRJetRoI_v1::jFexSRJetRoI_v1()
      : SG::AuxElement() {
   }
 
   void jFexSRJetRoI_v1::initialize(uint8_t jFexNumber, uint8_t fpgaNumber, uint32_t tobWord, char istob, int resolution, float_t eta, float_t phi ) {
    
    
     setTobWord( tobWord );
     setjFexNumber( jFexNumber );
     setfpgaNumber( fpgaNumber);
     setTobEt(unpackEtTOB());
     setTobLocalEta( unpackEtaIndex() );
     setTobLocalPhi( unpackPhiIndex() );      
     setTobSat(unpackSaturationIndex());
     setGlobalEta(unpackGlobalEta());
     setGlobalPhi(unpackGlobalPhi()); 
     setEta( eta ); 
     setPhi( phi ); 
     setResolution( resolution );
     setIsTOB(istob);
 
      return;
   }
 
    int jFexSRJetRoI_v1::menuEta() const {
      // adapted from TSU::toTopoInteger
      static const unsigned int RESOLUTION = 40;
        float tmp = eta()*RESOLUTION;
        int index;
        if ( (abs(tmp)-0.5)/2. == std::round((abs(tmp)-0.5)/2.) ) {
            if ( tmp>0 ) { index = std::floor(tmp); }
            else { index = std::ceil(tmp); }
        } else {
            index = std::round(tmp);
        }
        return std::abs(index/4);
    }
 
   //----------------
   //----------------
 
   AUXSTORE_PRIMITIVE_SETTER_AND_GETTER( jFexSRJetRoI_v1, uint32_t, tobWord     , setTobWord    )
   AUXSTORE_PRIMITIVE_SETTER_AND_GETTER( jFexSRJetRoI_v1, uint8_t , jFexNumber  , setjFexNumber )
   AUXSTORE_PRIMITIVE_SETTER_AND_GETTER( jFexSRJetRoI_v1, uint8_t , fpgaNumber  , setfpgaNumber )
   
   
   AUXSTORE_PRIMITIVE_SETTER_AND_GETTER( jFexSRJetRoI_v1, char, isTOB, setIsTOB )      
 
   
   AUXSTORE_PRIMITIVE_SETTER_AND_GETTER( jFexSRJetRoI_v1, uint16_t, tobEt       , setTobEt    )
   AUXSTORE_PRIMITIVE_SETTER_AND_GETTER( jFexSRJetRoI_v1, uint8_t , tobLocalEta , setTobLocalEta )
   AUXSTORE_PRIMITIVE_SETTER_AND_GETTER( jFexSRJetRoI_v1, uint8_t , tobLocalPhi , setTobLocalPhi )
   AUXSTORE_PRIMITIVE_SETTER_AND_GETTER( jFexSRJetRoI_v1, uint8_t , tobSat      , setTobSat   )
 
   AUXSTORE_PRIMITIVE_SETTER_AND_GETTER( jFexSRJetRoI_v1, int , globalEta, setGlobalEta )
   AUXSTORE_PRIMITIVE_SETTER_AND_GETTER( jFexSRJetRoI_v1, uint, globalPhi, setGlobalPhi )
   
   
   AUXSTORE_PRIMITIVE_SETTER_AND_GETTER( jFexSRJetRoI_v1, float, eta, setEta)
   AUXSTORE_PRIMITIVE_SETTER_AND_GETTER( jFexSRJetRoI_v1, float, phi, setPhi)
    
   
   AUXSTORE_PRIMITIVE_SETTER_AND_GETTER( jFexSRJetRoI_v1, int  , tobEtScale, setResolution)      
  
   //-----------------
   //-----------------
 
  //include in future when xTOB in jFEX has been implemented.
   
   
   //jFexSRJetRoI_v1::ObjectType jFexSRJetRoI_v1::type() const {
   //if (Word1() == 0) return TOB;
   //else              return xTOB;
   //}
 
   //Hardware coordinate elements  
 
   //Raw ET on TOB scale (200 MeV/count)
 
    unsigned int jFexSRJetRoI_v1::unpackEtTOB() const{
     //Data content = TOB
     return (tobWord() >> s_etBit) & s_etMask;
   } 
 
 
   //Return an eta index
   unsigned int jFexSRJetRoI::unpackEtaIndex() const {
     return (tobWord() >> s_etaBit) & s_etaMask;
   }
   //Return a phi index
   unsigned int jFexSRJetRoI::unpackPhiIndex() const {
     return (tobWord() >> s_phiBit) & s_phiMask;
   }
 
   //Return sat flag
   unsigned int jFexSRJetRoI::unpackSaturationIndex() const{
     return (tobWord() >> s_satBit) & s_satMask;
   }
 
 
   unsigned int jFexSRJetRoI_v1::et() const {
       // Returns the TOB Et in a 1 MeV scale
       return tobEt()*tobEtScale(); 
   }
 
  // Global coords
  // As the Trigger towers are 1x1 in Eta - Phi coords (x10). This changes in the FCAL, and depends on the eta position
    int jFexSRJetRoI_v1::unpackGlobalEta() const {
        int globalEta = 0;
 
        // this is covering from -2.5 to 2.5 in eta, which means half module 0 and 5 and modules 1, 2, 3 and 4
        if(tobLocalEta()<9){ 
            if(jFexNumber()<3){
                globalEta= 8*(jFexNumber()-2) - (tobLocalEta()+1);
            }
            else if(jFexNumber()<6){
                globalEta= 8*(jFexNumber()-3) + (tobLocalEta());
            }            
        }
        else{
            if(jFexNumber()==5 ) {
                        
                if(tobLocalEta() <=s_FWD_EtaPosition[4]) { //Region 2 and 3
                    globalEta = 25 +2*(tobLocalEta()-9);
                }
                else if(tobLocalEta() <= s_FWD_EtaPosition[6]) { //Region 4
                    globalEta = s_FCAL_EtaPosition[tobLocalEta()-13];
                }        
                
            }
            else if(jFexNumber()==0) {
                
                if(tobLocalEta() <=s_FWD_EtaPosition[4]) { //Region 2 and 3
                    globalEta = -(25 +2*(tobLocalEta()-9))-1;
                }
                else if(tobLocalEta() <= s_FWD_EtaPosition[6]) { //Region 4
                    globalEta = -s_FCAL_EtaPosition[tobLocalEta()-13]-1;
                }
            }            
        }
 
        return globalEta;
    }
 
    uint jFexSRJetRoI_v1::unpackGlobalPhi() const {
        uint globalPhi = 0;
        const unsigned int quadrant = ::getQuadrant(fpgaNumber());
 
        //16 is the phi height of an FPGA
        if(jFexNumber() == 0 || jFexNumber() == 5) {
            
            if(tobLocalEta() <=s_FWD_EtaPosition[1]) { //Region 1
                globalPhi = tobLocalPhi() + (quadrant * 16);
            }
            else if(tobLocalEta() <=s_FWD_EtaPosition[4]) {//Region 2 and Region 3 have the same granularity
                globalPhi = (16*quadrant) + 2*(tobLocalPhi());
            }
            else if(tobLocalEta() <=s_FWD_EtaPosition[6]) {//Region 4
                globalPhi = (16*quadrant) + 4*(tobLocalPhi())+1;
            }
        }
        else { //Modules 1-4
            globalPhi = tobLocalPhi() + (quadrant * 16);
        }
 
        return globalPhi;
    }
 
} // namespace xAOD