Reconstruction Input Object of the MuCTPI hardware and simulation. More...

#include <MuCTPI_RIO.h>

Collaboration diagram for MuCTPI_RIO:

Classes
class	MyRoI
	Custom private object to hold information about the stored reconstructed RoIs. More...

Public Types
enum	{ N_SUM = 6 }
	number of candidate multiplicity thresholds More...

Public Member Functions
	MuCTPI_RIO ()
	Default constructor. More...

	~MuCTPI_RIO ()=default
	Destructor. More...

void	setBCID (const uint16_t bcId)
	Function setting the BCID of the object. More...

uint16_t	getBCID () const
	The BCID of the object. More...

void	setSum (const uint16_t *sum)
	Set the multiplicity sum. More...

uint16_t	getSum (const int index) const
	Get the multiplicity sum for a given p_T threshold. More...

void	setRoI (const uint16_t bcId, const uint16_t pTval, const uint16_t pTnum, const double eta, const double phi, const uint16_t secID, const uint16_t sysId, const uint16_t hemisphere, const uint16_t roiNum, const bool accepted, const bool first, const bool duplicatedRoI, const bool duplicatedSector)
	Add a muon RoI to the object More...

int	getNRoI () const
	Get the number of muon RoIs. More...

bool	getRoI (const int index, uint16_t &bcId, uint16_t &pTval, uint16_t &pTnum, double &eta, double &phi, uint16_t &secID, uint16_t &sysId, uint16_t &hemisphere, uint16_t &roiNum, bool &accepted, bool &first, bool &duplicatedRoI, bool &duplicatedSector) const
	Get the properties of a given muon RoI. More...

uint32_t	getHeaderSourceId () const
	Get the ROD ID specified in the header. More...

uint32_t	getHeaderRunNumber () const
	Get the run number specified in the header. More...

uint32_t	getHeaderLVL1ID () const
	Get the LVL1 ID specified in the header. More...

uint32_t	getHeaderBCID () const
	Get the full BCID specified in the header. More...

uint32_t	getHeaderLVL1TriggerType () const
	Get the LVL1 trigger type specified in the header. More...

uint32_t	getHeaderDetectorEventType () const
	Get the event type specified in the header. More...

uint32_t	getHeaderNumberDataWords () const
	Get the number of data words as it was specified in the trailer More...

uint32_t	getHeaderNumberStatusWords () const
	Get the number of status words as it was specified in the trailer More...

const std::vector< uint32_t > &	getHeaderStatusWords () const
	Get the status words from the payload. More...

void	headerSourceId (uint32_t val)
	Set the ROD ID specidied in the header. More...

void	headerRunNumber (uint32_t val)
	Set the run number specified in the header. More...

void	headerLVL1ID (uint32_t val)
	Set the LVL1 ID specified in the header. More...

void	headerBCID (uint32_t val)
	Set the BCID specified in the header. More...

void	headerLVL1TriggerType (uint32_t val)
	Set the LVL1 trigger type specified in the header. More...

void	headerDetectorEventType (uint32_t val)
	Set the event type specified in the header. More...

void	headerNumberDataWords (uint32_t val)
	Set the number of data words as it was specified in the trailer More...

void	headerNumberStatusWords (uint32_t val)
	Set the number of status words as it was specified in the trailer More...

std::vector< uint32_t > &	headerStatusWords ()
	Get the status words from the payload. More...

void	dumpData () const
	Function dumping the stored information to the message stream. More...

void	dumpData (MsgStream &) const
	Function dumping the stored information to the message stream. More...

Private Attributes
uint32_t	m_headerSourceId
	Source ID as specified in the header. More...

uint32_t	m_headerRunNumber
	Run number as specified in the header. More...

uint32_t	m_headerLVL1ID
	LVL1 ID as specified in the header. More...

uint32_t	m_headerBCID
	The full BCID as specified in the header. More...

uint32_t	m_headerLVL1TriggerType
	The LVL1 trigger type as specified in the header. More...

uint32_t	m_headerDetEventType
	The event type as specified in the header. More...

uint32_t	m_headerNDataWords
	The number of data words as specified in the trailer More...

uint32_t	m_headerNStatusWords
	The number of status words as specified in the trailer More...

std::vector< uint32_t >	m_headerStatusWords
	The status words. More...

uint16_t	m_bcId
	What kind of BCID is this??? More...

std::array< uint16_t, N_SUM >	m_sum
	Candidate multiplicity in MuCTPI_RIO::N_SUM number of p_T thresholds. More...

std::vector< MyRoI >	m_roI
	Variable holding the custom RoIs. More...

Detailed Description

Reconstruction Input Object of the MuCTPI hardware and simulation.

Date: 2007-07-05 13:26:22

   This is a slightly smarter version of MuCTPI_RDO. It basically provides
   the same features with additional accessor functions.

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

   For a detailed description of the ATLAS raw event format, see
   https://edms.cern.ch/file/445840/3.1/ATL-D-ES-0019v31.pdf

See also: MuCTPI_RDO

Author: Tadashi Maeno tmaen.nosp@m.o@bn.nosp@m.l.gov; Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h; David Berge David.nosp@m..Ber.nosp@m.ge@ce.nosp@m.rn.c.nosp@m.h; Ellie Dobson elean.nosp@m.or.d.nosp@m.obson.nosp@m.@cer.nosp@m.n.ch; Christian Ohm chris.nosp@m.tian.nosp@m..ohm@.nosp@m.cern.nosp@m..ch

Version

Revision: 1.6

Definition at line 43 of file MuCTPI_RIO.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

number of candidate multiplicity thresholds

Enumerator
N_SUM

Definition at line 47 of file MuCTPI_RIO.h.

47 { N_SUM = 6 };

Constructor & Destructor Documentation

◆ MuCTPI_RIO()

MuCTPI_RIO::MuCTPI_RIO ( )

Default constructor.

There are so many parameters defined in the class, that no constructor that would actually set any of them would make sense.

So this one just initialises everything to zero, in the assumption that everything will be set by the "setter" methods.

Definition at line 20 of file MuCTPI_RIO.cxx.

   : m_headerSourceId( 0 ), m_headerRunNumber( 0 ), m_headerLVL1ID( 0 ), m_headerBCID( 0 ),
     m_headerLVL1TriggerType( 0 ), m_headerDetEventType( 0 ), m_headerNDataWords( 0 ),
     m_headerNStatusWords( 0 ), m_bcId( 0 ), m_sum() {
  
 }

◆ ~MuCTPI_RIO()

MuCTPI_RIO::~MuCTPI_RIO ( )

default

Destructor.

Member Function Documentation

◆ dumpData() [1/2]

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

Definition at line 127 of file MuCTPI_RIO.cxx.

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

◆ dumpData() [2/2]

void MuCTPI_RIO::dumpData ( MsgStream & log ) const

Function dumping the stored information to the message stream.

Function printing the information stored in the object in an easy-to-read fashion.

Parameters

log	A message stream to print the information to

Definition at line 144 of file MuCTPI_RIO.cxx.

                                                 {
  
   log << MSG::DEBUG << "=================================================" << endmsg;
   log << MSG::DEBUG << "MUCTPI ROD Header / Trailer data" << endmsg;
   log << MSG::DEBUG << "Source ID               :  0x" << MSG::hex << getHeaderSourceId() << MSG::dec << endmsg;
   log << MSG::DEBUG << "Run number              :  " << getHeaderRunNumber() << endmsg;
   log << MSG::DEBUG << "Ext. LVL1 ID            :  " << getHeaderLVL1ID() << endmsg;
   log << MSG::DEBUG << "BCID                    :  " << getHeaderBCID() << endmsg;
   log << MSG::DEBUG << "Trigger type            :  " << getHeaderLVL1TriggerType() << endmsg;
   log << MSG::DEBUG << "Det. event type         :  " << getHeaderDetectorEventType() << endmsg;
   log << MSG::DEBUG << "No data words           :  " << getHeaderNumberDataWords() << endmsg;
   log << MSG::DEBUG << "No status words         :  " << getHeaderNumberStatusWords() << endmsg;
   for( uint32_t i = 0 ; i < getHeaderNumberStatusWords(); ++i ) {
     log << MSG::DEBUG << "Status word " << i << "           :  0x" << MSG::hex << getHeaderStatusWords()[i]
         << MSG::dec << endmsg;
   }
   log << MSG::DEBUG << "=================================================" << endmsg;
  
   std::vector<MyRoI>::const_iterator it = m_roI.begin();
   for( ; it != m_roI.end(); ++it ) it->dumpData( log );
  
   return;
 }

◆ getBCID()

uint16_t MuCTPI_RIO::getBCID ( ) const

inline

The BCID of the object.

Definition at line 57 of file MuCTPI_RIO.h.

57 { return m_bcId; }

◆ getHeaderBCID()

uint32_t MuCTPI_RIO::getHeaderBCID ( ) const

inline

Get the full BCID specified in the header.

Definition at line 82 of file MuCTPI_RIO.h.

82 { return m_headerBCID; }

◆ getHeaderDetectorEventType()

uint32_t MuCTPI_RIO::getHeaderDetectorEventType ( ) const

inline

Get the event type specified in the header.

Definition at line 86 of file MuCTPI_RIO.h.

86 { return m_headerDetEventType; }

◆ getHeaderLVL1ID()

uint32_t MuCTPI_RIO::getHeaderLVL1ID ( ) const

inline

Get the LVL1 ID specified in the header.

Definition at line 80 of file MuCTPI_RIO.h.

80 { return m_headerLVL1ID; }

◆ getHeaderLVL1TriggerType()

uint32_t MuCTPI_RIO::getHeaderLVL1TriggerType ( ) const

inline

Get the LVL1 trigger type specified in the header.

Definition at line 84 of file MuCTPI_RIO.h.

84 { return m_headerLVL1TriggerType; }

◆ getHeaderNumberDataWords()

uint32_t MuCTPI_RIO::getHeaderNumberDataWords ( ) const

inline

Get the number of data words as it was specified in the trailer

Definition at line 88 of file MuCTPI_RIO.h.

88 { return m_headerNDataWords; }

◆ getHeaderNumberStatusWords()

uint32_t MuCTPI_RIO::getHeaderNumberStatusWords ( ) const

inline

Get the number of status words as it was specified in the trailer

Definition at line 90 of file MuCTPI_RIO.h.

90 { return m_headerNStatusWords; }

◆ getHeaderRunNumber()

uint32_t MuCTPI_RIO::getHeaderRunNumber ( ) const

inline

Get the run number specified in the header.

Definition at line 78 of file MuCTPI_RIO.h.

78 { return m_headerRunNumber; }

◆ getHeaderSourceId()

uint32_t MuCTPI_RIO::getHeaderSourceId ( ) const

inline

Get the ROD ID specified in the header.

Definition at line 76 of file MuCTPI_RIO.h.

76 { return m_headerSourceId; }

◆ getHeaderStatusWords()

const std::vector< uint32_t >& MuCTPI_RIO::getHeaderStatusWords ( ) const

inline

Get the status words from the payload.

Definition at line 92 of file MuCTPI_RIO.h.

92 { return m_headerStatusWords; }

◆ getNRoI()

int MuCTPI_RIO::getNRoI ( ) const

inline

Get the number of muon RoIs.

Definition at line 69 of file MuCTPI_RIO.h.

69 { return m_roI.size(); }

◆ getRoI()

bool MuCTPI_RIO::getRoI	(	const int	index,
		uint16_t &	bcId,
		uint16_t &	pTval,
		uint16_t &	pTnum,
		double &	eta,
		double &	phi,
		uint16_t &	secID,
		uint16_t &	sysId,
		uint16_t &	hemisphere,
		uint16_t &	roiNum,
		bool &	accepted,
		bool &	first,
		bool &	duplicatedRoI,
		bool &	duplicatedSector
	)		const

Get the properties of a given muon RoI.

Function that returns the properties of a given RoI in the variables given to it.

Parameters

index	index of the RoI in question in the stored list
bcId	3-bit BCID from the muon candidate word
pTval	p_T threshold value in GeV taken from the configuration
pTnum	p_T threshold number from the muon candidate word
eta	η coordinate of the muon candidate
phi	φ coordinate of the muon candidate
secID	8-bit sector ID from the muon candidate word
sysId	system ID ROI (Barrel=0, Endcap=1, Forward=2)
hemisphere	Hemisphere (0: z < 0, 1: z > 0)
roiNum	RoI number from the muon candidate word
accepted	flag showing whether the candidate was sent to the RoIB
first	flag showing whether the candidate had the highest p_T in it's sector
duplicatedRoI	flag showing whether there was more than 1 muon candidate in this candidate's RoI
duplicatedSector	flag showing whether there were more than 2 muon candidates in this candidate's sector

Returns: true in case the candidate was found, false otherwise

Definition at line 98 of file MuCTPI_RIO.cxx.

                                                                              {
  
   if( index >= getNRoI() ) return false;
  
   const MyRoI &roi = m_roI.at( index );
   bcId = roi.m_bcId;
   pTval = roi.m_pTvalue;
   pTnum = roi.m_pTnumber;
   eta = roi.m_eta;
   phi = roi.m_phi;
   secID = roi.m_sectorID;
   sysId = roi.m_sysId;
   hemisphere = (roi.m_hemisphere ? 1 : 0);
   roiNum = roi.m_roINumber;
   accepted = roi.m_accepted;
   first = roi.m_first;
   duplicatedRoI = roi.m_duplicatedRoI;
   duplicatedSector = roi.m_duplicatedSector;
   
  
   return true;
 }

◆ getSum()

uint16_t MuCTPI_RIO::getSum ( const int index ) const

Get the multiplicity sum for a given p_T threshold.

Function returning the 3-bit number of muon candidates in threshold "index".

Be aware that index is defined from 0 to 5, not from 1 to 6 as the actual thresholds are numbered!

Parameters

index Index of the p_T threshold to get the multiplicity sum for

Returns: The 3-bit number of muon candidates at the given index

Definition at line 47 of file MuCTPI_RIO.cxx.

                                                    {
   if( index >= N_SUM ) return 0;
   return m_sum[ index ];
 }

◆ headerBCID()

void MuCTPI_RIO::headerBCID ( uint32_t val )

inline

Set the BCID specified in the header.

Definition at line 101 of file MuCTPI_RIO.h.

101 { m_headerBCID = val; }

◆ headerDetectorEventType()

void MuCTPI_RIO::headerDetectorEventType ( uint32_t val )

inline

Set the event type specified in the header.

Definition at line 105 of file MuCTPI_RIO.h.

105 { m_headerDetEventType = val; }

◆ headerLVL1ID()

void MuCTPI_RIO::headerLVL1ID ( uint32_t val )

inline

Set the LVL1 ID specified in the header.

Definition at line 99 of file MuCTPI_RIO.h.

99 { m_headerLVL1ID = val; }

◆ headerLVL1TriggerType()

void MuCTPI_RIO::headerLVL1TriggerType ( uint32_t val )

inline

Set the LVL1 trigger type specified in the header.

Definition at line 103 of file MuCTPI_RIO.h.

103 { m_headerLVL1TriggerType = val; }

◆ headerNumberDataWords()

void MuCTPI_RIO::headerNumberDataWords ( uint32_t val )

inline

Set the number of data words as it was specified in the trailer

Definition at line 107 of file MuCTPI_RIO.h.

107 { m_headerNDataWords = val; }

◆ headerNumberStatusWords()

void MuCTPI_RIO::headerNumberStatusWords ( uint32_t val )

inline

Set the number of status words as it was specified in the trailer

Definition at line 109 of file MuCTPI_RIO.h.

109 { m_headerNStatusWords = val; }

◆ headerRunNumber()

void MuCTPI_RIO::headerRunNumber ( uint32_t val )

inline

Set the run number specified in the header.

Definition at line 97 of file MuCTPI_RIO.h.

97 { m_headerRunNumber = val; }

◆ headerSourceId()

void MuCTPI_RIO::headerSourceId ( uint32_t val )

inline

Set the ROD ID specidied in the header.

Definition at line 95 of file MuCTPI_RIO.h.

95 { m_headerSourceId = val; }

◆ headerStatusWords()

std::vector< uint32_t >& MuCTPI_RIO::headerStatusWords ( )

inline

Get the status words from the payload.

Definition at line 111 of file MuCTPI_RIO.h.

111 { return m_headerStatusWords; }

◆ setBCID()

void MuCTPI_RIO::setBCID ( const uint16_t bcId )

inline

Function setting the BCID of the object.

Definition at line 55 of file MuCTPI_RIO.h.

55 { m_bcId = bcId; }

◆ setRoI()

void MuCTPI_RIO::setRoI	(	const uint16_t	bcId,
		const uint16_t	pTval,
		const uint16_t	pTnum,
		const double	eta,
		const double	phi,
		const uint16_t	secID,
		const uint16_t	sysId,
		const uint16_t	hemisphere,
		const uint16_t	roiNum,
		const bool	accepted,
		const bool	first,
		const bool	duplicatedRoI,
		const bool	duplicatedSector
	)

Add a muon RoI to the object

Function that adds one more muon candidate to the stored list.

Parameters

bcId	3-bit BCID from the muon candidate word
pTval	p_T threshold value in GeV taken from the configuration
pTnum	p_T threshold number from the muon candidate word
eta	η coordinate of the muon candidate
phi	φ coordinate of the muon candidate
secID	8-bit sector ID from the muon candidate word
sysId	system ID ROI (Barrel=0, Endcap=1, Forward=2)
hemisphere	Hemisphere (0: z < 0, 1: z > 0)
roiNum	RoI number from the muon candidate word
accepted	flag showing whether the candidate was sent to the RoIB
first	flag showing whether the candidate had the highest p_T in it's sector
duplicatedRoI	flag showing whether there was more than 1 muon candidate in this candidate's RoI
duplicatedSector	flag showing whether there were more than 2 muon candidates in this candidate's sector

Definition at line 69 of file MuCTPI_RIO.cxx.

                                                                                                            {
  
   MyRoI roI( bcId, pTval,pTnum, eta, phi, secID, sysId, hemisphere, roiNum, accepted, first, duplicatedRoI, duplicatedSector);
   m_roI.push_back( roI );
  
   return;
 }

◆ setSum()

void MuCTPI_RIO::setSum ( const uint16_t * sum )

Set the multiplicity sum.

This function sets the muon candidate multiplicity sums in the 6 p_T thresholds.

See also: MuCTPI_RIO::getSum()

Parameters

sum	constant pointer to an array holding 6 uint16_t values

Definition at line 34 of file MuCTPI_RIO.cxx.

                                              {
   for( int i = 0; i < N_SUM; ++i ) m_sum[ i ] = *( sum + i );
   return;
 }

Member Data Documentation

◆ m_bcId

uint16_t MuCTPI_RIO::m_bcId

private

What kind of BCID is this???

Definition at line 166 of file MuCTPI_RIO.h.

◆ m_headerBCID

uint32_t MuCTPI_RIO::m_headerBCID

private

The full BCID as specified in the header.

See also: MuCTPI_RIO::getHeaderBCID()

Definition at line 138 of file MuCTPI_RIO.h.

◆ m_headerDetEventType

uint32_t MuCTPI_RIO::m_headerDetEventType

private

The event type as specified in the header.

See also: MuCTPI_RIO::getHeaderDetectorEventType()

Definition at line 148 of file MuCTPI_RIO.h.

◆ m_headerLVL1ID

uint32_t MuCTPI_RIO::m_headerLVL1ID

private

LVL1 ID as specified in the header.

See also: MuCTPI_RIO::getHeaderLVL1ID()

Definition at line 133 of file MuCTPI_RIO.h.

◆ m_headerLVL1TriggerType

uint32_t MuCTPI_RIO::m_headerLVL1TriggerType

private

The LVL1 trigger type as specified in the header.

See also: MuCTPI_RIO::getHeaderLVL1TriggerType()

Definition at line 143 of file MuCTPI_RIO.h.

◆ m_headerNDataWords

uint32_t MuCTPI_RIO::m_headerNDataWords

private

The number of data words as specified in the trailer

See also: MuCTPI_RIO::getHeaderNumberDataWords()

Definition at line 153 of file MuCTPI_RIO.h.

◆ m_headerNStatusWords

uint32_t MuCTPI_RIO::m_headerNStatusWords

private

The number of status words as specified in the trailer

See also: MuCTPI_RIO::getHeaderNumberStatusWords()

Definition at line 158 of file MuCTPI_RIO.h.

◆ m_headerRunNumber

uint32_t MuCTPI_RIO::m_headerRunNumber

private

Run number as specified in the header.

See also: MuCTPI_RIO::getHeaderRunNumber()

Definition at line 128 of file MuCTPI_RIO.h.

◆ m_headerSourceId

uint32_t MuCTPI_RIO::m_headerSourceId

private

Source ID as specified in the header.

See also: MuCTPI_RIO::getHeaderSourceId()

Definition at line 123 of file MuCTPI_RIO.h.

◆ m_headerStatusWords

std::vector< uint32_t > MuCTPI_RIO::m_headerStatusWords

private

The status words.

See also: MuCTPI_RIO::getHeaderStatusWords()

Definition at line 163 of file MuCTPI_RIO.h.

◆ m_roI

std::vector< MyRoI > MuCTPI_RIO::m_roI

private

Variable holding the custom RoIs.

Definition at line 240 of file MuCTPI_RIO.h.

◆ m_sum

std::array<uint16_t, N_SUM> MuCTPI_RIO::m_sum

private

Candidate multiplicity in MuCTPI_RIO::N_SUM number of p_T thresholds.

Definition at line 170 of file MuCTPI_RIO.h.

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

Classes

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ MuCTPI_RIO()

◆ ~MuCTPI_RIO()

Member Function Documentation

◆ dumpData() [1/2]

◆ dumpData() [2/2]

◆ getBCID()

◆ getHeaderBCID()

◆ getHeaderDetectorEventType()

◆ getHeaderLVL1ID()

◆ getHeaderLVL1TriggerType()

◆ getHeaderNumberDataWords()

◆ getHeaderNumberStatusWords()

◆ getHeaderRunNumber()

◆ getHeaderSourceId()

◆ getHeaderStatusWords()

◆ getNRoI()

◆ getRoI()

◆ getSum()

◆ headerBCID()

◆ headerDetectorEventType()

◆ headerLVL1ID()

◆ headerLVL1TriggerType()

◆ headerNumberDataWords()

◆ headerNumberStatusWords()

◆ headerRunNumber()

◆ headerSourceId()

◆ headerStatusWords()

◆ setBCID()

◆ setRoI()

◆ setSum()

Member Data Documentation

◆ m_bcId

◆ m_headerBCID

◆ m_headerDetEventType

◆ m_headerLVL1ID

◆ m_headerLVL1TriggerType

◆ m_headerNDataWords

◆ m_headerNStatusWords

◆ m_headerRunNumber

◆ m_headerSourceId

◆ m_headerStatusWords

◆ m_roI

◆ m_sum