base class providing a common interface with shared variables for the L0 muon candidates from RPC/TGC SL to MDT-TP More...

#include <IL1CandData_v1.h>

Inheritance diagram for xAOD::IL1CandData_v1:

Collaboration diagram for xAOD::IL1CandData_v1:

Public Types
enum class	BC_ID { BC_UNDEFINED = 0 , BC_PREVIOUS , BC_CURRENT , BC_NEXT , BC_NEXTNEXT }
	Bunch crossing identifier. More...

Public Member Functions
	IL1CandData_v1 ()=default
	Default constructor.
virtual	~IL1CandData_v1 ()=default
uint16_t	l1SubdetectorId () const
	Retrieve the sub detector id.
uint16_t	l1SectorId () const
	Retrieve the sector id.
uint16_t	bcTag () const
	Retrieve the bunch crossing tag.
uint8_t	l1Threshold () const
	Retrieve the threshold.
uint8_t	l1CandCharge () const
	Retrieve the candidate charge.
uint8_t	coinType () const
	Retrieve the coincidence type.
uint16_t	l1Eta () const
	Retrieve the eta.
uint16_t	l1Phi () const
	Retrieve the phi.
uint8_t	l1Pt () const
	Retrieve the encoded candidate pT.
uint8_t	tcId () const
	Retrieve the trigger-candidate identifier.
void	setL1SubdetectorId (uint16_t subdetectorId)
	Set the sub detector id.
void	setL1SectorId (uint16_t sectorId)
	Set the sector id.
void	setBcTag (uint16_t bcTag)
	Set the bunch crossing tag.
void	setL1Eta (float eta)
	Set the eta.
void	setL1Phi (float phi)
	Set the phi.
void	setL1Pt (float pt)
	Set the candidate pT.
void	setL1Threshold (uint8_t threshold)
	Set the threshold.
void	setL1CandCharge (uint8_t candCharge)
	Set the candidate charge.
void	setCoinType (uint8_t coinType)
	Set the coincidence type.
void	setTcId (uint8_t value)
	Set the trigger-candidate identifier.
void	initialize (uint16_t subdetectorId, uint16_t sectorId, uint16_t bcTag)
	Initialize candidate with basic properties.

Static Public Member Functions
static constexpr float	etaRange ()
static constexpr uint16_t	etaBitRange ()
static constexpr float	phiRange ()
static constexpr uint16_t	phiBitRange ()
static constexpr float	ptResolution ()
static constexpr float	ptRange ()
static constexpr uint8_t	ptBitRange ()
static constexpr uint8_t	coinTypeBitMask ()
static constexpr uint8_t	tcIdBitMask ()

Static Protected Attributes
static constexpr float	s_etaRange = 2.7
	Variables range.
static constexpr float	s_phiRange = 2.0 * M_PI
static constexpr float	s_ptResolution = 0.5F
	GeV per pT code.
static constexpr uint16_t	s_etaBitRange = 0x3fff
	Variables bit size 14 bits for eta, 9 bits for phi, 8 bits for pt.
static constexpr uint16_t	s_phiBitRange = 0x1ff
static constexpr uint8_t	s_ptBitRange = 0xff
static constexpr float	s_ptRange
static constexpr uint8_t	COINTYPE_BIT_MASK = 0x7
	Bit mask for Coincidence Types.
static constexpr uint8_t	TC_ID_BIT_MASK = 0x7
	Bit mask for the trigger-candidate identifier.

Detailed Description

base class providing a common interface with shared variables for the L0 muon candidates from RPC/TGC SL to MDT-TP

Definition at line 17 of file IL1CandData_v1.h.

Member Enumeration Documentation

◆ BC_ID

enum class xAOD::IL1CandData_v1::BC_ID

strong

Bunch crossing identifier.

Enumerator
BC_UNDEFINED
BC_PREVIOUS
BC_CURRENT
BC_NEXT
BC_NEXTNEXT

Definition at line 26 of file IL1CandData_v1.h.

    {
      BC_UNDEFINED = 0,
      BC_PREVIOUS,
      BC_CURRENT,
      BC_NEXT,
      BC_NEXTNEXT
    };

Constructor & Destructor Documentation

◆ IL1CandData_v1()

xAOD::IL1CandData_v1::IL1CandData_v1 ( )

default

Default constructor.

◆ ~IL1CandData_v1()

virtual xAOD::IL1CandData_v1::~IL1CandData_v1 ( )

virtualdefault

Member Function Documentation

◆ bcTag()

uint16_t xAOD::IL1CandData_v1::bcTag ( ) const

Retrieve the bunch crossing tag.

Returns: Bunch crossing tag

◆ coinType()

uint8_t xAOD::IL1CandData_v1::coinType ( ) const

Retrieve the coincidence type.

Returns: Coincidence type

Definition at line 60 of file IL1CandData_v1.cxx.

                                           {
        static const SG::Accessor<uint8_t> acc("coinType");
        return  acc(*this);
    }

◆ coinTypeBitMask()

constexpr uint8_t xAOD::IL1CandData_v1::coinTypeBitMask ( )

inlinestaticconstexpr

Definition at line 156 of file IL1CandData_v1.h.

156{ return COINTYPE_BIT_MASK; }

xAOD::IL1CandData_v1::COINTYPE_BIT_MASK

static constexpr uint8_t COINTYPE_BIT_MASK

Bit mask for Coincidence Types.

Definition IL1CandData_v1.h:174

◆ etaBitRange()

constexpr uint16_t xAOD::IL1CandData_v1::etaBitRange ( )

inlinestaticconstexpr

Definition at line 150 of file IL1CandData_v1.h.

150{ return s_etaBitRange; }

xAOD::IL1CandData_v1::s_etaBitRange

static constexpr uint16_t s_etaBitRange

Variables bit size 14 bits for eta, 9 bits for phi, 8 bits for pt.

Definition IL1CandData_v1.h:167

◆ etaRange()

constexpr float xAOD::IL1CandData_v1::etaRange ( )

inlinestaticconstexpr

Definition at line 149 of file IL1CandData_v1.h.

149{ return s_etaRange; }

xAOD::IL1CandData_v1::s_etaRange

static constexpr float s_etaRange

Variables range.

Definition IL1CandData_v1.h:161

◆ initialize()

void xAOD::IL1CandData_v1::initialize	(	uint16_t	subdetectorId,
		uint16_t	sectorId,
		uint16_t	bcTag )

Initialize candidate with basic properties.

Initialise the object given some input data

Parameters

subdetectorId	Subdetector ID
sectorId	Sector ID
bcTag	Bunch crossing tag

Definition at line 75 of file IL1CandData_v1.cxx.

                                                                                             {
      setL1SubdetectorId(subdetectorId);
      setL1SectorId(sectorId);
      setBcTag(bcTag);
  }

◆ l1CandCharge()

uint8_t xAOD::IL1CandData_v1::l1CandCharge ( ) const

Retrieve the candidate charge.

Returns: Candidate charge

◆ l1Eta()

uint16_t xAOD::IL1CandData_v1::l1Eta ( ) const

Retrieve the eta.

Returns: Eta

Definition at line 24 of file IL1CandData_v1.cxx.

                                         {
        static const SG::Accessor<uint16_t> acc("l1Eta");
        return  acc(*this);
    }

◆ l1Phi()

uint16_t xAOD::IL1CandData_v1::l1Phi ( ) const

Retrieve the phi.

Returns: Phi

Definition at line 35 of file IL1CandData_v1.cxx.

                                        {
        static const SG::Accessor<uint16_t> acc("l1Phi");
        //return (static_cast<float>(acc(*this)) / static_cast<float>(s_phiBitRange)) * s_phiRange-M_PI;
        return  acc(*this);
    }

◆ l1Pt()

uint8_t xAOD::IL1CandData_v1::l1Pt ( ) const

Retrieve the encoded candidate pT.

Returns: Eight-bit pT code in 0.5 GeV steps; zero denotes an invalid pT estimate

Definition at line 49 of file IL1CandData_v1.cxx.

                                      {
        static const SG::Accessor<uint8_t> acc("l1Pt");
        return  acc(*this);
    }

◆ l1SectorId()

uint16_t xAOD::IL1CandData_v1::l1SectorId ( ) const

Retrieve the sector id.

Returns: Sector ID

◆ l1SubdetectorId()

uint16_t xAOD::IL1CandData_v1::l1SubdetectorId ( ) const

Retrieve the sub detector id.

Returns: Subdetector ID

◆ l1Threshold()

uint8_t xAOD::IL1CandData_v1::l1Threshold ( ) const

Retrieve the threshold.

Returns: Threshold

◆ phiBitRange()

constexpr uint16_t xAOD::IL1CandData_v1::phiBitRange ( )

inlinestaticconstexpr

Definition at line 152 of file IL1CandData_v1.h.

152{ return s_phiBitRange; }

xAOD::IL1CandData_v1::s_phiBitRange

static constexpr uint16_t s_phiBitRange

Definition IL1CandData_v1.h:168

◆ phiRange()

constexpr float xAOD::IL1CandData_v1::phiRange ( )

inlinestaticconstexpr

Definition at line 151 of file IL1CandData_v1.h.

151{ return s_phiRange; }

xAOD::IL1CandData_v1::s_phiRange

static constexpr float s_phiRange

Definition IL1CandData_v1.h:162

◆ ptBitRange()

constexpr uint8_t xAOD::IL1CandData_v1::ptBitRange ( )

inlinestaticconstexpr

Definition at line 155 of file IL1CandData_v1.h.

155{ return s_ptBitRange; }

xAOD::IL1CandData_v1::s_ptBitRange

static constexpr uint8_t s_ptBitRange

Definition IL1CandData_v1.h:169

◆ ptRange()

constexpr float xAOD::IL1CandData_v1::ptRange ( )

inlinestaticconstexpr

Definition at line 154 of file IL1CandData_v1.h.

154{ return s_ptRange; }

xAOD::IL1CandData_v1::s_ptRange

static constexpr float s_ptRange

Definition IL1CandData_v1.h:170

◆ ptResolution()

constexpr float xAOD::IL1CandData_v1::ptResolution ( )

inlinestaticconstexpr

Definition at line 153 of file IL1CandData_v1.h.

153{ return s_ptResolution; }

xAOD::IL1CandData_v1::s_ptResolution

static constexpr float s_ptResolution

GeV per pT code.

Definition IL1CandData_v1.h:163

◆ setBcTag()

void xAOD::IL1CandData_v1::setBcTag ( uint16_t bcTag )

Set the bunch crossing tag.

Parameters

bcTag Bunch crossing tag

◆ setCoinType()

void xAOD::IL1CandData_v1::setCoinType ( uint8_t coinType )

Set the coincidence type.

Parameters

coinType Coincidence type

Definition at line 54 of file IL1CandData_v1.cxx.

                                                     {
        uint8_t coinTypeBin = cointype & COINTYPE_BIT_MASK;
        static const SG::Accessor<uint8_t> acc("coinType");
        acc(*this) = coinTypeBin;
    }

◆ setL1CandCharge()

void xAOD::IL1CandData_v1::setL1CandCharge ( uint8_t candCharge )

Set the candidate charge.

Parameters

candCharge Candidate charge

◆ setL1Eta()

void xAOD::IL1CandData_v1::setL1Eta ( float eta )

Set the eta.

Parameters

eta Eta

Definition at line 17 of file IL1CandData_v1.cxx.

                                           {
        float etaClamped = std::clamp(eta, -s_etaRange, s_etaRange);
        uint16_t etaBinary = static_cast<uint16_t>(std::lround((etaClamped + s_etaRange) / (2.0f * s_etaRange) * static_cast<float>(s_etaBitRange)));
        static const SG::Accessor<uint16_t> acc("l1Eta");
        acc(*this) = etaBinary;
    }

◆ setL1Phi()

void xAOD::IL1CandData_v1::setL1Phi ( float phi )

Set the phi.

Parameters

phi Phi

Definition at line 29 of file IL1CandData_v1.cxx.

                                           {
        uint16_t phiBinary = static_cast<uint16_t>(((phi + M_PI) / s_phiRange) * static_cast<float>(s_phiBitRange));
        static const SG::Accessor<uint16_t> acc("l1Phi");
        acc(*this) = phiBinary;
    }

◆ setL1Pt()

void xAOD::IL1CandData_v1::setL1Pt ( float pt )

Set the candidate pT.

Parameters

pt	Candidate pT in GeV, encoded in 0.5 GeV steps

Definition at line 41 of file IL1CandData_v1.cxx.

                                        {
        const float ptClamped = std::clamp(pt, 0.0F, s_ptRange);
        const uint8_t ptBinary = static_cast<uint8_t>(
            std::lround(ptClamped / s_ptResolution));
        static const SG::Accessor<uint8_t> acc("l1Pt");
        acc(*this) = ptBinary;
    }

◆ setL1SectorId()

void xAOD::IL1CandData_v1::setL1SectorId ( uint16_t sectorId )

Set the sector id.

Parameters

sectorId Sector ID

◆ setL1SubdetectorId()

void xAOD::IL1CandData_v1::setL1SubdetectorId ( uint16_t subdetectorId )

Set the sub detector id.

Parameters

subdetectorId Subdetector ID

◆ setL1Threshold()

void xAOD::IL1CandData_v1::setL1Threshold ( uint8_t threshold )

Set the threshold.

Parameters

threshold Threshold

◆ setTcId()

void xAOD::IL1CandData_v1::setTcId ( uint8_t value )

Set the trigger-candidate identifier.

Parameters

value Three-bit trigger-candidate identifier; zero denotes an empty candidate

Definition at line 65 of file IL1CandData_v1.cxx.

                                              {
        static const SG::Accessor<uint8_t> acc("tcId");
        acc(*this) = value & TC_ID_BIT_MASK;
    }

◆ tcId()

uint8_t xAOD::IL1CandData_v1::tcId ( ) const

Retrieve the trigger-candidate identifier.

Returns: Three-bit trigger-candidate identifier; zero denotes an empty candidate

Definition at line 70 of file IL1CandData_v1.cxx.

                                       {
        static const SG::ConstAccessor<uint8_t> acc("tcId");
        return acc(*this) & TC_ID_BIT_MASK;
    }

◆ tcIdBitMask()

constexpr uint8_t xAOD::IL1CandData_v1::tcIdBitMask ( )

inlinestaticconstexpr

Definition at line 157 of file IL1CandData_v1.h.

157{ return TC_ID_BIT_MASK; }

Member Data Documentation

◆ COINTYPE_BIT_MASK

uint8_t xAOD::IL1CandData_v1::COINTYPE_BIT_MASK = 0x7

staticconstexprprotected

Bit mask for Coincidence Types.

Definition at line 174 of file IL1CandData_v1.h.

◆ s_etaBitRange

uint16_t xAOD::IL1CandData_v1::s_etaBitRange = 0x3fff

staticconstexprprotected

Variables bit size 14 bits for eta, 9 bits for phi, 8 bits for pt.

Definition at line 167 of file IL1CandData_v1.h.

◆ s_etaRange

float xAOD::IL1CandData_v1::s_etaRange = 2.7

staticconstexprprotected

Variables range.

Definition at line 161 of file IL1CandData_v1.h.

◆ s_phiBitRange

uint16_t xAOD::IL1CandData_v1::s_phiBitRange = 0x1ff

staticconstexprprotected

Definition at line 168 of file IL1CandData_v1.h.

◆ s_phiRange

float xAOD::IL1CandData_v1::s_phiRange = 2.0 * M_PI

staticconstexprprotected

Definition at line 162 of file IL1CandData_v1.h.

◆ s_ptBitRange

uint8_t xAOD::IL1CandData_v1::s_ptBitRange = 0xff

staticconstexprprotected

Definition at line 169 of file IL1CandData_v1.h.

◆ s_ptRange

float xAOD::IL1CandData_v1::s_ptRange

staticconstexprprotected

Initial value:

=

s_ptResolution * static_cast<float>(s_ptBitRange)

xAOD::ICandData_v1::s_ptResolution

static constexpr float s_ptResolution

GeV per pT code.

Definition ICandData_v1.h:182

xAOD::ICandData_v1::s_ptBitRange

static constexpr uint8_t s_ptBitRange

Definition ICandData_v1.h:188

Definition at line 170 of file IL1CandData_v1.h.

◆ s_ptResolution

float xAOD::IL1CandData_v1::s_ptResolution = 0.5F

staticconstexprprotected

GeV per pT code.

Definition at line 163 of file IL1CandData_v1.h.

◆ TC_ID_BIT_MASK

uint8_t xAOD::IL1CandData_v1::TC_ID_BIT_MASK = 0x7

staticconstexprprotected

Bit mask for the trigger-candidate identifier.

Definition at line 176 of file IL1CandData_v1.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ BC_ID

Constructor & Destructor Documentation

◆ IL1CandData_v1()

◆ ~IL1CandData_v1()

Member Function Documentation

◆ bcTag()

◆ coinType()

◆ coinTypeBitMask()

◆ etaBitRange()

◆ etaRange()

◆ initialize()

◆ l1CandCharge()

◆ l1Eta()

◆ l1Phi()

◆ l1Pt()

◆ l1SectorId()

◆ l1SubdetectorId()

◆ l1Threshold()

◆ phiBitRange()

◆ phiRange()

◆ ptBitRange()

◆ ptRange()

◆ ptResolution()

◆ setBcTag()

◆ setCoinType()

◆ setL1CandCharge()

◆ setL1Eta()

◆ setL1Phi()

◆ setL1Pt()

◆ setL1SectorId()

◆ setL1SubdetectorId()

◆ setL1Threshold()

◆ setTcId()

◆ tcId()

◆ tcIdBitMask()

Member Data Documentation

◆ COINTYPE_BIT_MASK

◆ s_etaBitRange

◆ s_etaRange

◆ s_phiBitRange

◆ s_phiRange

◆ s_ptBitRange

◆ s_ptRange

◆ s_ptResolution

◆ TC_ID_BIT_MASK