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

#include <MuCTPI_RIO.h>

Collaboration diagram for MuCTPI_RIO::MyRoI:

Public Member Functions
	MyRoI (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)
	Constructor.
	~MyRoI ()=default
	Destructor.
void	dumpData () const
	Function dumping the stored information to the message stream.
void	dumpData (MsgStream &) const
	Function dumping the stored information to the message stream.

Public Attributes
uint16_t	m_bcId
	3-bit BCID as stored in the data word
uint16_t	m_pTvalue
	p_T threshold value (in GeV) as reconstructed from the data word
uint16_t	m_pTnumber
	3-bit p_T threshold number as stored in the data word
double	m_eta
	η position of the candidate
double	m_phi
	φ position of the candidate
uint16_t	m_sectorID
	8-bit sector address as stored in the data word
uint16_t	m_sysId
	System in which the candidate was detected.
bool	m_hemisphere
	Hemisphere in which the candidate was detected (false: z < 0, true: z > 0)
uint16_t	m_roINumber
	RoI number (sub-sector in which the candidate was detected) as stored in the data word.
bool	m_accepted
	Flag showing whether the candidate was sent to the RoIB.
bool	m_first
	Flag showing whether the candidate had the highest p_T in its sector.
bool	m_duplicatedRoI
	Flag showing whether there was more than 1 candidate in this candidate's RoI.
bool	m_duplicatedSector
	Flag showing whether there were more than 2 candidates in this candidate's sector.

Detailed Description

Custom private object to hold information about the stored reconstructed RoIs.

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

   For a little bit clearer code, the properties of the "reconstructed RoIs" in
   MuCTPI_RIO are stored in such objects. They store the information encoded in
   the 32-bit MuCTPI data words in separate variables for faster access, but this
   makes the object waste a bit of space. &rarr; Should not be written to POOL.

   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: 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

Version

Revision: 1.6

Definition at line 192 of file MuCTPI_RIO.h.

Constructor & Destructor Documentation

◆ MyRoI()

MuCTPI_RIO::MyRoI::MyRoI	(	const uint16_t	bcId,
		const uint16_t	pTVal,
		const uint16_t	pTnumber,
		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 )

Constructor.

Constructor specifying all the variables which are stored in the class.

Parameters

bcId	3-bit BCID from the muon candidate word
pTVal	p_T threshold value in GeV taken from the configuration
pTnumber	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 (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 185 of file MuCTPI_RIO.cxx.

  : m_bcId( bcId ), m_pTvalue( pTVal ), m_pTnumber( pTnumber ), m_eta( eta ), m_phi( phi ),
    m_sectorID( secID ), m_sysId( sysId ), m_hemisphere( hemisphere ? true : false ), m_roINumber( roiNum ), m_accepted( accepted ), 
    m_first( first ), m_duplicatedRoI( duplicatedRoI ), m_duplicatedSector( duplicatedSector ) {}

◆ ~MyRoI()

MuCTPI_RIO::MyRoI::~MyRoI ( )

default

Destructor.

Member Function Documentation

◆ dumpData() [1/2]

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

Definition at line 194 of file MuCTPI_RIO.cxx.

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

◆ dumpData() [2/2]

void MuCTPI_RIO::MyRoI::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 211 of file MuCTPI_RIO.cxx.

                                                     {
 
  log << MSG::DEBUG << "=================================================" << endmsg;
  log << MSG::DEBUG << "MUCTPI RoI data" << endmsg;
  log << MSG::DEBUG << "BCID                    :  " << m_bcId << endmsg;
  log << MSG::DEBUG << "Pt value                :  " << m_pTvalue << endmsg;
  log << MSG::DEBUG << "Pt threshold number     :  " << m_pTnumber << endmsg;
  log << MSG::DEBUG << "Eta                     :  " << m_eta << endmsg;
  log << MSG::DEBUG << "Phi                     :  " << m_phi << endmsg;
  log << MSG::DEBUG << "RoI number              :  " << m_roINumber << endmsg;
  log << MSG::DEBUG << "Sector ID               :  " << m_sectorID << endmsg;
  log << MSG::DEBUG << "System ID               :  " << m_sysId << endmsg;
  log << MSG::DEBUG << "Hemisphere              :  " << m_hemisphere << endmsg;
  log << MSG::DEBUG << "Flags " << endmsg;
  log << MSG::DEBUG << "Accepted                :  " << m_accepted << endmsg;
  log << MSG::DEBUG << "First                   :  " << m_first << endmsg;
  log << MSG::DEBUG << "Duplicated sector       :  " << m_duplicatedSector << endmsg;
  log << MSG::DEBUG << "Duplicated RoI          :  " << m_duplicatedRoI << endmsg;
  log << MSG::DEBUG << "=================================================" << endmsg;
 
  return;
}

Member Data Documentation

◆ m_accepted

bool MuCTPI_RIO::MyRoI::m_accepted

Flag showing whether the candidate was sent to the RoIB.

Definition at line 228 of file MuCTPI_RIO.h.

◆ m_bcId

uint16_t MuCTPI_RIO::MyRoI::m_bcId

3-bit BCID as stored in the data word

Definition at line 208 of file MuCTPI_RIO.h.

◆ m_duplicatedRoI

bool MuCTPI_RIO::MyRoI::m_duplicatedRoI

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

Definition at line 232 of file MuCTPI_RIO.h.

◆ m_duplicatedSector

bool MuCTPI_RIO::MyRoI::m_duplicatedSector

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

Definition at line 234 of file MuCTPI_RIO.h.

◆ m_eta

double MuCTPI_RIO::MyRoI::m_eta

η position of the candidate

Definition at line 214 of file MuCTPI_RIO.h.

◆ m_first

bool MuCTPI_RIO::MyRoI::m_first

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

Definition at line 230 of file MuCTPI_RIO.h.

◆ m_hemisphere

bool MuCTPI_RIO::MyRoI::m_hemisphere

Hemisphere in which the candidate was detected (false: z < 0, true: z > 0)

Definition at line 222 of file MuCTPI_RIO.h.

◆ m_phi

double MuCTPI_RIO::MyRoI::m_phi

φ position of the candidate

Definition at line 216 of file MuCTPI_RIO.h.

◆ m_pTnumber

uint16_t MuCTPI_RIO::MyRoI::m_pTnumber

3-bit p_T threshold number as stored in the data word

Definition at line 212 of file MuCTPI_RIO.h.

◆ m_pTvalue

uint16_t MuCTPI_RIO::MyRoI::m_pTvalue

p_T threshold value (in GeV) as reconstructed from the data word

Definition at line 210 of file MuCTPI_RIO.h.

◆ m_roINumber

uint16_t MuCTPI_RIO::MyRoI::m_roINumber

RoI number (sub-sector in which the candidate was detected) as stored in the data word.

Definition at line 225 of file MuCTPI_RIO.h.

◆ m_sectorID

uint16_t MuCTPI_RIO::MyRoI::m_sectorID

8-bit sector address as stored in the data word

Definition at line 218 of file MuCTPI_RIO.h.

◆ m_sysId

uint16_t MuCTPI_RIO::MyRoI::m_sysId

System in which the candidate was detected.

Definition at line 220 of file MuCTPI_RIO.h.

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

Public Member Functions

Public Attributes