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

#include <ICandData_v1.h>

Inheritance diagram for xAOD::ICandData_v1:

Collaboration diagram for xAOD::ICandData_v1:

Public Types
enum class	BC_ID { BC_UNDEFINED = 0 , BC_PREVIOUS , BC_CURRENT , BC_NEXT , BC_NEXTNEXT }
	Bunch crossing identifier. More...
enum class	Quality : uint8_t { Q_UNDEFINED = 0 , Q_BEST , Q_LOW }

Public Member Functions
	ICandData_v1 ()=default
	Default constructor.
virtual	~ICandData_v1 ()=default
uint16_t	subdetectorId () const
	Retrieve the sub detector id.
uint16_t	sectorId () const
	Retrieve the sector id.
uint16_t	bcTag () const
	Retrieve the bunch crossing tag.
uint8_t	threshold () const
	Retrieve the threshold.
uint8_t	candCharge () const
	Retrieve the candidate charge.
uint8_t	mdtFlag () const
	Retrieve the MDT flag.
uint8_t	coinType () const
	Retrieve the coincidence type.
uint16_t	eta () const
	Retrieve the eta.
uint16_t	phi () const
	Retrieve the phi.
uint8_t	pt () const
	Retrieve the pt.
Quality	candQuality () const
	Retrieve the candidate quality.
void	setSubdetectorId (uint16_t subdetectorId)
	Set the sub detector id.
void	setSectorId (uint16_t sectorId)
	Set the sector id.
void	setBcTag (uint16_t bcTag)
	Set the bunch crossing tag.
void	setEta (float eta)
	Set the eta.
void	setPhi (float phi)
	Set the phi.
void	setPt (float pt)
	Set the pt.
void	setThreshold (uint8_t threshold)
	Set the threshold.
void	setCandCharge (uint8_t candCharge)
	Set the candidate charge.
void	setMdtFlag (uint8_t mdtFlag)
	Set the MDT flag.
void	setCoinType (uint8_t coinType)
	Set the coincidence type.
void	setCandQuality (Quality candQuality)
	Set the candidate quality.
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	ptRange ()
static constexpr uint8_t	ptBitRange ()
static constexpr uint8_t	coinTypeBitMask ()

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_ptRange = 1000.0
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 uint8_t	COINTYPE_BIT_MASK = 0x7
	Bit mask for Coincidence Types.

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 18 of file ICandData_v1.h.

Member Enumeration Documentation

◆ BC_ID

enum class xAOD::ICandData_v1::BC_ID

strong

Bunch crossing identifier.

Enumerator
BC_UNDEFINED
BC_PREVIOUS
BC_CURRENT
BC_NEXT
BC_NEXTNEXT

Definition at line 27 of file ICandData_v1.h.

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

◆ Quality

enum class xAOD::ICandData_v1::Quality : uint8_t

strong

Enumerator
Q_UNDEFINED
Q_BEST
Q_LOW

Definition at line 36 of file ICandData_v1.h.

    {
      Q_UNDEFINED = 0,
      Q_BEST,
      Q_LOW
    };

Constructor & Destructor Documentation

◆ ICandData_v1()

xAOD::ICandData_v1::ICandData_v1 ( )

default

Default constructor.

◆ ~ICandData_v1()

virtual xAOD::ICandData_v1::~ICandData_v1 ( )

virtualdefault

Member Function Documentation

◆ bcTag()

uint16_t xAOD::ICandData_v1::bcTag ( ) const

Retrieve the bunch crossing tag.

Returns: Bunch crossing tag

◆ candCharge()

uint8_t xAOD::ICandData_v1::candCharge ( ) const

Retrieve the candidate charge.

Returns: Candidate charge

◆ candQuality()

Quality xAOD::ICandData_v1::candQuality ( ) const

Retrieve the candidate quality.

Returns: Candidate quality

◆ coinType()

uint8_t xAOD::ICandData_v1::coinType ( ) const

Retrieve the coincidence type.

Returns: Coincidence type

Definition at line 69 of file ICandData_v1.cxx.

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

◆ coinTypeBitMask()

constexpr uint8_t xAOD::ICandData_v1::coinTypeBitMask ( )

inlinestaticconstexpr

Definition at line 175 of file ICandData_v1.h.

175{ return COINTYPE_BIT_MASK; }

xAOD::ICandData_v1::COINTYPE_BIT_MASK

static constexpr uint8_t COINTYPE_BIT_MASK

Bit mask for Coincidence Types.

Definition ICandData_v1.h:190

◆ eta()

uint16_t xAOD::ICandData_v1::eta ( ) const

Retrieve the eta.

Returns: Eta

Definition at line 33 of file ICandData_v1.cxx.

                                     {
        static const SG::AuxElement::Accessor<uint16_t> acc(preFixStr + "eta");
        return  acc(*this);
    }

◆ etaBitRange()

constexpr uint16_t xAOD::ICandData_v1::etaBitRange ( )

inlinestaticconstexpr

Definition at line 170 of file ICandData_v1.h.

170{ return s_etaBitRange; }

xAOD::ICandData_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 ICandData_v1.h:185

◆ etaRange()

constexpr float xAOD::ICandData_v1::etaRange ( )

inlinestaticconstexpr

Definition at line 169 of file ICandData_v1.h.

169{ return s_etaRange; }

xAOD::ICandData_v1::s_etaRange

static constexpr float s_etaRange

Variables range.

Definition ICandData_v1.h:179

◆ initialize()

void xAOD::ICandData_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 74 of file ICandData_v1.cxx.

                                                                                           {
      setSubdetectorId(subdetectorId);
      setSectorId(sectorId);
      setBcTag(bcTag);
  }

◆ mdtFlag()

uint8_t xAOD::ICandData_v1::mdtFlag ( ) const

Retrieve the MDT flag.

Returns: MDT flag

◆ phi()

uint16_t xAOD::ICandData_v1::phi ( ) const

Retrieve the phi.

Returns: Phi

Definition at line 44 of file ICandData_v1.cxx.

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

◆ phiBitRange()

constexpr uint16_t xAOD::ICandData_v1::phiBitRange ( )

inlinestaticconstexpr

Definition at line 172 of file ICandData_v1.h.

172{ return s_phiBitRange; }

xAOD::ICandData_v1::s_phiBitRange

static constexpr uint16_t s_phiBitRange

Definition ICandData_v1.h:186

◆ phiRange()

constexpr float xAOD::ICandData_v1::phiRange ( )

inlinestaticconstexpr

Definition at line 171 of file ICandData_v1.h.

171{ return s_phiRange; }

xAOD::ICandData_v1::s_phiRange

static constexpr float s_phiRange

Definition ICandData_v1.h:180

◆ pt()

uint8_t xAOD::ICandData_v1::pt ( ) const

Retrieve the pt.

Returns: Pt

Definition at line 58 of file ICandData_v1.cxx.

                                  {
        static const SG::AuxElement::Accessor<uint8_t> acc(preFixStr + "pt");
        return  acc(*this);
    }

◆ ptBitRange()

constexpr uint8_t xAOD::ICandData_v1::ptBitRange ( )

inlinestaticconstexpr

Definition at line 174 of file ICandData_v1.h.

174{ return s_ptBitRange; }

xAOD::ICandData_v1::s_ptBitRange

static constexpr uint8_t s_ptBitRange

Definition ICandData_v1.h:187

◆ ptRange()

constexpr float xAOD::ICandData_v1::ptRange ( )

inlinestaticconstexpr

Definition at line 173 of file ICandData_v1.h.

173{ return s_ptRange; }

xAOD::ICandData_v1::s_ptRange

static constexpr float s_ptRange

Definition ICandData_v1.h:181

◆ sectorId()

uint16_t xAOD::ICandData_v1::sectorId ( ) const

Retrieve the sector id.

Returns: Sector ID

◆ setBcTag()

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

Set the bunch crossing tag.

Parameters

bcTag Bunch crossing tag

◆ setCandCharge()

void xAOD::ICandData_v1::setCandCharge ( uint8_t candCharge )

Set the candidate charge.

Parameters

candCharge Candidate charge

◆ setCandQuality()

void xAOD::ICandData_v1::setCandQuality ( Quality candQuality )

Set the candidate quality.

Parameters

candQuality Candidate quality

◆ setCoinType()

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

Set the coincidence type.

Parameters

coinType Coincidence type

Definition at line 63 of file ICandData_v1.cxx.

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

◆ setEta()

void xAOD::ICandData_v1::setEta ( float eta )

Set the eta.

Parameters

eta Eta

Definition at line 26 of file ICandData_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::AuxElement::Accessor<uint16_t> acc(preFixStr + "eta");
        acc(*this) = etaBinary;
    }

◆ setMdtFlag()

void xAOD::ICandData_v1::setMdtFlag ( uint8_t mdtFlag )

Set the MDT flag.

Parameters

mdtFlag MDT flag

◆ setPhi()

void xAOD::ICandData_v1::setPhi ( float phi )

Set the phi.

Parameters

phi Phi

Definition at line 38 of file ICandData_v1.cxx.

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

◆ setPt()

void xAOD::ICandData_v1::setPt ( float pt )

Set the pt.

Parameters

pt Pt

Definition at line 50 of file ICandData_v1.cxx.

                                    {
        const float ptClamped = std::clamp(pt, 0.0f, s_ptRange);
        const uint8_t ptBinary = static_cast<uint8_t>(
            std::lround((ptClamped / s_ptRange) * static_cast<float>(s_ptBitRange)));
        static const SG::AuxElement::Accessor<uint8_t> acc(preFixStr + "pt");
        acc(*this) = ptBinary;
    }

◆ setSectorId()

void xAOD::ICandData_v1::setSectorId ( uint16_t sectorId )

Set the sector id.

Parameters

sectorId Sector ID

◆ setSubdetectorId()

void xAOD::ICandData_v1::setSubdetectorId ( uint16_t subdetectorId )

Set the sub detector id.

Parameters

subdetectorId Subdetector ID

◆ setThreshold()

void xAOD::ICandData_v1::setThreshold ( uint8_t threshold )

Set the threshold.

Parameters

threshold

Threshold

◆ subdetectorId()

uint16_t xAOD::ICandData_v1::subdetectorId ( ) const

Retrieve the sub detector id.

Returns: Subdetector ID

◆ threshold()

uint8_t xAOD::ICandData_v1::threshold ( ) const

Retrieve the threshold.

Returns: Threshold

Member Data Documentation

◆ COINTYPE_BIT_MASK

uint8_t xAOD::ICandData_v1::COINTYPE_BIT_MASK = 0x7

staticconstexprprotected

Bit mask for Coincidence Types.

Definition at line 190 of file ICandData_v1.h.

◆ s_etaBitRange

uint16_t xAOD::ICandData_v1::s_etaBitRange = 0x3fff

staticconstexprprotected

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

Definition at line 185 of file ICandData_v1.h.

◆ s_etaRange

float xAOD::ICandData_v1::s_etaRange = 2.7

staticconstexprprotected

Variables range.

Definition at line 179 of file ICandData_v1.h.

◆ s_phiBitRange

uint16_t xAOD::ICandData_v1::s_phiBitRange = 0x1ff

staticconstexprprotected

Definition at line 186 of file ICandData_v1.h.

◆ s_phiRange

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

staticconstexprprotected

Definition at line 180 of file ICandData_v1.h.

◆ s_ptBitRange

uint8_t xAOD::ICandData_v1::s_ptBitRange = 0xff

staticconstexprprotected

Definition at line 187 of file ICandData_v1.h.

◆ s_ptRange

float xAOD::ICandData_v1::s_ptRange = 1000.0

staticconstexprprotected

Definition at line 181 of file ICandData_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

◆ Quality

Constructor & Destructor Documentation

◆ ICandData_v1()

◆ ~ICandData_v1()

Member Function Documentation

◆ bcTag()

◆ candCharge()

◆ candQuality()

◆ coinType()

◆ coinTypeBitMask()

◆ eta()

◆ etaBitRange()

◆ etaRange()

◆ initialize()

◆ mdtFlag()

◆ phi()

◆ phiBitRange()

◆ phiRange()

◆ pt()

◆ ptBitRange()

◆ ptRange()

◆ sectorId()

◆ setBcTag()

◆ setCandCharge()

◆ setCandQuality()

◆ setCoinType()

◆ setEta()

◆ setMdtFlag()

◆ setPhi()

◆ setPt()

◆ setSectorId()

◆ setSubdetectorId()

◆ setThreshold()

◆ subdetectorId()

◆ threshold()

Member Data Documentation

◆ COINTYPE_BIT_MASK

◆ s_etaBitRange

◆ s_etaRange

◆ s_phiBitRange

◆ s_phiRange

◆ s_ptBitRange

◆ s_ptRange