MuCTPI_MultiplicityWord_Decoder Class Reference

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

#include <MuCTPI_MultiplicityWord_Decoder.h>

Collaboration diagram for MuCTPI_MultiplicityWord_Decoder:

Public Types
enum	TriggerMode_t { inclusive , exclusive }
	Possible trigger threshold modes. More...

Public Member Functions
	MuCTPI_MultiplicityWord_Decoder (const uint32_t multword=0, const TriggerMode_t mode=exclusive)
	Constructor.
	MuCTPI_MultiplicityWord_Decoder (const uint32_t multword, const bool inclusiveTriggerMode)
	Constructor.
	~MuCTPI_MultiplicityWord_Decoder ()=default
	Destructor.
uint16_t	getNCandidates () const
	Function returning the total number of muon candidates.
uint16_t	getMultiplicity (const uint16_t candidateNumber) const
	Function returning the 3-bit candidate multiplicity for the specified threshold.
uint16_t	getBCID () const
	Function returning the 3-bit BCID fragment in the multiplicity word.
void	setWord (const uint32_t word)
	Function setting the MuCTPI multiplicity word.
uint32_t	getWord () const
	Function returning the MuCTPI multiplicity 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_multiplicityWord
	The 32-bit multiplicity word to decode.
TriggerMode_t	m_triggerMode
	Trigger threshold mode (inclusive/exclusive)

Detailed Description

Class helping to decode the MuCTPI multiplicity words.

Date

2007-09-27 15:22:34

   The multiplicity word(s) in the MuCTPI readout data store the number
   of collected LVL1 muon candidates in 6 p<sub>T</sub> thresholds in (a)
   32-bit word(s). This class can help in decoding such a multiplicity word.

   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 32 of file MuCTPI_MultiplicityWord_Decoder.h.

Member Enumeration Documentation

TriggerMode_t

enum MuCTPI_MultiplicityWord_Decoder::TriggerMode_t

Possible trigger threshold modes.

Enumerator
inclusive
exclusive

Definition at line 36 of file MuCTPI_MultiplicityWord_Decoder.h.

                    {
    inclusive, exclusive
  };

Constructor & Destructor Documentation

MuCTPI_MultiplicityWord_Decoder() [1/2]

MuCTPI_MultiplicityWord_Decoder::MuCTPI_MultiplicityWord_Decoder	(	const uint32_t	multword = 0,
		const TriggerMode_t	mode = exclusive )

Constructor.

The constructor only has to give an initial value to MuCTPI_MultiplicityWord_Decoder::m_multiplicityWord stored in the object.

Parameters

multword

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

Definition at line 23 of file MuCTPI_MultiplicityWord_Decoder.cxx.

  : m_multiplicityWord( multword ), m_triggerMode(mode) {
 
}

MuCTPI_MultiplicityWord_Decoder() [2/2]

MuCTPI_MultiplicityWord_Decoder::MuCTPI_MultiplicityWord_Decoder	(	const uint32_t	multword,
		const bool	inclusiveTriggerMode )

Constructor.

The constructor only has to give an initial value to MuCTPI_MultiplicityWord_Decoder::m_multiplicityWord stored in the object.

Parameters

multword

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

Definition at line 33 of file MuCTPI_MultiplicityWord_Decoder.cxx.

  : m_multiplicityWord( multword ), m_triggerMode(exclusive) {
  if (inclusiveTriggerMode) m_triggerMode = inclusive;
}

~MuCTPI_MultiplicityWord_Decoder()

MuCTPI_MultiplicityWord_Decoder::~MuCTPI_MultiplicityWord_Decoder ( )

default

Destructor.

Member Function Documentation

dumpData() [1/2]

void MuCTPI_MultiplicityWord_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_MultiplicityWord_Decoder::dumpData(MsgStream&) const.

Definition at line 88 of file MuCTPI_MultiplicityWord_Decoder.cxx.

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

dumpData() [2/2]

void MuCTPI_MultiplicityWord_Decoder::dumpData

(

MsgStream &

log

)

const

Function dumping the stored information to the message stream.

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

Parameters

log	A message stream to print the information to

Definition at line 105 of file MuCTPI_MultiplicityWord_Decoder.cxx.

                                                                     {
 
  log << MSG::DEBUG << "=================================================" << endmsg;
  log << MSG::DEBUG << "Candidate Multiplicity word 0x" << MSG::hex << m_multiplicityWord << MSG::dec << endmsg;
  for( uint16_t i = 0; i < LVL1::MuCTPIBits::MULT_THRESH_NUM; ++i ) {
    log << MSG::DEBUG << "Pt threshold " << ( i + 1 ) << ", multiplicity " << getMultiplicity( i ) << endmsg;
  }
  log << MSG::DEBUG << "Number of candidates: " << getNCandidates() << endmsg;
  log << MSG::DEBUG << "MICTP BCID: 0x" << MSG::hex
      << getBCID() << MSG::dec << " ( " << getBCID() << " )" << endmsg;
  log << MSG::DEBUG << "=================================================" << endmsg;
 
  return;
}

getBCID()

uint16_t MuCTPI_MultiplicityWord_Decoder::getBCID

(

)

const

Function returning the 3-bit BCID fragment in the multiplicity word.

Returns

3-bit BCID fragment in the multiplicity word

Definition at line 78 of file MuCTPI_MultiplicityWord_Decoder.cxx.

                                                        {
 
  return ( ( m_multiplicityWord >> ((LVL1::MuCTPIBits::MULT_BCID_POS-1) * LVL1::MuCTPIBits::MULT_BITS)) &
             LVL1::MuCTPIBits::MULT_VAL );
}

getMultiplicity()

uint16_t MuCTPI_MultiplicityWord_Decoder::getMultiplicity

(

const uint16_t

candidateNumber

)

const

Function returning the 3-bit candidate multiplicity for the specified threshold.

Be careful, that candidateNumber is defined from 0 to 5, not from 1 to 6!

Parameters

candidateNumber

the index of the threshold for which to get the number of candidates

Returns

3-bit candidate multiplicity for the specified threshold

Definition at line 61 of file MuCTPI_MultiplicityWord_Decoder.cxx.

                                                                                                {
 
  if( candidateNumber >= LVL1::MuCTPIBits::MULT_THRESH_NUM ) {
    // throw exception? issue warning?
 
    throw GaudiException( "MuCTPI_MultiplicityWord_Decoder::getMultiplicity> Threshold out of range",
              "MuCTPI_MultiplicityWord_Decoder::getMultiplicity", StatusCode::FAILURE );
    return 99;
  }
 
  return ((m_multiplicityWord >> (candidateNumber * LVL1::MuCTPIBits::MULT_BITS)) &
      LVL1::MuCTPIBits::MULT_VAL);
}

getNCandidates()

uint16_t MuCTPI_MultiplicityWord_Decoder::getNCandidates

(

)

const

Function returning the total number of muon candidates.

Returns

total number of muon candidates

Definition at line 42 of file MuCTPI_MultiplicityWord_Decoder.cxx.

                                                               {
 
  uint16_t nCand = 0;
  if (m_triggerMode == exclusive){
    for( uint32_t i = 0; i < LVL1::MuCTPIBits::MULT_THRESH_NUM; ++i ) {
      nCand += this->getMultiplicity( i );
    }
  } else {
    nCand = this->getMultiplicity( 0 );
  }
  return nCand;
}

getWord()

uint32_t MuCTPI_MultiplicityWord_Decoder::getWord ( ) const

inline

Function returning the MuCTPI multiplicity word.

Definition at line 57 of file MuCTPI_MultiplicityWord_Decoder.h.

{ return m_multiplicityWord; }

setWord()

void MuCTPI_MultiplicityWord_Decoder::setWord ( const uint32_t word )

inline

Function setting the MuCTPI multiplicity word.

Definition at line 55 of file MuCTPI_MultiplicityWord_Decoder.h.

{ m_multiplicityWord = word; }

Member Data Documentation

m_multiplicityWord

uint32_t MuCTPI_MultiplicityWord_Decoder::m_multiplicityWord

private

The 32-bit multiplicity word to decode.

Definition at line 66 of file MuCTPI_MultiplicityWord_Decoder.h.

m_triggerMode

TriggerMode_t MuCTPI_MultiplicityWord_Decoder::m_triggerMode

private

Trigger threshold mode (inclusive/exclusive)

Definition at line 68 of file MuCTPI_MultiplicityWord_Decoder.h.

---

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

• MuCTPI_MultiplicityWord_Decoder.h
• MuCTPI_MultiplicityWord_Decoder.cxx