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

#include <SectorLogicCandData_v1.h>

Inheritance diagram for xAOD::SectorLogicCandData_v1:
Collaboration diagram for xAOD::SectorLogicCandData_v1:

Public Types

enum  MuonSystem { RPC , TGC }
 Identifies the muon detector system. More...
enum  Side { A , C }
 Detector side (A or C). More...
enum  MSP { MSP_0 , MSP_1 }

Public Member Functions

 SectorLogicCandData_v1 ()
 Default constructor.
void initialize (const std::vector< uint32_t > &data, int offset, uint16_t bID, uint16_t fID)
 Initialise the object given some input data.
const std::string dump () const
 Get the information stored in the SectorLogicCandData_v1 object.
uint32_t candWord () const
 Retrieve the candidate word (first 32-bits).
void setCandWord (uint32_t word)
 Set the candidate word (first 32-bits).
uint32_t candExtraWord () const
 Retrieve the candidate extra word (second 32-bits).
void setCandExtraWord (uint32_t word)
 Set the candidate extra word (second 32-bits).
uint16_t boardID () const
 Retrieve the board ID.
void setBoardID (uint16_t id)
 Set the board ID.
uint16_t fiberID () const
 Retrieve the fiber ID.
void setFiberID (uint16_t id)
 Set the fiber ID.
int BCIDOffset () const
 Retrieve the bunch crossing identifier offset.
void setBCIDOffset (int offset)
 Set the bunch crossing identifier offset.
unsigned short veto () const
 Retrieve the veto flag.
void setVeto (unsigned short veto)
 Set the veto flag.
uint32_t pT () const
 Retrieve the pT value.
uint32_t charge () const
 Retrieve the charge.
uint32_t rawPhi () const
 Retrieve the bits for the position in phi.
float phi () const
 Retrieve the position in phi.
uint32_t rawEta () const
 Retrieve the bits for the position in eta.
float eta () const
 Retrieve the position in eta.
uint32_t mdtSegQual () const
 Retrieve the MDT segment quality flag.
uint32_t numMDTSeg () const
 Retrieve the number of MDT segments.
uint32_t mdtFlag () const
 Retrieve the MDT flag.
uint32_t exotTrig () const
 Retrieve the exotic trigger.
uint32_t tileCoin () const
 Retrieve the TILE coincidence presence.
uint32_t coinType () const
 Retrieve the RPC/TGC coincidence type.
uint32_t isMDT () const
 Retrieve whether the candidate was processed by MDTTP.
uint32_t TCID () const
 Retrieve the Trigger candidate ID.
uint32_t ptThresh () const
 Retrieve the Trigger candidate ID.

Static Private Attributes

static constexpr float ETA_MIN = -2.7f
static constexpr float ETA_MAX = 2.7f
static constexpr float ETA_MAX_RAW = 16383.0f
static constexpr float PHI_MAX = 2.0f * M_PI
static constexpr float PHI_MAX_RAW = 511.0f

Detailed Description

Definition at line 19 of file SectorLogicCandData_v1.h.

Member Enumeration Documentation

◆ MSP

◆ MuonSystem

Identifies the muon detector system.

Enumerator
RPC 
TGC 

Definition at line 27 of file SectorLogicCandData_v1.h.

◆ Side

Constructor & Destructor Documentation

◆ SectorLogicCandData_v1()

xAOD::SectorLogicCandData_v1::SectorLogicCandData_v1 ( )

Default constructor.

Definition at line 22 of file SectorLogicCandData_v1.cxx.

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

Member Function Documentation

◆ BCIDOffset()

int xAOD::SectorLogicCandData_v1::BCIDOffset ( ) const

Retrieve the bunch crossing identifier offset.

Returns
Bunch crossing identifier offset

◆ boardID()

uint16_t xAOD::SectorLogicCandData_v1::boardID ( ) const

Retrieve the board ID.

Returns
Board ID

◆ candExtraWord()

uint32_t xAOD::SectorLogicCandData_v1::candExtraWord ( ) const

Retrieve the candidate extra word (second 32-bits).

Returns
Candidate extra word

◆ candWord()

uint32_t xAOD::SectorLogicCandData_v1::candWord ( ) const

Retrieve the candidate word (first 32-bits).

Returns
Candidate word

◆ charge()

uint32_t xAOD::SectorLogicCandData_v1::charge ( ) const

Retrieve the charge.

Returns
The charge

Definition at line 94 of file SectorLogicCandData_v1.cxx.

94 {
96 }
uint32_t candWord() const
Retrieve the candidate word (first 32-bits).
static constexpr uint32_t RUN4_SL2MUCTPI_CHARGE_MASK
static constexpr uint32_t RUN4_SL2MUCTPI_CHARGE_SHIFT

◆ coinType()

uint32_t xAOD::SectorLogicCandData_v1::coinType ( ) const

Retrieve the RPC/TGC coincidence type.

Returns
The RPC/TGC coincidence type

Definition at line 134 of file SectorLogicCandData_v1.cxx.

134 {
136 }
uint32_t candExtraWord() const
Retrieve the candidate extra word (second 32-bits).
static constexpr uint32_t RUN4_SL2MUCTPI_COINTYPE_MASK
static constexpr uint32_t RUN4_SL2MUCTPI_COINTYPE_SHIFT

◆ dump()

const std::string xAOD::SectorLogicCandData_v1::dump ( ) const

Get the information stored in the SectorLogicCandData_v1 object.

Returns
String holding all the object's information.

Definition at line 46 of file SectorLogicCandData_v1.cxx.

46 {
47 std::ostringstream s;
48 s << "\n*BEGIN* xAOD::SectorLogicCandData" << std::endl;
49 s << " Trigger Candidate ID: " << TCID() << std::endl;
50 s << " Veto: " << veto() << std::endl;
51 s << " Board ID: " << boardID() << std::endl;
52 s << " Fiber ID: " << fiberID() << std::endl;
53 s << " BCID offset: " << BCIDOffset() << std::endl;
54 s << " Position in phi: " << phi() << std::endl;
55 s << " Position in eta: " << eta() << std::endl;
56 s << " pT value: " << pT() << std::endl;
57 s << " pT threshold: " << ptThresh() << std::endl;
58 s << " Charge: " << (charge() ? "Positive" : "Negative") << std::endl;
59 s << " MDT processing flag [0:15]: " << mdtFlag() << std::endl;
60 s << " Processed by MDT or RPC/TGC: " << (isMDT() ? "RPC/TGC" : "MDT") << std::endl;
61 s << " MDT segment quality: " << mdtSegQual() << std::endl;
62 s << " Number of associated MDT segments: " << numMDTSeg() << std::endl;
63 s << " Exotic trigger: " << exotTrig() << std::endl;
64 s << " Presence of TILE Coincidence: " << (tileCoin() ? "Yes" : "No") << std::endl;
65 s << " RPC/TGC coincidence type: " << coinType() << std::endl;
66 s << "*END* xAOD::SectorLogicCandData" << std::endl;
67 return s.str();
68 }
uint32_t charge() const
Retrieve the charge.
uint16_t fiberID() const
Retrieve the fiber ID.
unsigned short veto() const
Retrieve the veto flag.
uint32_t exotTrig() const
Retrieve the exotic trigger.
uint32_t ptThresh() const
Retrieve the Trigger candidate ID.
uint32_t mdtSegQual() const
Retrieve the MDT segment quality flag.
uint32_t coinType() const
Retrieve the RPC/TGC coincidence type.
float phi() const
Retrieve the position in phi.
float eta() const
Retrieve the position in eta.
uint32_t pT() const
Retrieve the pT value.
int BCIDOffset() const
Retrieve the bunch crossing identifier offset.
uint16_t boardID() const
Retrieve the board ID.
uint32_t isMDT() const
Retrieve whether the candidate was processed by MDTTP.
uint32_t TCID() const
Retrieve the Trigger candidate ID.
uint32_t numMDTSeg() const
Retrieve the number of MDT segments.
uint32_t tileCoin() const
Retrieve the TILE coincidence presence.
uint32_t mdtFlag() const
Retrieve the MDT flag.

◆ eta()

float xAOD::SectorLogicCandData_v1::eta ( ) const

Retrieve the position in eta.

Returns
The position in eta

Definition at line 114 of file SectorLogicCandData_v1.cxx.

114 {
115 return ETA_MIN + (static_cast<float>(rawEta()) / ETA_MAX_RAW) * (ETA_MAX - ETA_MIN);
116 }
uint32_t rawEta() const
Retrieve the bits for the position in eta.

◆ exotTrig()

uint32_t xAOD::SectorLogicCandData_v1::exotTrig ( ) const

Retrieve the exotic trigger.

Returns
The exotic trigger

Definition at line 144 of file SectorLogicCandData_v1.cxx.

144 {
146 }
static constexpr uint32_t RUN4_SL2MUCTPI_ET_MASK
static constexpr uint32_t RUN4_SL2MUCTPI_ET_SHIFT

◆ fiberID()

uint16_t xAOD::SectorLogicCandData_v1::fiberID ( ) const

Retrieve the fiber ID.

Returns
Fiber ID

◆ initialize()

void xAOD::SectorLogicCandData_v1::initialize ( const std::vector< uint32_t > & data,
int offset,
uint16_t bID,
uint16_t fID )

Initialise the object given some input data.

Parameters
dataInput data
offsetBCID offset to know which timeslice the candidate is associated to
bIDBoard ID
fIDFiber ID

Definition at line 27 of file SectorLogicCandData_v1.cxx.

27 {
28
29 // Check input format
30 if (data.size() != 2) {
31 setCandWord(0);
33 } else {
34 setCandWord(data[0]);
36 }
37 setBoardID(bID); // Set the board ID to provide information of where the candidate originates (i.e. what SL board)
38 setFiberID(fID); // Set the fiber ID to provide information of what link the candidate arrives on
39 setVeto(0); // Always initialise candidate with no veto -> veto comes from overlap handling
40 setBCIDOffset(offset); // Set the BCID offset, i.e. which timeslice it is associated to
41
42 }
char data[hepevt_bytes_allocation_ATLAS]
Definition HepEvt.cxx:11
void setBCIDOffset(int offset)
Set the bunch crossing identifier offset.
void setCandExtraWord(uint32_t word)
Set the candidate extra word (second 32-bits).
void setCandWord(uint32_t word)
Set the candidate word (first 32-bits).
void setFiberID(uint16_t id)
Set the fiber ID.
void setBoardID(uint16_t id)
Set the board ID.
void setVeto(unsigned short veto)
Set the veto flag.

◆ isMDT()

uint32_t xAOD::SectorLogicCandData_v1::isMDT ( ) const

Retrieve whether the candidate was processed by MDTTP.

Returns
Whether the candidate was processed by MDTTP.

Definition at line 129 of file SectorLogicCandData_v1.cxx.

129 {
131 }
static constexpr uint32_t RUN4_SL2MUCTPI_MDT_SHIFT
static constexpr uint32_t RUN4_SL2MUCTPI_MDT_MASK

◆ mdtFlag()

uint32_t xAOD::SectorLogicCandData_v1::mdtFlag ( ) const

Retrieve the MDT flag.

Returns
The MDT flag

Definition at line 149 of file SectorLogicCandData_v1.cxx.

149 {
151 }
static constexpr uint32_t RUN4_SL2MUCTPI_MDTFLAG_MASK
static constexpr uint32_t RUN4_SL2MUCTPI_MDTFLAG_SHIFT

◆ mdtSegQual()

uint32_t xAOD::SectorLogicCandData_v1::mdtSegQual ( ) const

Retrieve the MDT segment quality flag.

Returns
The MDT segment quality flag

Definition at line 159 of file SectorLogicCandData_v1.cxx.

159 {
161 }
static constexpr uint32_t RUN4_SL2MUCTPI_SEGQUAL_SHIFT
static constexpr uint32_t RUN4_SL2MUCTPI_SEGQUAL_MASK

◆ numMDTSeg()

uint32_t xAOD::SectorLogicCandData_v1::numMDTSeg ( ) const

Retrieve the number of MDT segments.

Returns
The number of MDT segments

Definition at line 154 of file SectorLogicCandData_v1.cxx.

154 {
156 }
static constexpr uint32_t RUN4_SL2MUCTPI_SEGNUM_MASK
static constexpr uint32_t RUN4_SL2MUCTPI_SEGNUM_SHIFT

◆ phi()

float xAOD::SectorLogicCandData_v1::phi ( ) const

Retrieve the position in phi.

Returns
The position in phi

Definition at line 104 of file SectorLogicCandData_v1.cxx.

104 {
105 return (static_cast<float>(rawPhi()) / PHI_MAX_RAW) * PHI_MAX;
106 }
uint32_t rawPhi() const
Retrieve the bits for the position in phi.

◆ pT()

uint32_t xAOD::SectorLogicCandData_v1::pT ( ) const

Retrieve the pT value.

Returns
The pT value

Definition at line 89 of file SectorLogicCandData_v1.cxx.

89 {
91 }
static constexpr uint32_t RUN4_SL2MUCTPI_PT_VAL_SHIFT
static constexpr uint32_t RUN4_SL2MUCTPI_PT_VAL_MASK

◆ ptThresh()

uint32_t xAOD::SectorLogicCandData_v1::ptThresh ( ) const

Retrieve the Trigger candidate ID.

Returns
The Trigger candidate ID

Definition at line 119 of file SectorLogicCandData_v1.cxx.

119 {
121 }
static constexpr uint32_t RUN4_SL2MUCTPI_PTTHRESHOLD_SHIFT
static constexpr uint32_t RUN4_SL2MUCTPI_PTTHRESHOLD_MASK

◆ rawEta()

uint32_t xAOD::SectorLogicCandData_v1::rawEta ( ) const

Retrieve the bits for the position in eta.

Returns
The bits for the position in eta

Definition at line 109 of file SectorLogicCandData_v1.cxx.

109 {
111 }
static constexpr uint32_t RUN4_SL2MUCTPI_ETA_MASK
static constexpr uint32_t RUN4_SL2MUCTPI_ETA_SHIFT

◆ rawPhi()

uint32_t xAOD::SectorLogicCandData_v1::rawPhi ( ) const

Retrieve the bits for the position in phi.

Returns
The bits for the position in phi

Definition at line 99 of file SectorLogicCandData_v1.cxx.

99 {
101 }
static constexpr uint32_t RUN4_SL2MUCTPI_PHI_MASK
static constexpr uint32_t RUN4_SL2MUCTPI_PHI_SHIFT

◆ setBCIDOffset()

void xAOD::SectorLogicCandData_v1::setBCIDOffset ( int offset)

Set the bunch crossing identifier offset.

Parameters
offsetBunch crossing identifier offset to set

◆ setBoardID()

void xAOD::SectorLogicCandData_v1::setBoardID ( uint16_t id)

Set the board ID.

Parameters
idBoard ID to set

◆ setCandExtraWord()

void xAOD::SectorLogicCandData_v1::setCandExtraWord ( uint32_t word)

Set the candidate extra word (second 32-bits).

Parameters
wordCandidate extra word to set

◆ setCandWord()

void xAOD::SectorLogicCandData_v1::setCandWord ( uint32_t word)

Set the candidate word (first 32-bits).

Parameters
wordCandidate word to set

◆ setFiberID()

void xAOD::SectorLogicCandData_v1::setFiberID ( uint16_t id)

Set the fiber ID.

Parameters
idFiber ID to set

◆ setVeto()

void xAOD::SectorLogicCandData_v1::setVeto ( unsigned short veto)

Set the veto flag.

Parameters
vetoVeto flag to set

◆ TCID()

uint32_t xAOD::SectorLogicCandData_v1::TCID ( ) const

Retrieve the Trigger candidate ID.

Returns
The Trigger candidate ID

Definition at line 124 of file SectorLogicCandData_v1.cxx.

124 {
126 }
static constexpr uint32_t RUN4_SL2MUCTPI_TCID_SHIFT
static constexpr uint32_t RUN4_SL2MUCTPI_TCID_MASK

◆ tileCoin()

uint32_t xAOD::SectorLogicCandData_v1::tileCoin ( ) const

Retrieve the TILE coincidence presence.

Returns
The TILE coincidence presence

Definition at line 139 of file SectorLogicCandData_v1.cxx.

139 {
141 }
static constexpr uint32_t RUN4_SL2MUCTPI_TC_SHIFT
static constexpr uint32_t RUN4_SL2MUCTPI_TC_MASK

◆ veto()

unsigned short xAOD::SectorLogicCandData_v1::veto ( ) const

Retrieve the veto flag.

Returns
Veto flag

Member Data Documentation

◆ ETA_MAX

float xAOD::SectorLogicCandData_v1::ETA_MAX = 2.7f
staticconstexprprivate

Definition at line 227 of file SectorLogicCandData_v1.h.

◆ ETA_MAX_RAW

float xAOD::SectorLogicCandData_v1::ETA_MAX_RAW = 16383.0f
staticconstexprprivate

Definition at line 228 of file SectorLogicCandData_v1.h.

◆ ETA_MIN

float xAOD::SectorLogicCandData_v1::ETA_MIN = -2.7f
staticconstexprprivate

Definition at line 226 of file SectorLogicCandData_v1.h.

◆ PHI_MAX

float xAOD::SectorLogicCandData_v1::PHI_MAX = 2.0f * M_PI
staticconstexprprivate

Definition at line 229 of file SectorLogicCandData_v1.h.

◆ PHI_MAX_RAW

float xAOD::SectorLogicCandData_v1::PHI_MAX_RAW = 511.0f
staticconstexprprivate

Definition at line 230 of file SectorLogicCandData_v1.h.


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