ATLAS Offline Software
Loading...
Searching...
No Matches
LVL1::ITrigT1MuonRecRoiTool Class Referenceabstract

#include <ITrigT1MuonRecRoiTool.h>

Inheritance diagram for LVL1::ITrigT1MuonRecRoiTool:
Collaboration diagram for LVL1::ITrigT1MuonRecRoiTool:

Public Types

enum  RoiWordFormat { Run2 , Run3 }
enum  MuonTriggerSystem { Barrel , Endcap , Forward , Undef }

Public Member Functions

 ITrigT1MuonRecRoiTool ()
virtual ~ITrigT1MuonRecRoiTool ()=default
 DeclareInterfaceID (ITrigT1MuonRecRoiTool, 1, 0)
virtual StatusCode roiData (const unsigned int &roiWord, TrigT1MuonRecRoiData &data) const =0
 pure virtual function to return eta and phi coord of RoI
virtual StatusCode RoIsize (const unsigned int &roiWord, double &etaMin, double &etaMax, double &phiMin, double &phiMax) const =0
 pure virtual function returns roi size
virtual bool dumpRoiMap (const std::string &filename) const =0
 pure virtual function for dumping roi mapping
unsigned int getBitMaskValue (const unsigned int *uintValue, const unsigned int mask) const
void updateBitMask (const RoiWordFormat)
MuonTriggerSystem getSystem (const unsigned int &roiWord) const
unsigned int IsRun3Mask () const
unsigned int IsVetoedMask () const
unsigned int ChargeMask () const
unsigned int IsFirstCandMask () const
unsigned int SectorAddressMask () const
unsigned int BarrelSectorIDMask () const
unsigned int EndcapSectorIDMask () const
unsigned int ForwardSectorIDMask () const
unsigned int SysIDMask () const
unsigned int SubSysIDMask () const
unsigned int ThresholdMask () const
unsigned int BarrelRoIMask () const
unsigned int EndcapRoIMask () const
unsigned int ForwardRoIMask () const
unsigned int EndcapRMask () const
unsigned int EndcapPhiMask () const
unsigned int ForwardRMask () const
unsigned int ForwardPhiMask () const
unsigned int OverflowPerRoIMask () const
unsigned int OverflowPerSectorMask () const
unsigned int BW2Or3Mask () const
unsigned int InnerCoinMask () const
unsigned int GoodMFMask () const
virtual bool etaDimLow (const TrigT1MuonRecRoiData &data, double &etaMin, double &etaMax) const =0
virtual bool etaDimHigh (const TrigT1MuonRecRoiData &data, double &etaMin, double &etaMax) const =0

Private Attributes

unsigned int m_IsRun3Mask {0}
unsigned int m_IsVetoedMask {0}
unsigned int m_ChargeMask {0}
unsigned int m_IsFirstCandMask {0}
unsigned int m_SectorAddressMask {0}
unsigned int m_BarrelSectorIDMask {0}
unsigned int m_EndcapSectorIDMask {0}
unsigned int m_ForwardSectorIDMask {0}
unsigned int m_SysIDMask {0}
unsigned int m_SubSysIDMask {0}
unsigned int m_ThresholdMask {0}
unsigned int m_BarrelRoIMask {0}
unsigned int m_EndcapRoIMask {0}
unsigned int m_ForwardRoIMask {0}
unsigned int m_EndcapRMask {0}
unsigned int m_EndcapPhiMask {0}
unsigned int m_ForwardRMask {0}
unsigned int m_ForwardPhiMask {0}
unsigned int m_OverflowPerRoIMask {0}
unsigned int m_OverflowPerSectorMask {0}
unsigned int m_BW2Or3Mask {0}
unsigned int m_InnerCoinMask {0}
unsigned int m_GoodMFMask {0}

Detailed Description

Definition at line 13 of file ITrigT1MuonRecRoiTool.h.

Member Enumeration Documentation

◆ MuonTriggerSystem

◆ RoiWordFormat

Constructor & Destructor Documentation

◆ ITrigT1MuonRecRoiTool()

LVL1::ITrigT1MuonRecRoiTool::ITrigT1MuonRecRoiTool ( )

Definition at line 32 of file ITrigT1MuonRecRoiTool.cxx.

33 {
35 }
void updateBitMask(const RoiWordFormat)

◆ ~ITrigT1MuonRecRoiTool()

virtual LVL1::ITrigT1MuonRecRoiTool::~ITrigT1MuonRecRoiTool ( )
virtualdefault

Member Function Documentation

◆ BarrelRoIMask()

unsigned int LVL1::ITrigT1MuonRecRoiTool::BarrelRoIMask ( ) const
inline

Definition at line 57 of file ITrigT1MuonRecRoiTool.h.

◆ BarrelSectorIDMask()

unsigned int LVL1::ITrigT1MuonRecRoiTool::BarrelSectorIDMask ( ) const
inline

Definition at line 51 of file ITrigT1MuonRecRoiTool.h.

◆ BW2Or3Mask()

unsigned int LVL1::ITrigT1MuonRecRoiTool::BW2Or3Mask ( ) const
inline

Definition at line 66 of file ITrigT1MuonRecRoiTool.h.

◆ ChargeMask()

unsigned int LVL1::ITrigT1MuonRecRoiTool::ChargeMask ( ) const
inline

Definition at line 48 of file ITrigT1MuonRecRoiTool.h.

◆ DeclareInterfaceID()

LVL1::ITrigT1MuonRecRoiTool::DeclareInterfaceID ( ITrigT1MuonRecRoiTool ,
1 ,
0  )

◆ dumpRoiMap()

virtual bool LVL1::ITrigT1MuonRecRoiTool::dumpRoiMap ( const std::string & filename) const
pure virtual

pure virtual function for dumping roi mapping

◆ EndcapPhiMask()

unsigned int LVL1::ITrigT1MuonRecRoiTool::EndcapPhiMask ( ) const
inline

Definition at line 61 of file ITrigT1MuonRecRoiTool.h.

◆ EndcapRMask()

unsigned int LVL1::ITrigT1MuonRecRoiTool::EndcapRMask ( ) const
inline

Definition at line 60 of file ITrigT1MuonRecRoiTool.h.

◆ EndcapRoIMask()

unsigned int LVL1::ITrigT1MuonRecRoiTool::EndcapRoIMask ( ) const
inline

Definition at line 58 of file ITrigT1MuonRecRoiTool.h.

◆ EndcapSectorIDMask()

unsigned int LVL1::ITrigT1MuonRecRoiTool::EndcapSectorIDMask ( ) const
inline

Definition at line 52 of file ITrigT1MuonRecRoiTool.h.

◆ etaDimHigh()

virtual bool LVL1::ITrigT1MuonRecRoiTool::etaDimHigh ( const TrigT1MuonRecRoiData & data,
double & etaMin,
double & etaMax ) const
pure virtual

◆ etaDimLow()

virtual bool LVL1::ITrigT1MuonRecRoiTool::etaDimLow ( const TrigT1MuonRecRoiData & data,
double & etaMin,
double & etaMax ) const
pure virtual

◆ ForwardPhiMask()

unsigned int LVL1::ITrigT1MuonRecRoiTool::ForwardPhiMask ( ) const
inline

Definition at line 63 of file ITrigT1MuonRecRoiTool.h.

◆ ForwardRMask()

unsigned int LVL1::ITrigT1MuonRecRoiTool::ForwardRMask ( ) const
inline

Definition at line 62 of file ITrigT1MuonRecRoiTool.h.

◆ ForwardRoIMask()

unsigned int LVL1::ITrigT1MuonRecRoiTool::ForwardRoIMask ( ) const
inline

Definition at line 59 of file ITrigT1MuonRecRoiTool.h.

◆ ForwardSectorIDMask()

unsigned int LVL1::ITrigT1MuonRecRoiTool::ForwardSectorIDMask ( ) const
inline

Definition at line 53 of file ITrigT1MuonRecRoiTool.h.

◆ getBitMaskValue()

unsigned int LVL1::ITrigT1MuonRecRoiTool::getBitMaskValue ( const unsigned int * uintValue,
const unsigned int mask ) const

Definition at line 10 of file ITrigT1MuonRecRoiTool.cxx.

11 {
12 unsigned int maskcopy = mask;
13 unsigned int result = *uintValue & mask;
14 if ( mask != 0 ) {
15 while ( ( maskcopy & 0x00000001 ) == 0 ) {
16 maskcopy = maskcopy >> 1;
17 result = result >> 1;
18 }
19 }
20 return result;
21 }

◆ getSystem()

ITrigT1MuonRecRoiTool::MuonTriggerSystem LVL1::ITrigT1MuonRecRoiTool::getSystem ( const unsigned int & roiWord) const

Definition at line 23 of file ITrigT1MuonRecRoiTool.cxx.

24 {
25 unsigned int result = getBitMaskValue(&roiWord,SysIDMask());
26 if( result == 0x0 ) return Barrel;
27 else if( result == 0x1 ) return Forward;
28 else if( result>>1 ) return Endcap;
29 else return Undef;
30 }
unsigned int getBitMaskValue(const unsigned int *uintValue, const unsigned int mask) const

◆ GoodMFMask()

unsigned int LVL1::ITrigT1MuonRecRoiTool::GoodMFMask ( ) const
inline

Definition at line 68 of file ITrigT1MuonRecRoiTool.h.

◆ InnerCoinMask()

unsigned int LVL1::ITrigT1MuonRecRoiTool::InnerCoinMask ( ) const
inline

Definition at line 67 of file ITrigT1MuonRecRoiTool.h.

◆ IsFirstCandMask()

unsigned int LVL1::ITrigT1MuonRecRoiTool::IsFirstCandMask ( ) const
inline

Definition at line 49 of file ITrigT1MuonRecRoiTool.h.

◆ IsRun3Mask()

unsigned int LVL1::ITrigT1MuonRecRoiTool::IsRun3Mask ( ) const
inline

Definition at line 46 of file ITrigT1MuonRecRoiTool.h.

◆ IsVetoedMask()

unsigned int LVL1::ITrigT1MuonRecRoiTool::IsVetoedMask ( ) const
inline

Definition at line 47 of file ITrigT1MuonRecRoiTool.h.

◆ OverflowPerRoIMask()

unsigned int LVL1::ITrigT1MuonRecRoiTool::OverflowPerRoIMask ( ) const
inline

Definition at line 64 of file ITrigT1MuonRecRoiTool.h.

◆ OverflowPerSectorMask()

unsigned int LVL1::ITrigT1MuonRecRoiTool::OverflowPerSectorMask ( ) const
inline

Definition at line 65 of file ITrigT1MuonRecRoiTool.h.

◆ roiData()

virtual StatusCode LVL1::ITrigT1MuonRecRoiTool::roiData ( const unsigned int & roiWord,
TrigT1MuonRecRoiData & data ) const
pure virtual

pure virtual function to return eta and phi coord of RoI

◆ RoIsize()

virtual StatusCode LVL1::ITrigT1MuonRecRoiTool::RoIsize ( const unsigned int & roiWord,
double & etaMin,
double & etaMax,
double & phiMin,
double & phiMax ) const
pure virtual

pure virtual function returns roi size

◆ SectorAddressMask()

unsigned int LVL1::ITrigT1MuonRecRoiTool::SectorAddressMask ( ) const
inline

Definition at line 50 of file ITrigT1MuonRecRoiTool.h.

◆ SubSysIDMask()

unsigned int LVL1::ITrigT1MuonRecRoiTool::SubSysIDMask ( ) const
inline

Definition at line 55 of file ITrigT1MuonRecRoiTool.h.

◆ SysIDMask()

unsigned int LVL1::ITrigT1MuonRecRoiTool::SysIDMask ( ) const
inline

Definition at line 54 of file ITrigT1MuonRecRoiTool.h.

◆ ThresholdMask()

unsigned int LVL1::ITrigT1MuonRecRoiTool::ThresholdMask ( ) const
inline

Definition at line 56 of file ITrigT1MuonRecRoiTool.h.

◆ updateBitMask()

void LVL1::ITrigT1MuonRecRoiTool::updateBitMask ( const RoiWordFormat format)

Definition at line 36 of file ITrigT1MuonRecRoiTool.cxx.

36 {
37 if( format == Run2 ){
38 m_IsRun3Mask = 0x80000000;
39 m_IsVetoedMask = 0x10000000;
40 m_ChargeMask = 0x08000000;
41 m_IsFirstCandMask = 0x00400000;
42 m_SectorAddressMask = 0x003fc000;
43 m_BarrelSectorIDMask = 0x000f8000;
44 m_EndcapSectorIDMask = 0x001f8000;
45 m_ForwardSectorIDMask = 0x000f8000;
46 m_SysIDMask = 0x00300000;
47 m_SubSysIDMask = 0x00004000;
48 m_ThresholdMask = 0x00003800;
49 m_BarrelRoIMask = 0x0000007c;
50 m_EndcapRoIMask = 0x000003fc;
51 m_ForwardRoIMask = 0x000000fc;
52 m_EndcapRMask = 0x000003f0;
53 m_EndcapPhiMask = 0x0000000c;
54 m_ForwardRMask = 0x000000f0;
55 m_ForwardPhiMask = 0x0000000c;
56 m_OverflowPerRoIMask = 0x00000002;
57 m_OverflowPerSectorMask = 0x00000001;
58 m_BW2Or3Mask = 0x00000000; // undef
59 m_InnerCoinMask = 0x00000000; // undef
60 m_GoodMFMask = 0x00000000; // undef
61 }else if( format == Run3 ){
62 m_IsRun3Mask = 0x80000000;
65 m_IsFirstCandMask = 0x00000000; // undef
85 }else{
86 // no update
87 }
88 }
static constexpr uint32_t RUN3_CAND_WORD_CANDFLAGS_ECFW_PHI_MASK
static constexpr uint32_t FORWARD_SECTORID_MASK
Mask for extracting the sector ID for forward candidates from the data word.
static constexpr uint32_t RUN3_ROI_SHIFT
Position of the RoI bits in the data word.
Definition MuCTPI_Bits.h:45
static constexpr uint32_t RUN3_SUBSYS_ADDRESS_SHIFT
Position in the data word of the subsystem bits.
Definition MuCTPI_Bits.h:93
static constexpr uint32_t RUN3_SUBSYS_HEMISPHERE_MASK
static constexpr uint32_t RUN3_CAND_WORD_CANDFLAGS_EC_R_MASK
static constexpr uint32_t RUN3_CAND_WORD_VETO_MASK
static constexpr uint32_t RUN3_CAND_PT_MASK
Mask for extracting the pT threshold passed by the candidate from the data word.
Definition MuCTPI_Bits.h:62
static constexpr uint32_t RUN3_CAND_WORD_CANDFLAGS_ECFW_GOODMF_MASK
static constexpr uint32_t BARREL_SECTORID_MASK
Mask for extracting the sector ID for barrel candidates from the data word.
static constexpr uint32_t RUN3_CAND_WORD_CANDFLAGS_ECFW_GOODMF_SHIFT
static constexpr uint32_t ENDCAP_ROI_MASK
Mask for extracting the RoI for endcap candidates from the data words.
Definition MuCTPI_Bits.h:41
static constexpr uint32_t RUN3_CAND_WORD_CANDFLAGS_FW_R_MASK
static constexpr uint32_t BARREL_ROI_MASK
new in v2
Definition MuCTPI_Bits.h:39
static constexpr uint32_t RUN3_SUBSYS_ADDRESS_BAFW_MASK
Definition MuCTPI_Bits.h:97
static constexpr uint32_t RUN3_CAND_WORD_CANDFLAGS_ECFW_BW23_MASK
static constexpr uint32_t RUN3_CAND_WORD_CANDFLAGS_ECFW_INNERCOIN_MASK
static constexpr uint32_t RUN3_CAND_WORD_CANDFLAGS_ECFW_CHARGE_MASK
static constexpr uint32_t RUN3_CAND_SECTOR_ADDRESS_SHIFT
Position of the muon candidate's address in the data word.
Definition MuCTPI_Bits.h:82
static constexpr uint32_t ROI_OVERFLOW_MASK
Mask for the bit showing if more than one muon candidates were in the sector RoI.
Definition MuCTPI_Bits.h:31
static constexpr uint32_t RUN3_CAND_PT_SHIFT
Position of the pT threshold bits in the data words.
Definition MuCTPI_Bits.h:65
static constexpr uint32_t RUN3_CAND_WORD_CANDFLAGS_ECFW_CHARGE_SHIFT
static constexpr uint32_t RUN3_CAND_WORD_VETO_SHIFT
static constexpr uint32_t RUN3_CAND_WORD_CANDFLAGS_ECFW_BW23_SHIFT
static constexpr uint32_t ENDCAP_SECTORID_MASK
Mask for extracting the sector ID for endcap candidates from the data word.
static constexpr uint32_t RUN3_CAND_WORD_CANDFLAGS_ECFW_INNERCOIN_SHIFT
static constexpr uint32_t RUN3_CAND_SECTORID_SHIFT
static constexpr uint32_t RUN3_ROI_OVERFLOW_SHIFT
Position of the RoI overflow mask.
Definition MuCTPI_Bits.h:33
static constexpr uint32_t RUN3_CAND_WORD_CANDFLAGS_ECFW_PHI_SHIFT
static constexpr uint32_t RUN3_SUBSYS_HEMISPHERE_SHIFT
static constexpr uint32_t RUN3_CAND_OVERFLOW_SHIFT
Position of the candidate overflow mask.
Definition MuCTPI_Bits.h:27
static constexpr uint32_t FORWARD_ROI_MASK
Mask for extracting the RoI for forward candidates from the data words.
Definition MuCTPI_Bits.h:43
static constexpr uint32_t RUN3_CAND_WORD_CANDFLAGS_ECFW_R_SHIFT
static constexpr uint32_t CAND_OVERFLOW_MASK
Mask for the bit showing if more than two muon candidates were in the trigger sector.
Definition MuCTPI_Bits.h:25
static constexpr uint32_t RUN3_CAND_SECTOR_ADDRESS_MASK
Mask for extracting the address of the muon candidate from the data word This is the mask and shift f...
Definition MuCTPI_Bits.h:77

Member Data Documentation

◆ m_BarrelRoIMask

unsigned int LVL1::ITrigT1MuonRecRoiTool::m_BarrelRoIMask {0}
private

Definition at line 87 of file ITrigT1MuonRecRoiTool.h.

87{0};

◆ m_BarrelSectorIDMask

unsigned int LVL1::ITrigT1MuonRecRoiTool::m_BarrelSectorIDMask {0}
private

Definition at line 81 of file ITrigT1MuonRecRoiTool.h.

81{0};

◆ m_BW2Or3Mask

unsigned int LVL1::ITrigT1MuonRecRoiTool::m_BW2Or3Mask {0}
private

Definition at line 96 of file ITrigT1MuonRecRoiTool.h.

96{0};

◆ m_ChargeMask

unsigned int LVL1::ITrigT1MuonRecRoiTool::m_ChargeMask {0}
private

Definition at line 78 of file ITrigT1MuonRecRoiTool.h.

78{0};

◆ m_EndcapPhiMask

unsigned int LVL1::ITrigT1MuonRecRoiTool::m_EndcapPhiMask {0}
private

Definition at line 91 of file ITrigT1MuonRecRoiTool.h.

91{0};

◆ m_EndcapRMask

unsigned int LVL1::ITrigT1MuonRecRoiTool::m_EndcapRMask {0}
private

Definition at line 90 of file ITrigT1MuonRecRoiTool.h.

90{0};

◆ m_EndcapRoIMask

unsigned int LVL1::ITrigT1MuonRecRoiTool::m_EndcapRoIMask {0}
private

Definition at line 88 of file ITrigT1MuonRecRoiTool.h.

88{0};

◆ m_EndcapSectorIDMask

unsigned int LVL1::ITrigT1MuonRecRoiTool::m_EndcapSectorIDMask {0}
private

Definition at line 82 of file ITrigT1MuonRecRoiTool.h.

82{0};

◆ m_ForwardPhiMask

unsigned int LVL1::ITrigT1MuonRecRoiTool::m_ForwardPhiMask {0}
private

Definition at line 93 of file ITrigT1MuonRecRoiTool.h.

93{0};

◆ m_ForwardRMask

unsigned int LVL1::ITrigT1MuonRecRoiTool::m_ForwardRMask {0}
private

Definition at line 92 of file ITrigT1MuonRecRoiTool.h.

92{0};

◆ m_ForwardRoIMask

unsigned int LVL1::ITrigT1MuonRecRoiTool::m_ForwardRoIMask {0}
private

Definition at line 89 of file ITrigT1MuonRecRoiTool.h.

89{0};

◆ m_ForwardSectorIDMask

unsigned int LVL1::ITrigT1MuonRecRoiTool::m_ForwardSectorIDMask {0}
private

Definition at line 83 of file ITrigT1MuonRecRoiTool.h.

83{0};

◆ m_GoodMFMask

unsigned int LVL1::ITrigT1MuonRecRoiTool::m_GoodMFMask {0}
private

Definition at line 98 of file ITrigT1MuonRecRoiTool.h.

98{0};

◆ m_InnerCoinMask

unsigned int LVL1::ITrigT1MuonRecRoiTool::m_InnerCoinMask {0}
private

Definition at line 97 of file ITrigT1MuonRecRoiTool.h.

97{0};

◆ m_IsFirstCandMask

unsigned int LVL1::ITrigT1MuonRecRoiTool::m_IsFirstCandMask {0}
private

Definition at line 79 of file ITrigT1MuonRecRoiTool.h.

79{0};

◆ m_IsRun3Mask

unsigned int LVL1::ITrigT1MuonRecRoiTool::m_IsRun3Mask {0}
private

Definition at line 76 of file ITrigT1MuonRecRoiTool.h.

76{0};

◆ m_IsVetoedMask

unsigned int LVL1::ITrigT1MuonRecRoiTool::m_IsVetoedMask {0}
private

Definition at line 77 of file ITrigT1MuonRecRoiTool.h.

77{0};

◆ m_OverflowPerRoIMask

unsigned int LVL1::ITrigT1MuonRecRoiTool::m_OverflowPerRoIMask {0}
private

Definition at line 94 of file ITrigT1MuonRecRoiTool.h.

94{0};

◆ m_OverflowPerSectorMask

unsigned int LVL1::ITrigT1MuonRecRoiTool::m_OverflowPerSectorMask {0}
private

Definition at line 95 of file ITrigT1MuonRecRoiTool.h.

95{0};

◆ m_SectorAddressMask

unsigned int LVL1::ITrigT1MuonRecRoiTool::m_SectorAddressMask {0}
private

Definition at line 80 of file ITrigT1MuonRecRoiTool.h.

80{0};

◆ m_SubSysIDMask

unsigned int LVL1::ITrigT1MuonRecRoiTool::m_SubSysIDMask {0}
private

Definition at line 85 of file ITrigT1MuonRecRoiTool.h.

85{0};

◆ m_SysIDMask

unsigned int LVL1::ITrigT1MuonRecRoiTool::m_SysIDMask {0}
private

Definition at line 84 of file ITrigT1MuonRecRoiTool.h.

84{0};

◆ m_ThresholdMask

unsigned int LVL1::ITrigT1MuonRecRoiTool::m_ThresholdMask {0}
private

Definition at line 86 of file ITrigT1MuonRecRoiTool.h.

86{0};

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