MuCTPI_DataWord_Decoder.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
 
// Local/Trigger include(s):
#include "TrigT1Result/MuCTPI_DataWord_Decoder.h"
#include "TrigT1MuctpiBits/MuCTPI_Bits.h"
 
// Gaudi/Athena include(s):
#include "GaudiKernel/Bootstrap.h"
#include "GaudiKernel/ISvcLocator.h"
#include "GaudiKernel/IMessageSvc.h"
#include "GaudiKernel/MsgStream.h"
#include "GaudiKernel/StatusCode.h"
MuCTPI_DataWord_Decoder::MuCTPI_DataWord_Decoder( uint32_t dataword )
  : m_dataWord( dataword ) {
 
}

uint16_t MuCTPI_DataWord_Decoder::getSectorOverflow() const {
  return ((m_dataWord >> LVL1::MuCTPIBits::CAND_OVERFLOW_SHIFT) &
      LVL1::MuCTPIBits::CAND_OVERFLOW_MASK);
}

uint16_t MuCTPI_DataWord_Decoder::getRoiOverflow() const {
  return ((m_dataWord >> LVL1::MuCTPIBits::ROI_OVERFLOW_SHIFT) &
      LVL1::MuCTPIBits::ROI_OVERFLOW_MASK);
}

uint16_t MuCTPI_DataWord_Decoder::getRoiNumber() const {
 
  uint16_t roi = 0;
  switch( getSectorLocation() ) {
  case MuCTPI_RDO::ENDCAP:
    roi = (m_dataWord >> LVL1::MuCTPIBits::ROI_SHIFT) & LVL1::MuCTPIBits::ENDCAP_ROI_MASK;
    break;
  case MuCTPI_RDO::FORWARD:
    roi = (m_dataWord >> LVL1::MuCTPIBits::ROI_SHIFT) & LVL1::MuCTPIBits::FORWARD_ROI_MASK;
    break;
  case MuCTPI_RDO::BARREL:
    roi = (m_dataWord >> LVL1::MuCTPIBits::ROI_SHIFT) & LVL1::MuCTPIBits::BARREL_ROI_MASK;
    break;
  default:
    roi = 99;
    break;
  }
 
  return roi;
}

uint16_t MuCTPI_DataWord_Decoder::getOverlapBits() const {
 
  uint16_t ol = 0;
  switch( getSectorLocation() ) {
  case MuCTPI_RDO::ENDCAP:
    ol = (m_dataWord >> LVL1::MuCTPIBits::ENDCAP_OL_SHIFT) & LVL1::MuCTPIBits::ENDCAP_OL_MASK;
    break;
  case MuCTPI_RDO::FORWARD:
    ol = 0;
    break;
  case MuCTPI_RDO::BARREL:
    ol = (m_dataWord >> LVL1::MuCTPIBits::BARREL_OL_SHIFT) & LVL1::MuCTPIBits::BARREL_OL_MASK;
    break;
  default:
    ol = 99;
    break;
  }
 
  return ol;
}

MuCTPI_RDO::SectorLocation MuCTPI_DataWord_Decoder::getSectorLocation() const {
 
  if( getSectorAddress() & LVL1::MuCTPIBits::ENDCAP_ADDRESS_MASK ) {
    return MuCTPI_RDO::ENDCAP;
  } else if( getSectorAddress() & LVL1::MuCTPIBits::FORWARD_ADDRESS_MASK ) {
    return MuCTPI_RDO::FORWARD;
  } else {
    return MuCTPI_RDO::BARREL;
  }
}

uint16_t MuCTPI_DataWord_Decoder::getSectorAddress() const {
  return ((m_dataWord >> LVL1::MuCTPIBits::CAND_SECTOR_ADDRESS_SHIFT) &
      LVL1::MuCTPIBits::CAND_SECTOR_ADDRESS_MASK);
}

uint16_t MuCTPI_DataWord_Decoder::getSectorID(bool newScheme) const {
 
  if( getSectorLocation() == MuCTPI_RDO::ENDCAP ) {
    return ((getSectorAddress() >> 1) & LVL1::MuCTPIBits::ENDCAP_SECTORID_MASK);
  } 
  else if( getSectorLocation() == MuCTPI_RDO::BARREL ) {
    if(newScheme)
      return ((getSectorAddress() >> 1) & LVL1::MuCTPIBits::BARREL_SECTORID_MASK);
    else{
      uint16_t id = (getSectorAddress() >> 1) & LVL1::MuCTPIBits::BARREL_SECTORID_MASK;
      if( getHemisphere() ) id += 32;
      return id;
    }
  }
  else if( getSectorLocation() == MuCTPI_RDO::FORWARD ) {
    return ((getSectorAddress() >> 1) & LVL1::MuCTPIBits::FORWARD_SECTORID_MASK);
  }
  return 0;
}

uint16_t MuCTPI_DataWord_Decoder::getHemisphere() const {
  return (getSectorAddress() & LVL1::MuCTPIBits::SECTOR_HEMISPHERE_MASK);
}

uint16_t MuCTPI_DataWord_Decoder::getPt() const {
  return ((m_dataWord >> LVL1::MuCTPIBits::CAND_PT_SHIFT) &
      LVL1::MuCTPIBits::CAND_PT_MASK);
}

 
uint16_t MuCTPI_DataWord_Decoder::getBCID() const {
  return ((m_dataWord >> LVL1::MuCTPIBits::CAND_BCID_SHIFT) &
      LVL1::MuCTPIBits::CAND_BCID_MASK);
}

 
uint16_t MuCTPI_DataWord_Decoder::getCandidateIsHighestPt() const {
  return ((m_dataWord >> LVL1::MuCTPIBits::CAND_HIGHEST_PT_SHIFT) &
      LVL1::MuCTPIBits::CAND_HIGHEST_PT_MASK);
}

 
uint16_t MuCTPI_DataWord_Decoder::getSentRoi() const {
  return ((m_dataWord >> LVL1::MuCTPIBits::CAND_SENT_ROI_SHIFT) &
      LVL1::MuCTPIBits::CAND_SENT_ROI_MASK);
}

uint16_t MuCTPI_DataWord_Decoder::getSign() const {
 
   // This bit is not defined for barrel candidates:
   if( getSectorLocation() == MuCTPI_RDO::BARREL ) {
      return 100;
   }
 
   return ( ( m_dataWord >> LVL1::MuCTPIBits::CAND_TGC_CHARGE_SIGN_SHIFT ) &
            0x1 );
}

uint16_t MuCTPI_DataWord_Decoder::getVetoed() const {
 
   return ( ( m_dataWord >> LVL1::MuCTPIBits::CAND_VETO_SHIFT )
            & 0x1 );
}

void MuCTPI_DataWord_Decoder::dumpData() const {
 
  SmartIF<IMessageSvc> msgSvc{Gaudi::svcLocator()->service("MessageSvc")};
  if ( !msgSvc ) {
    return;
  }
  MsgStream log( msgSvc, "MuCTPI_DataWord_Decoder" );
  dumpData( log );
 
  return;
}

void MuCTPI_DataWord_Decoder::dumpData( MsgStream& log ) const {
 
  uint16_t sectorLocation = getSectorLocation();
  std::string locString = "BARREL";
  if( sectorLocation == MuCTPI_RDO::ENDCAP ) locString = "ENDCAP";
  else if( sectorLocation == MuCTPI_RDO::FORWARD ) locString = "FORWARD";
  uint16_t candHighestPt = getCandidateIsHighestPt();
  std::string isHigh = "NO";
  if( candHighestPt ) isHigh = "YES";
  uint16_t candSentRoi = getSentRoi();
  std::string sentRoi = "NO";
  if( candSentRoi ) sentRoi = "YES";
  uint16_t secOf = getSectorOverflow();
  std::string ofString = "NO";
  if( secOf ) ofString = "YES";
  uint16_t roiOf = getRoiOverflow();
  std::string roiString = "NO";
  if( roiOf ) roiString = "YES";
  uint16_t ol = getOverlapBits();
  std::string olString = "NO";
  if( ol ) olString = "YES";
 
  log << MSG::DEBUG << "Data word         :   0x" << MSG::hex << m_dataWord << MSG::dec << endmsg;
  log << MSG::DEBUG << "BCID              :   " << getBCID() << endmsg;
  log << MSG::DEBUG << "Pt                :   " << getPt() << endmsg;
  log << MSG::DEBUG << "Is highest Pt     :   " << isHigh << endmsg;
  log << MSG::DEBUG << "RoI ID            :   " << getRoiNumber() << endmsg;
  log << MSG::DEBUG << "Sent RoI          :   " << sentRoi << endmsg;
  log << MSG::DEBUG << "Sector address    :   0x" << MSG::hex << getSectorAddress() << MSG::dec << endmsg;
  log << MSG::DEBUG << "Sector ID         :   " << getSectorID() << endmsg;
  log << MSG::DEBUG << "Sector location   :   " << locString << endmsg;
  log << MSG::DEBUG << "Sector overflow   :   " << ofString << endmsg;
  log << MSG::DEBUG << "RoI overflow      :   " << roiString << endmsg;
  log << MSG::DEBUG << "Overlap found     :   " << olString << endmsg;
  log << MSG::DEBUG << "Hemisphere        :   " << getHemisphere() << endmsg;
  log << MSG::DEBUG << "=================================================" << endmsg;
 
  return;
}