MuCTPI_DataWord_Decoder Class Reference

Class helping to decode the MuCTPI data words. More...

#include <MuCTPI_DataWord_Decoder.h>

Collaboration diagram for MuCTPI_DataWord_Decoder:

Public Member Functions
	MuCTPI_DataWord_Decoder (uint32_t dataword=0)
	Constructor.
	~MuCTPI_DataWord_Decoder ()=default
	Destructor.
uint16_t	getSectorOverflow () const
	Flag showing whether there were more than 2 candidates in this candidate's sector.
uint16_t	getRoiOverflow () const
	Flag showing whether there was more than 1 candidate in this candidate's RoI.
uint16_t	getRoiNumber () const
	RoI number (sub-sector in which the candidate was detected)
uint16_t	getOverlapBits () const
	2-bit overlap bits given to the candidate by the SL
MuCTPI_RDO::SectorLocation	getSectorLocation () const
	The system that detected the muon candidate.
uint16_t	getSectorAddress () const
	8-bit address of the sector that detected the candidate
uint16_t	getSectorID (bool newScheme=0) const
	Number of the sector that detected the candidate.
uint16_t	getHemisphere () const
	The hemisphere in which the candidate was detected.
uint16_t	getPt () const
	3-bit pT threshold of the candidate
uint16_t	getBCID () const
	3-bit BCID fragment saved with the candidate
uint16_t	getCandidateIsHighestPt () const
	Flag showing whether the candidate had the highest pT in its sector.
uint16_t	getSentRoi () const
	Flag showing whether the candidate was sent to the RoIB.
uint16_t	getSign () const
	Get the candidate's sign (0=negative, 1=positive, 100=undefined)
uint16_t	getVetoed () const
	Flag showing if the candidate was vetoed in the multiplicity sum.
void	setWord (uint32_t word)
	Function setting the MuCTPI data word.
uint32_t	getWord () const
	Function returning the MuCTPI data word.
void	dumpData () const
	Function dumping the stored information to the message stream.
void	dumpData (MsgStream &log) const
	Function dumping the stored information to the message stream.

Private Attributes
uint32_t	m_dataWord
	The 32-bit data word to decode.

Detailed Description

Class helping to decode the MuCTPI data words.

Date

2007-07-05 13:26:22

   The data words of the MuCTPI readout data contain a lot of information
   about the LVL1 muon candidates in a tightly encoded fashion. This class
   can be used to easily extract all stored information from these 32-bit
   words.

   For a detailed description of the data format of the MuCTPI, see
   the MIROD documentation (https://edms.cern.ch/file/248757/1/mirod.pdf).

Author

David Berge David.nosp@m..Ber.nosp@m.ge@ce.nosp@m.rn.c.nosp@m.h

Version

Revision

1.5

Definition at line 37 of file MuCTPI_DataWord_Decoder.h.

Constructor & Destructor Documentation

MuCTPI_DataWord_Decoder()

MuCTPI_DataWord_Decoder::MuCTPI_DataWord_Decoder

(

uint32_t

dataword = 0

)

Constructor.

The constructor only has to give an initial value to MuCTPI_DataWord_Decoder::m_dataWord stored in the object.

Parameters

dataword

The 32-bit MuCTPI data word that you want to decode

Definition at line 21 of file MuCTPI_DataWord_Decoder.cxx.

  : m_dataWord( dataword ) {
 
}

~MuCTPI_DataWord_Decoder()

MuCTPI_DataWord_Decoder::~MuCTPI_DataWord_Decoder ( )

default

Destructor.

Member Function Documentation

dumpData() [1/2]

void MuCTPI_DataWord_Decoder::dumpData

(

)

const

Function dumping the stored information to the message stream.

This function is not responsible for actually printing the information, it just creates a message stream to print the information to with MuCTPI_DataWord_Decoder::dumpData(MsgStream&) const.

Definition at line 204 of file MuCTPI_DataWord_Decoder.cxx.

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

dumpData() [2/2]

void MuCTPI_DataWord_Decoder::dumpData

(

MsgStream &

log

)

const

Function dumping the stored information to the message stream.

Function printing the decodable information of the MuCTPI data word in an easy-to-read fashion.

Parameters

log	A message stream to print the information to

Definition at line 221 of file MuCTPI_DataWord_Decoder.cxx.

                                                             {
 
  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;
}

getBCID()

uint16_t MuCTPI_DataWord_Decoder::getBCID

(

)

const

3-bit BCID fragment saved with the candidate

Returns

3-bit BCID fragment saved with the candidate

Definition at line 154 of file MuCTPI_DataWord_Decoder.cxx.

                                                {
  return ((m_dataWord >> LVL1::MuCTPIBits::CAND_BCID_SHIFT) &
      LVL1::MuCTPIBits::CAND_BCID_MASK);
}

getCandidateIsHighestPt()

uint16_t MuCTPI_DataWord_Decoder::getCandidateIsHighestPt

(

)

const

Flag showing whether the candidate had the highest p_T in its sector.

Returns

flag showing whether the candidate had the highest p_T in its sector

Definition at line 163 of file MuCTPI_DataWord_Decoder.cxx.

                                                                {
  return ((m_dataWord >> LVL1::MuCTPIBits::CAND_HIGHEST_PT_SHIFT) &
      LVL1::MuCTPIBits::CAND_HIGHEST_PT_MASK);
}

getHemisphere()

uint16_t MuCTPI_DataWord_Decoder::getHemisphere

(

)

const

The hemisphere in which the candidate was detected.

Returns

hemisphere in which the candidate was detected

Definition at line 138 of file MuCTPI_DataWord_Decoder.cxx.

                                                      {
  return (getSectorAddress() & LVL1::MuCTPIBits::SECTOR_HEMISPHERE_MASK);
}

getOverlapBits()

uint16_t MuCTPI_DataWord_Decoder::getOverlapBits

(

)

const

2-bit overlap bits given to the candidate by the SL

Returns

2-bit overlap bits given to the candidate by the Sector Logic

Definition at line 69 of file MuCTPI_DataWord_Decoder.cxx.

                                                       {
 
  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;
}

getPt()

uint16_t MuCTPI_DataWord_Decoder::getPt

(

)

const

3-bit p_T threshold of the candidate

Returns

3-bit p_T threshold of the candidate

Definition at line 145 of file MuCTPI_DataWord_Decoder.cxx.

                                              {
  return ((m_dataWord >> LVL1::MuCTPIBits::CAND_PT_SHIFT) &
      LVL1::MuCTPIBits::CAND_PT_MASK);
}

getRoiNumber()

uint16_t MuCTPI_DataWord_Decoder::getRoiNumber

(

)

const

RoI number (sub-sector in which the candidate was detected)

Returns

RoI number

Definition at line 45 of file MuCTPI_DataWord_Decoder.cxx.

                                                     {
 
  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;
}

getRoiOverflow()

uint16_t MuCTPI_DataWord_Decoder::getRoiOverflow

(

)

const

Flag showing whether there was more than 1 candidate in this candidate's RoI.

Returns

flag showing whether there was more than 1 candidate in this candidate's RoI

Definition at line 37 of file MuCTPI_DataWord_Decoder.cxx.

                                                       {
  return ((m_dataWord >> LVL1::MuCTPIBits::ROI_OVERFLOW_SHIFT) &
      LVL1::MuCTPIBits::ROI_OVERFLOW_MASK);
}

getSectorAddress()

uint16_t MuCTPI_DataWord_Decoder::getSectorAddress

(

)

const

8-bit address of the sector that detected the candidate

Returns

8-bit address of the sector that detected the candidate

Definition at line 107 of file MuCTPI_DataWord_Decoder.cxx.

                                                         {
  return ((m_dataWord >> LVL1::MuCTPIBits::CAND_SECTOR_ADDRESS_SHIFT) &
      LVL1::MuCTPIBits::CAND_SECTOR_ADDRESS_MASK);
}

getSectorID()

uint16_t MuCTPI_DataWord_Decoder::getSectorID

(

bool

newScheme = 0

)

const

Number of the sector that detected the candidate.

Returns

number of the sector that detected the candidate

Definition at line 115 of file MuCTPI_DataWord_Decoder.cxx.

                                                                  {
 
  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;
}

getSectorLocation()

MuCTPI_RDO::SectorLocation MuCTPI_DataWord_Decoder::getSectorLocation

(

)

const

The system that detected the muon candidate.

Returns

name of the system that detected the muon candidate

Definition at line 93 of file MuCTPI_DataWord_Decoder.cxx.

                                                                          {
 
  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;
  }
}

getSectorOverflow()

uint16_t MuCTPI_DataWord_Decoder::getSectorOverflow

(

)

const

Flag showing whether there were more than 2 candidates in this candidate's sector.

Returns

flag showing whether there were more than 2 candidates in this candidate's sector

Definition at line 29 of file MuCTPI_DataWord_Decoder.cxx.

                                                          {
  return ((m_dataWord >> LVL1::MuCTPIBits::CAND_OVERFLOW_SHIFT) &
      LVL1::MuCTPIBits::CAND_OVERFLOW_MASK);
}

getSentRoi()

uint16_t MuCTPI_DataWord_Decoder::getSentRoi

(

)

const

Flag showing whether the candidate was sent to the RoIB.

Returns

flag showing whether the candidate was sent to the RoIB

Definition at line 172 of file MuCTPI_DataWord_Decoder.cxx.

                                                   {
  return ((m_dataWord >> LVL1::MuCTPIBits::CAND_SENT_ROI_SHIFT) &
      LVL1::MuCTPIBits::CAND_SENT_ROI_MASK);
}

getSign()

uint16_t MuCTPI_DataWord_Decoder::getSign

(

)

const

Get the candidate's sign (0=negative, 1=positive, 100=undefined)

Returns

The candidate's sign (0=negative, 1=positive, 100=undefined)

Definition at line 180 of file MuCTPI_DataWord_Decoder.cxx.

                                                {
 
   // 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 );
}

getVetoed()

uint16_t MuCTPI_DataWord_Decoder::getVetoed

(

)

const

Flag showing if the candidate was vetoed in the multiplicity sum.

Returns

Flag showing if the candidate was vetoed in the multiplicity sum

Definition at line 194 of file MuCTPI_DataWord_Decoder.cxx.

                                                  {
 
   return ( ( m_dataWord >> LVL1::MuCTPIBits::CAND_VETO_SHIFT )
            & 0x1 );
}

getWord()

uint32_t MuCTPI_DataWord_Decoder::getWord ( ) const

inline

Function returning the MuCTPI data word.

Definition at line 77 of file MuCTPI_DataWord_Decoder.h.

{ return m_dataWord; }

setWord()

void MuCTPI_DataWord_Decoder::setWord ( uint32_t word )

inline

Function setting the MuCTPI data word.

Definition at line 75 of file MuCTPI_DataWord_Decoder.h.

{ m_dataWord = word; }

Member Data Documentation

m_dataWord

uint32_t MuCTPI_DataWord_Decoder::m_dataWord

private

The 32-bit data word to decode.

Definition at line 86 of file MuCTPI_DataWord_Decoder.h.

---

The documentation for this class was generated from the following files:

• MuCTPI_DataWord_Decoder.h
• MuCTPI_DataWord_Decoder.cxx