ATLAS Offline Software
Loading...
Searching...
No Matches
xAOD::MuonRoI_v1 Class Reference

Class describing a LVL1 muon region of interest. More...

#include <MuonRoI_v1.h>

Inheritance diagram for xAOD::MuonRoI_v1:
Collaboration diagram for xAOD::MuonRoI_v1:

Public Types

enum  RoISource { Barrel , Endcap , Forward }
 RoI source enumeration. More...
enum  Hemisphere { Positive , Negative }
 RoI hemisphere enumeration. More...
enum  Charge { Neg = 0 , Pos = 1 , Undef = 100 }
 Charge sign. More...

Public Member Functions

 MuonRoI_v1 ()
 Default constructor.
void initialize (uint32_t roiword, float eta, float phi, const std::string &thrname, float thrvalue, uint32_t extraword=0u)
 Initialise the object with all its properties.
Independent properties stored for the muon candidate
float eta () const
 The pseudorapidity ( \(\eta\)) of the muon candidate.
void setEta (float v)
 Set the pseudorapidity of the muon candidate.
float phi () const
 The azimuthal angle ( \(\phi\)) of the muon candidate.
void setPhi (float v)
 Set the azimuthal angle of the muon candidate.
uint32_t roiWord () const
 The "raw" RoI word describing the muon candidate.
void setRoIWord (uint32_t value)
 Set the "raw" RoI word, describing the muon candidate.
float thrValue () const
 The highest threshold value (in MeV) passed by the muon candidate.
void setThrValue (float v)
 Set the threshold value passed by the muon candidate.
const std::string & thrName () const
 The name of the highest threshold value passed by the muon candidate.
void setThrName (const std::string &value)
 Set the name of the threshold passed by the muon candidate.
Properties extracted from the 32-bit muon RoI word
int getThrNumber () const
 Get the logic number of the highest threshold this RoI passed.
int getRoI () const
 Get the "RoI number" (position inside the sector).
int getSectorAddress () const
 Get the full sector address.
int getSectorID () const
 Get the sector ID number.
bool isFirstCandidate () const
 Returns if the candidate had the highest pT in the sector.
bool isMoreCandInRoI () const
 Returns if there were other muons detected in the same RoI.
bool isMoreCandInSector () const
 Returns if there were other muons detected in the same sector.
RoISource getSource () const
 Returns the system that detected the muon candidate.
Hemisphere getHemisphere () const
 Returns the hemisphere that detected the muon candidate.
bool getPhiOverlap () const
 Returns whether there's overlap between barrel sectors.
bool getEtaOverlap () const
 Returns whether there's overlap between the barrel-EC sectors.
Charge getCharge () const
 Returns the charge sign of the muon candidate.
bool getBW3Coincidence () const
 Returns whether or not there was a 3-station coincidence in the TGC.
bool getInnerCoincidence () const
 Returns whether or not there was an inner coincidence in the TGC.
bool getGoodMF () const
 Returns whether or not there was a good magnetic field quality in the TGC.
bool isVetoed () const
 Returns the veto flag for the candidate.
bool isRun3 () const
 Returns extra flag at end of RoI word indicating that it's in Run3 format.
Properties available only for Run 4+
uint32_t roiExtraWord () const
 The second "raw" RoI word describing extra information of the muon candidate.
void setRoIExtraWord (uint32_t value)
 Set the second "raw" RoI word, describing extra information of the muon candidate.
float pt () const
 the transverse momentum of the muon candidate
bool isRun4 () const
 flag whether it is Run4+ RoI definition

Static Public Attributes

static constexpr uint32_t ETA_MASK = 0x3fff
 constants to decode RoI word for Run 4+
static constexpr uint32_t PHI_MASK = 0x1ff
static constexpr uint32_t PT_MASK = 0xff
static constexpr uint32_t THR_MASK = 0xf

Static Private Attributes

static constexpr uint32_t ETA_SHIFT = 0
static constexpr uint32_t PHI_SHIFT = 14
static constexpr uint32_t CHARGE_SHIFT = 23
static constexpr uint32_t PT_SHIFT = 24
static constexpr uint32_t THR_SHIFT = 0
static constexpr float PT_WIDTH = 0.5

Detailed Description

Class describing a LVL1 muon region of interest.

This class describes all the properties of a muon region of interest (RoI) in the xAOD format.

Author
Lukas Heinrich Lukas.nosp@m..Hei.nosp@m.nrich.nosp@m.@cer.nosp@m.n.ch
Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Definition at line 29 of file MuonRoI_v1.h.

Member Enumeration Documentation

◆ Charge

Charge sign.

Enumerator
Neg 

Candidate is a mu- from a TGC sector.

Pos 

Candidate is a mu+ from a TGC sector.

Undef 

This is an RPC candidate.

Definition at line 44 of file MuonRoI_v1.h.

44 {
45 Neg = 0,
46 Pos = 1,
47 Undef = 100
48 };
@ Neg
Candidate is a mu- from a TGC sector.
Definition MuonRoI_v1.h:45
@ Pos
Candidate is a mu+ from a TGC sector.
Definition MuonRoI_v1.h:46
@ Undef
This is an RPC candidate.
Definition MuonRoI_v1.h:47

◆ Hemisphere

RoI hemisphere enumeration.

Enumerator
Positive 

The candidate came from the +z side (side A).

Negative 

The candidate came from the -z side (side C).

Definition at line 39 of file MuonRoI_v1.h.

39 {
40 Positive,
42 };
@ Positive
The candidate came from the +z side (side A).
Definition MuonRoI_v1.h:40
@ Negative
The candidate came from the -z side (side C).
Definition MuonRoI_v1.h:41

◆ RoISource

RoI source enumeration.

Enumerator
Barrel 

The muon candidate was detected in the barrel region.

Endcap 

The muon candidate was detected in the endcap region.

Forward 

The muon candidate was detected in the forward region.

Definition at line 33 of file MuonRoI_v1.h.

33 {
34 Barrel,
35 Endcap,
36 Forward
37 };
@ Endcap
The muon candidate was detected in the endcap region.
Definition MuonRoI_v1.h:35
@ Forward
The muon candidate was detected in the forward region.
Definition MuonRoI_v1.h:36
@ Barrel
The muon candidate was detected in the barrel region.
Definition MuonRoI_v1.h:34

Constructor & Destructor Documentation

◆ MuonRoI_v1()

xAOD::MuonRoI_v1::MuonRoI_v1 ( )

Default constructor.

Definition at line 17 of file MuonRoI_v1.cxx.

18 : SG::AuxElement() {
19
20 }
AuxElement(SG::AuxVectorData *container, size_t index)
Base class for elements of a container that can have aux data.

Member Function Documentation

◆ eta()

float xAOD::MuonRoI_v1::eta ( ) const

The pseudorapidity ( \(\eta\)) of the muon candidate.

◆ getBW3Coincidence()

bool xAOD::MuonRoI_v1::getBW3Coincidence ( ) const

Returns whether or not there was a 3-station coincidence in the TGC.

Get whether or not there was a 3-station coincidence in the TGC.

Valid for Run-3 candidates only.

Definition at line 289 of file MuonRoI_v1.cxx.

289 {
290 if (isRun4()) return false; // TBI
291 if (isRun3() && getSource() != Barrel) return (roiWord() >> RUN3_CAND_TGC_BW2OR3_SHIFT) & 0x1;
292 else return false;
293 }
RoISource getSource() const
Returns the system that detected the muon candidate.
uint32_t roiWord() const
The "raw" RoI word describing the muon candidate.
bool isRun3() const
Returns extra flag at end of RoI word indicating that it's in Run3 format.
bool isRun4() const
flag whether it is Run4+ RoI definition
static constexpr uint32_t RUN3_CAND_TGC_BW2OR3_SHIFT
Position of the bit specifying 3-station coincidence from the big wheel.

◆ getCharge()

MuonRoI_v1::Charge xAOD::MuonRoI_v1::getCharge ( ) const

Returns the charge sign of the muon candidate.

Endcap and forward sectors can tell you what was the charge of the muon candidate.

Barrel candidates can't do this.

See also
MuonRoI_v1::RoISource
MuonRoI_v1::getSource()

Definition at line 264 of file MuonRoI_v1.cxx.

264 {
265 if (isRun4()) {
266 return ((roiWord() >> CHARGE_SHIFT) & 0x1) ? Pos : Neg;
267 }
268
269 if( getSource() == Barrel ) return Undef;
270
271 if (isRun3()) {
272 if( ( roiWord() >> RUN3_CAND_TGC_CHARGE_SIGN_SHIFT) & 0x1 ) {
273 return Pos;
274 } else {
275 return Neg;
276 }
277 } else {
278 if( ( roiWord() >> CAND_TGC_CHARGE_SIGN_SHIFT) & 0x1 ) {
279 return Pos;
280 } else {
281 return Neg;
282 }
283 }
284 }
static constexpr uint32_t CHARGE_SHIFT
Definition MuonRoI_v1.h:155
static constexpr uint32_t CAND_TGC_CHARGE_SIGN_SHIFT
static constexpr uint32_t RUN3_CAND_TGC_CHARGE_SIGN_SHIFT
Position of the bit specifying the candidate's sign.

◆ getEtaOverlap()

bool xAOD::MuonRoI_v1::getEtaOverlap ( ) const

Returns whether there's overlap between the barrel-EC sectors.

Get whether or not there was a eta overlap between barrel and endcap sectors at SL-level.

This is different from the overlap removal performed in the MUCTPI. Valid for Run-2 RPC/TGC candidates only

Definition at line 249 of file MuonRoI_v1.cxx.

249 {
250 if (isRun4()) return false; // TBI
251 if (isRun3()) return false;
252 else {
254 else return (roiWord() >> ENDCAP_OL_SHIFT) & ENDCAP_OL_MASK;
255 }
256 }
static constexpr uint32_t ENDCAP_OL_MASK
Mask for extracting the overlap bits for endcap candidates from the data words.
Definition MuCTPI_Bits.h:56
static constexpr uint32_t ENDCAP_OL_SHIFT
Position of the overlap bits in endcap data words.
Definition MuCTPI_Bits.h:59
static constexpr uint32_t BARREL_ETA_OL_MASK
Definition MuCTPI_Bits.h:52
static constexpr uint32_t BARREL_OL_SHIFT
Position of the overlap bits in barrel data words.
Definition MuCTPI_Bits.h:54

◆ getGoodMF()

bool xAOD::MuonRoI_v1::getGoodMF ( ) const

Returns whether or not there was a good magnetic field quality in the TGC.

Get whether or not there was a good magnetic field quality in the TGC.

Valid for Run-3 candidates only.

Definition at line 309 of file MuonRoI_v1.cxx.

309 {
310 if (isRun4()) return false; // TBI
311 if (isRun3() && getSource() != Barrel) return (roiWord() >> RUN3_CAND_TGC_GOODMF_SHIFT) & 0x1;
312 else return false;
313 }
static constexpr uint32_t RUN3_CAND_TGC_GOODMF_SHIFT
Position of the bit specifying if RoI is in a good b-field region (1=good, 0=bad).

◆ getHemisphere()

MuonRoI_v1::Hemisphere xAOD::MuonRoI_v1::getHemisphere ( ) const

Returns the hemisphere that detected the muon candidate.

The function decodes the sector hemisphere encoded in the 8-bit sector address into an easy to understand enumeration.

See also
MuonRoI_v1::getSectorAddress()
MuonRoI_v1::Hemisphere

Definition at line 220 of file MuonRoI_v1.cxx.

220 {
221 if (isRun4()) return Positive; // TBI - not correct
222 //same mask for run2 and run3
224 return Positive;
225 } else {
226 return Negative;
227 }
228 }
int getSectorAddress() const
Get the full sector address.
static constexpr uint32_t SECTOR_HEMISPHERE_MASK
Mask for the bit showing which hemisphere the candidate came from.(1: positive; 0: negative).
Definition MuCTPI_Bits.h:80

◆ getInnerCoincidence()

bool xAOD::MuonRoI_v1::getInnerCoincidence ( ) const

Returns whether or not there was an inner coincidence in the TGC.

Get whether or not there was an inner coincidence with the TGC.

Valid for Run-3 candidates only.

Definition at line 299 of file MuonRoI_v1.cxx.

299 {
300 if (isRun4()) return false; // TBI
301 if (isRun3() && getSource() != Barrel) return (roiWord() >> RUN3_CAND_TGC_INNERCOIN_SHIFT) & 0x1;
302 else return false;
303 }
static constexpr uint32_t RUN3_CAND_TGC_INNERCOIN_SHIFT
Position of the bit specifying coincidence with inner detectors.

◆ getPhiOverlap()

bool xAOD::MuonRoI_v1::getPhiOverlap ( ) const

Returns whether there's overlap between barrel sectors.

Get whether or not there was a phi overlap between barrel sectors at SL-level.

This is different from the overlap removal performed in the MUCTPI. Valid for Run-2 and Run-3 RPC candidates only

Definition at line 234 of file MuonRoI_v1.cxx.

234 {
235 if (isRun4()) return false; // TBI
236 if (isRun3()) {
238 else return false;
239 } else {
241 else return false;
242 }
243 }
static constexpr uint32_t RUN3_CAND_WORD_CANDFLAGS_BA_PHIOVERLAP_SHIFT
static constexpr uint32_t RUN3_CAND_WORD_CANDFLAGS_BA_PHIOVERLAP_MASK
static constexpr uint32_t BARREL_PHI_OL_MASK
Definition MuCTPI_Bits.h:51

◆ getRoI()

int xAOD::MuonRoI_v1::getRoI ( ) const

Get the "RoI number" (position inside the sector).

A muon's spacial location is identified from the sector number and the hemisphere that detected it.

Each sector is additionally divided into multiple areas, called RoIs that tell you which part of the sector the muon candidate was detected in.

Returns
Integer number smaller than 147

Definition at line 89 of file MuonRoI_v1.cxx.

89 {
90 if (isRun4()) {
91 return 0; // TBI
92 } else if (isRun3()) {
93 if( this->getSource() == Forward ) {
94 return ( ( roiWord() >> RUN3_ROI_SHIFT ) & FORWARD_ROI_MASK );
95 } else if( this->getSource() == Endcap ) {
96 return ( ( roiWord() >> RUN3_ROI_SHIFT ) & ENDCAP_ROI_MASK );
97 } else if( this->getSource() == Barrel ) {
98 return ( ( roiWord() >> RUN3_ROI_SHIFT ) & BARREL_ROI_MASK );
99 }
100 } else {
101 if( this->getSource() == Forward ) {
102 return ( ( roiWord() >> ROI_SHIFT ) & FORWARD_ROI_MASK );
103 } else if( this->getSource() == Endcap ) {
104 return ( ( roiWord() >> ROI_SHIFT ) & ENDCAP_ROI_MASK );
105 } else if( this->getSource() == Barrel ) {
106 return ( ( roiWord() >> ROI_SHIFT ) & BARREL_ROI_MASK );
107 }
108 }
109 return 0;
110 }
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 ENDCAP_ROI_MASK
Mask for extracting the RoI for endcap candidates from the data words.
Definition MuCTPI_Bits.h:41
static constexpr uint32_t BARREL_ROI_MASK
new in v2
Definition MuCTPI_Bits.h:39
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 ROI_SHIFT
Definition MuCTPI_Bits.h:46

◆ getSectorAddress()

int xAOD::MuonRoI_v1::getSectorAddress ( ) const

Get the full sector address.

The sector address is an 8-bit identifier of the sector.

For its detailed description, see page 38 of https://edms.cern.ch/file/248757/1/mirod.pdf

The least significant bit shown which hemisphere the sector is in (0: positive side, 1: negative side), the upper (1 or 2) bits show what kind of sector it is, the rest of the address is the number of the sector.

Returns
An 8-bit identifier

Definition at line 122 of file MuonRoI_v1.cxx.

122 {
123 if (isRun4()) return 0; // TBI
126 }
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 CAND_SECTOR_ADDRESS_SHIFT
Definition MuCTPI_Bits.h:83
static constexpr uint32_t CAND_SECTOR_ADDRESS_MASK
Definition MuCTPI_Bits.h:78

◆ getSectorID()

int xAOD::MuonRoI_v1::getSectorID ( ) const

Get the sector ID number.

The sector ID is a 5- or 6-bit identifier of the sector number.

For its detailed description, see page 38 of https://edms.cern.ch/file/248757/1/mirod.pdf

Returns
A 5- or 6-bit identifier

Definition at line 133 of file MuonRoI_v1.cxx.

133 {
134 if (isRun4()) {
135 return 0; // TBI
136 } else if (isRun3()) {
137 if( this->getSource() == Forward ) {
139 } else if( this->getSource() == Endcap ) {
141 } else if( this->getSource() == Barrel ) {
143 }
144 } else {
145 if( this->getSource() == Forward ) {
147 } else if( this->getSource() == Endcap ) {
149 } else if( this->getSource() == Barrel ) {
151 }
152 }
153 return 0;
154 }
static constexpr uint32_t FORWARD_SECTORID_MASK
Mask for extracting the sector ID for forward candidates from the data word.
static constexpr uint32_t BARREL_SECTORID_MASK
Mask for extracting the sector ID for barrel candidates from the data word.
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_SECTORID_SHIFT
static constexpr uint32_t CAND_SECTORID_SHIFT

◆ getSource()

MuonRoI_v1::RoISource xAOD::MuonRoI_v1::getSource ( ) const

Returns the system that detected the muon candidate.

The function decodes the sector type encoded in the 8-bit sector address into an easy to understand enumeration.

See also
MuonRoI_v1::getSectorAddress()
MuonRoI_v1::RoISource

Definition at line 202 of file MuonRoI_v1.cxx.

202 {
203 if (isRun4()) return Barrel; // TBI - not correct
204 //same mask for run2 and run3
205 if( this->getSectorAddress() & ENDCAP_ADDRESS_MASK ) {
206 return Endcap;
207 } else if( this->getSectorAddress() & FORWARD_ADDRESS_MASK ) {
208 return Forward;
209 } else {
210 return Barrel;
211 }
212 }
static constexpr uint32_t FORWARD_ADDRESS_MASK
Bit in the candidate's address turned on for forward candidates.
Definition MuCTPI_Bits.h:89
static constexpr uint32_t ENDCAP_ADDRESS_MASK
Bit in the candidate's address turned on for endcap candidates.
Definition MuCTPI_Bits.h:87

◆ getThrNumber()

setThrValue setRoIExtraWord int xAOD::MuonRoI_v1::getThrNumber ( ) const

Get the logic number of the highest threshold this RoI passed.

Each detected LVL1 muon candidate is assigned a pT threshold.

The hardware can assign one of 6/15 pT thresholds to the candidate, which are numbered from 1 to 6 for Run-1/2, and 1 to 15 for Run-3.

Returns
Integer number in the [1, 6] range

Definition at line 76 of file MuonRoI_v1.cxx.

76 {
77 if (isRun4()) return static_cast<int>((roiExtraWord() >> THR_SHIFT) & THR_MASK);
78 else if (isRun3()) return ( ( roiWord() >> RUN3_CAND_PT_SHIFT ) & RUN3_CAND_PT_MASK );
79 else return ( ( roiWord() >> CAND_PT_SHIFT ) & CAND_PT_MASK );
80 }
uint32_t roiExtraWord() const
The second "raw" RoI word describing extra information of the muon candidate.
static constexpr uint32_t THR_SHIFT
Definition MuonRoI_v1.h:158
static constexpr uint32_t THR_MASK
Definition MuonRoI_v1.h:150
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 CAND_PT_MASK
Definition MuCTPI_Bits.h:63
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 CAND_PT_SHIFT
Definition MuCTPI_Bits.h:66

◆ initialize()

void xAOD::MuonRoI_v1::initialize ( uint32_t roiword,
float eta,
float phi,
const std::string & thrname,
float thrvalue,
uint32_t extraword = 0u )

Initialise the object with all its properties.

Initialize the object for Run-4+ RoI definition.

Parameters
roiwordThe 32-bit RoI word coming from the MuCTPI
etaThe pseudorapidity of the candidate
phiThe aximuthal angle of the candidate
thrnameThe name of the highest threshold passed by the candidate
thrvalueThe value (in MeV) of the threshold passed
extraWordThe 32-bit extra RoI word from the MUCTPI

Definition at line 31 of file MuonRoI_v1.cxx.

33 {
34
35 setRoIWord( roiword );
36 setEta( eta );
37 setPhi( phi );
38 setThrValue( thrvalue );
39 setThrName( thrname );
40 setRoIExtraWord( extraword );
41 return;
42 }
float eta() const
The pseudorapidity ( ) of the muon candidate.
void setRoIExtraWord(uint32_t value)
Set the second "raw" RoI word, describing extra information of the muon candidate.
void setEta(float v)
Set the pseudorapidity of the muon candidate.
void setRoIWord(uint32_t value)
Set the "raw" RoI word, describing the muon candidate.
float phi() const
The azimuthal angle ( ) of the muon candidate.
void setThrValue(float v)
Set the threshold value passed by the muon candidate.
void setPhi(float v)
Set the azimuthal angle of the muon candidate.
void setThrName(const std::string &value)
Set the name of the threshold passed by the muon candidate.

◆ isFirstCandidate()

bool xAOD::MuonRoI_v1::isFirstCandidate ( ) const

Returns if the candidate had the highest pT in the sector.

Each muon trigger sector can only send information about a maximum of two LVL1 muon candidate to the central trigger.

If this flag is true, this candidate had the highest pT threshold assigned to it in its sector. If it's false, it was the second candidate in its sector.

actually v1 only ...

Definition at line 163 of file MuonRoI_v1.cxx.

163 {
164 if (isRun4()) return true; // TBI
165 else if (isRun3()) return true; // undefined in run3, return default true
166 else return ( ( roiWord() >> CAND_HIGHEST_PT_SHIFT ) & CAND_HIGHEST_PT_MASK );
167 }
static constexpr uint32_t CAND_HIGHEST_PT_MASK
gone in v2 Mask for extracting the bit from the data word showing whether the candidate had the highe...
static constexpr uint32_t CAND_HIGHEST_PT_SHIFT
Position of the "highest p<sub>T</sub>" bit.

◆ isMoreCandInRoI()

bool xAOD::MuonRoI_v1::isMoreCandInRoI ( ) const

Returns if there were other muons detected in the same RoI.

One RoI (one part of the trigger sector) can only send information about one LVL1 muon candidate to the central trigger.

This flag is true if the particular RoI that detected this muon candidate also detected another candidate with lower pT.

Definition at line 174 of file MuonRoI_v1.cxx.

174 {
175 if (isRun4()) {
176 return false; // TBI
177 } else if (isRun3()) {
178 if (getSource() == Barrel) return ( ( roiWord() >> RUN3_ROI_OVERFLOW_SHIFT ) & ROI_OVERFLOW_MASK );
179 else return false; // Endcap + Fwd have no flag for this
180 } else {
181 return ( ( roiWord() >> ROI_OVERFLOW_SHIFT ) & ROI_OVERFLOW_MASK );
182 }
183 }
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 ROI_OVERFLOW_SHIFT
Definition MuCTPI_Bits.h:34
static constexpr uint32_t RUN3_ROI_OVERFLOW_SHIFT
Position of the RoI overflow mask.
Definition MuCTPI_Bits.h:33

◆ isMoreCandInSector()

bool xAOD::MuonRoI_v1::isMoreCandInSector ( ) const

Returns if there were other muons detected in the same sector.

This flag is set to true if the sector that this muon candidate came from, detected more than 2 LVL1 muon candidates.

See also
MuonRoI_v1::isFirstCandidate()

Definition at line 190 of file MuonRoI_v1.cxx.

190 {
191 if (isRun4()) return false; // TBI
192 else if (isRun3()) return ( ( roiWord() >> RUN3_CAND_OVERFLOW_SHIFT ) & CAND_OVERFLOW_MASK );
193 else return ( ( roiWord() >> CAND_OVERFLOW_SHIFT ) & CAND_OVERFLOW_MASK );
194 }
static constexpr uint32_t CAND_OVERFLOW_SHIFT
Definition MuCTPI_Bits.h:28
static constexpr uint32_t RUN3_CAND_OVERFLOW_SHIFT
Position of the candidate overflow mask.
Definition MuCTPI_Bits.h:27
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

◆ isRun3()

bool xAOD::MuonRoI_v1::isRun3 ( ) const

Returns extra flag at end of RoI word indicating that it's in Run3 format.

An extra bit is added at the end of the RoI word for run3 candidates in the EDM for technical purposes to distinguish whether we want to use the run2 or run3 bitmasks in decoding the word.

Definition at line 328 of file MuonRoI_v1.cxx.

328 {
329 return isRun4() ? false : (roiWord() >> 31 & 0x1);
330 }

◆ isRun4()

bool xAOD::MuonRoI_v1::isRun4 ( ) const

flag whether it is Run4+ RoI definition

The indicator whether the RoI is Run-1/2/3 or Run-4+ format.

roiExtraWord exists only in Run-4+.

Definition at line 349 of file MuonRoI_v1.cxx.

349 {
350 static const Accessor<uint32_t> acc{"roiExtraWord"};
351 if (!acc.isAvailable(*this)) {
352 return false;
353 } else {
354 return (roiExtraWord() > 0);
355 }
356 }
static const SG::AuxElement::Accessor< ElementLink< IParticleContainer > > acc("originalObjectLink")
Object used for setting/getting the dynamic decoration in question.

◆ isVetoed()

bool xAOD::MuonRoI_v1::isVetoed ( ) const

Returns the veto flag for the candidate.

When the overlap handling is activated in the MuCTPI, candidates can be ignored in the multiplicity sum sent to the CTP.

This flag tells you whether this particular candidate was ignored in the multiplicity sum.

Definition at line 319 of file MuonRoI_v1.cxx.

319 {
320 if (isRun4()) return false; // TBI
321 if (isRun3()) return ( ( roiWord() >> RUN3_CAND_VETO_SHIFT) & 0x1 );
322 else return ( ( roiWord() >> CAND_VETO_SHIFT) & 0x1 );
323 }
static constexpr uint32_t RUN3_CAND_VETO_SHIFT
Position of the bit specifying if a candidate was vetoed in the multiplicity sum.
static constexpr uint32_t CAND_VETO_SHIFT

◆ phi()

float xAOD::MuonRoI_v1::phi ( ) const

The azimuthal angle ( \(\phi\)) of the muon candidate.

◆ pt()

float xAOD::MuonRoI_v1::pt ( ) const

the transverse momentum of the muon candidate

the transverse momentum of the muon candidate, which can be calculated from roiWord valid for Run-4+ only

Definition at line 342 of file MuonRoI_v1.cxx.

342 {
343 if (isRun4()) return static_cast<float>((roiWord() >> PT_SHIFT) & PT_MASK) * PT_WIDTH;
344 else return 0.;
345 }
static constexpr uint32_t PT_SHIFT
Definition MuonRoI_v1.h:156
static constexpr uint32_t PT_MASK
Definition MuonRoI_v1.h:149
static constexpr float PT_WIDTH
Definition MuonRoI_v1.h:160

◆ roiExtraWord()

uint32_t xAOD::MuonRoI_v1::roiExtraWord ( ) const

The second "raw" RoI word describing extra information of the muon candidate.

◆ roiWord()

uint32_t xAOD::MuonRoI_v1::roiWord ( ) const

The "raw" RoI word describing the muon candidate.

◆ setEta()

void xAOD::MuonRoI_v1::setEta ( float v)

Set the pseudorapidity of the muon candidate.

◆ setPhi()

void xAOD::MuonRoI_v1::setPhi ( float v)

Set the azimuthal angle of the muon candidate.

◆ setRoIExtraWord()

void xAOD::MuonRoI_v1::setRoIExtraWord ( uint32_t value)

Set the second "raw" RoI word, describing extra information of the muon candidate.

◆ setRoIWord()

void xAOD::MuonRoI_v1::setRoIWord ( uint32_t value)

Set the "raw" RoI word, describing the muon candidate.

◆ setThrName()

void xAOD::MuonRoI_v1::setThrName ( const std::string & value)

Set the name of the threshold passed by the muon candidate.

◆ setThrValue()

void xAOD::MuonRoI_v1::setThrValue ( float v)

Set the threshold value passed by the muon candidate.

◆ thrName()

const std::string & xAOD::MuonRoI_v1::thrName ( ) const

The name of the highest threshold value passed by the muon candidate.

◆ thrValue()

float xAOD::MuonRoI_v1::thrValue ( ) const

The highest threshold value (in MeV) passed by the muon candidate.

Member Data Documentation

◆ CHARGE_SHIFT

uint32_t xAOD::MuonRoI_v1::CHARGE_SHIFT = 23
staticconstexprprivate

Definition at line 155 of file MuonRoI_v1.h.

◆ ETA_MASK

uint32_t xAOD::MuonRoI_v1::ETA_MASK = 0x3fff
staticconstexpr

constants to decode RoI word for Run 4+

Definition at line 147 of file MuonRoI_v1.h.

◆ ETA_SHIFT

uint32_t xAOD::MuonRoI_v1::ETA_SHIFT = 0
staticconstexprprivate

Definition at line 153 of file MuonRoI_v1.h.

◆ PHI_MASK

uint32_t xAOD::MuonRoI_v1::PHI_MASK = 0x1ff
staticconstexpr

Definition at line 148 of file MuonRoI_v1.h.

◆ PHI_SHIFT

uint32_t xAOD::MuonRoI_v1::PHI_SHIFT = 14
staticconstexprprivate

Definition at line 154 of file MuonRoI_v1.h.

◆ PT_MASK

uint32_t xAOD::MuonRoI_v1::PT_MASK = 0xff
staticconstexpr

Definition at line 149 of file MuonRoI_v1.h.

◆ PT_SHIFT

uint32_t xAOD::MuonRoI_v1::PT_SHIFT = 24
staticconstexprprivate

Definition at line 156 of file MuonRoI_v1.h.

◆ PT_WIDTH

float xAOD::MuonRoI_v1::PT_WIDTH = 0.5
staticconstexprprivate

Definition at line 160 of file MuonRoI_v1.h.

◆ THR_MASK

uint32_t xAOD::MuonRoI_v1::THR_MASK = 0xf
staticconstexpr

Definition at line 150 of file MuonRoI_v1.h.

◆ THR_SHIFT

uint32_t xAOD::MuonRoI_v1::THR_SHIFT = 0
staticconstexprprivate

Definition at line 158 of file MuonRoI_v1.h.


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