Data class describing the L0 muon candidates from NSW-TP to TGC SL. More...

#include <NSWCandData_v1.h>

Inheritance diagram for xAOD::NSWCandData_v1:

Collaboration diagram for xAOD::NSWCandData_v1:

Public Member Functions
	NSWCandData_v1 ()=default
	~NSWCandData_v1 ()=default
uint16_t	bcid () const
	Getters.
uint8_t	nSegments () const
	Retrieve the number of segments sent from NSW-TP to Sector Logic.
bool	overflow () const
	Check if the segment candidate limit has been exceeded.
uint8_t	fiberId () const
	Retrieve the fiber id.
uint8_t	boardId () const
	Retrieve the board id.
const std::vector< uint32_t > &	segmentWords () const
	Segments.
uint16_t	segEtaIndex (size_t i) const
	Element-by-Element Index.
uint16_t	segPhiIndex (size_t i) const
	Retrieve the phi index for a specific segment.
uint8_t	segDeltaThetaIndex (size_t i) const
	Retrieve the delta theta index for a specific segment.
uint8_t	segQuality (size_t i) const
	Retrieve the quality flag for a specific segment.
float	segEta (size_t i) const
	Retrieve the decoded physical eta coordinate for a specific segment.
float	segPhi (size_t i) const
	Retrieve the decoded physical phi coordinate for a specific segment.
void	setBCID (uint16_t bcid)
	Setters.
void	setNSegments (uint8_t nseg)
	Set the total number of segments sent from NSW-TP to Sector Logic.
void	setOverflow (bool ovf)
	Set the segment total capacity overflow state flag.
void	setFiberId (uint8_t fiber)
	Set the fiber id.
void	setBoardId (uint8_t board)
	Set the board id.
void	addSegment (uint16_t etaIndex, uint16_t phiIndex, uint8_t deltaThetaIndex, uint8_t quality)
	Pack and append a single segment.
void	clearSegments ()
	Clear all recorded segment vectors.

Friends
std::ostream &	operator<< (std::ostream &os, const NSWCandData_v1 &obj)
	Produce a formatted string representation of the candidates.

Detailed Description

Data class describing the L0 muon candidates from NSW-TP to TGC SL.

Definition at line 20 of file NSWCandData_v1.h.

Constructor & Destructor Documentation

◆ NSWCandData_v1()

xAOD::NSWCandData_v1::NSWCandData_v1 ( )

default

◆ ~NSWCandData_v1()

xAOD::NSWCandData_v1::~NSWCandData_v1 ( )

default

Member Function Documentation

◆ addSegment()

void xAOD::NSWCandData_v1::addSegment	(	uint16_t	etaIndex,
		uint16_t	phiIndex,
		uint8_t	deltaThetaIndex,
		uint8_t	quality )

Pack and append a single segment.

Push a new completed segment into the candidate's segment collections

Parameters

etaIndex	Calculated eta index
phiIndex	Calculated phi index
deltaThetaIndex	Calculated theta index
quality	Quality flag value

Definition at line 72 of file NSWCandData_v1.cxx.

                                                                                                                {
    static const SG::AuxElement::Accessor<std::vector<uint32_t>> accWord{preFixStr + "segmentWord"};
  
    // Pack the fields into a single 32-bit container word
    uint32_t packedWord = 0;
    packedWord |= (static_cast<uint32_t>(etaIndex) & L0Muon::NSWTPBits::RUN4_NSWTP_ETA_MASK) << L0Muon::NSWTPBits::RUN4_NSWTP_ETA_SHIFT;
    packedWord |= (static_cast<uint32_t>(phiIndex) & L0Muon::NSWTPBits::RUN4_NSWTP_PHI_MASK) << L0Muon::NSWTPBits::RUN4_NSWTP_PHI_SHIFT;
    packedWord |= (static_cast<uint32_t>(deltaThetaIndex) & L0Muon::NSWTPBits::RUN4_NSWTP_DTH_MASK) << L0Muon::NSWTPBits::RUN4_NSWTP_DTH_SHIFT;
    packedWord |= (static_cast<uint32_t>(quality) & L0Muon::NSWTPBits::RUN4_NSWTP_QUAL_MASK) << L0Muon::NSWTPBits::RUN4_NSWTP_QUAL_SHIFT;
 
    accWord(*this).push_back(packedWord);
  }

◆ bcid()

uint16_t xAOD::NSWCandData_v1::bcid ( ) const

Getters.

Retrieve the Bunch Crossing Identifier (BCID)

Returns: 12-bit bunch crossing ID

◆ boardId()

uint8_t xAOD::NSWCandData_v1::boardId ( ) const

Retrieve the board id.

Returns: Board identifier address

◆ clearSegments()

void xAOD::NSWCandData_v1::clearSegments ( )

Clear all recorded segment vectors.

Definition at line 86 of file NSWCandData_v1.cxx.

                                     {
    static const SG::AuxElement::Accessor<std::vector<uint32_t>> accWord{preFixStr + "segmentWord"};
    accWord(*this).clear();
  }

◆ fiberId()

uint8_t xAOD::NSWCandData_v1::fiberId ( ) const

Retrieve the fiber id.

Returns: Fiber identifier code

◆ nSegments()

uint8_t xAOD::NSWCandData_v1::nSegments ( ) const

Retrieve the number of segments sent from NSW-TP to Sector Logic.

Returns: Number of segments

◆ overflow()

bool xAOD::NSWCandData_v1::overflow ( ) const

Check if the segment candidate limit has been exceeded.

Returns: True if there are more than 8 segments detected

Definition at line 29 of file NSWCandData_v1.cxx.

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

◆ segDeltaThetaIndex()

uint8_t xAOD::NSWCandData_v1::segDeltaThetaIndex ( size_t i ) const

Retrieve the delta theta index for a specific segment.

Parameters

i	Index of the segment within the vector

Definition at line 54 of file NSWCandData_v1.cxx.

                                                           { 
    return (segmentWords().at(i) >> L0Muon::NSWTPBits::RUN4_NSWTP_DTH_SHIFT) & L0Muon::NSWTPBits::RUN4_NSWTP_DTH_MASK; 
  }

◆ segEta()

float xAOD::NSWCandData_v1::segEta ( size_t i ) const

Retrieve the decoded physical eta coordinate for a specific segment.

Parameters

i	Index of the segment within the vector

Returns: Transformed float value representing the physical eta position

Definition at line 62 of file NSWCandData_v1.cxx.

                                             {
    return L0Muon::NSWTPBits::ETA_MIN + 
      (static_cast<float>(segEtaIndex(i)) / L0Muon::NSWTPBits::ETA_MAX_RAW) * (L0Muon::NSWTPBits::ETA_MAX - L0Muon::NSWTPBits::ETA_MIN);
  }

◆ segEtaIndex()

uint16_t xAOD::NSWCandData_v1::segEtaIndex ( size_t i ) const

Element-by-Element Index.

Retrieve the eta index for a specific segment

Parameters

i	Index of the segment within the vector

Definition at line 46 of file NSWCandData_v1.cxx.

                                                     { 
    return (segmentWords().at(i) >> L0Muon::NSWTPBits::RUN4_NSWTP_ETA_SHIFT) & L0Muon::NSWTPBits::RUN4_NSWTP_ETA_MASK; 
  }

◆ segmentWords()

const std::vector< uint32_t > & xAOD::NSWCandData_v1::segmentWords ( ) const

Segments.

Get the complete collection of packed 32-bit segment words

Returns: Reference to the vector of packed segment data words

Definition at line 40 of file NSWCandData_v1.cxx.

                                                                {
    static const SG::AuxElement::Accessor<std::vector<uint32_t>> acc{preFixStr + "segmentWord"};
    return acc(*this);
  }

◆ segPhi()

float xAOD::NSWCandData_v1::segPhi ( size_t i ) const

Retrieve the decoded physical phi coordinate for a specific segment.

Parameters

i	Index of the segment within the vector

Returns: Transformed float value representing the physical phi position (in radians)

Definition at line 67 of file NSWCandData_v1.cxx.

                                             {
    return (static_cast<float>(segPhiIndex(i)) / L0Muon::NSWTPBits::PHI_MAX_RAW) * L0Muon::NSWTPBits::PHI_MAX;
  }

◆ segPhiIndex()

uint16_t xAOD::NSWCandData_v1::segPhiIndex ( size_t i ) const

Retrieve the phi index for a specific segment.

Parameters

i	Index of the segment within the vector

Definition at line 50 of file NSWCandData_v1.cxx.

                                                     { 
    return (segmentWords().at(i) >> L0Muon::NSWTPBits::RUN4_NSWTP_PHI_SHIFT) & L0Muon::NSWTPBits::RUN4_NSWTP_PHI_MASK; 
  }

◆ segQuality()

uint8_t xAOD::NSWCandData_v1::segQuality ( size_t i ) const

Retrieve the quality flag for a specific segment.

Parameters

i	Index of the segment within the vector

Definition at line 58 of file NSWCandData_v1.cxx.

                                                   { 
    return (segmentWords().at(i) >> L0Muon::NSWTPBits::RUN4_NSWTP_QUAL_SHIFT) & L0Muon::NSWTPBits::RUN4_NSWTP_QUAL_MASK; 
  }

◆ setBCID()

void xAOD::NSWCandData_v1::setBCID ( uint16_t bcid )

Setters.

Set the Bunch Crossing Identifier (BCID)

Parameters

bcid	12-bit bunch crossing ID

◆ setBoardId()

void xAOD::NSWCandData_v1::setBoardId ( uint8_t board )

Set the board id.

Parameters

board Board id

◆ setFiberId()

void xAOD::NSWCandData_v1::setFiberId ( uint8_t fiber )

Set the fiber id.

Parameters

fiber Fiber id code

◆ setNSegments()

void xAOD::NSWCandData_v1::setNSegments ( uint8_t nseg )

Set the total number of segments sent from NSW-TP to Sector Logic.

Parameters

nseg	Segment count token

◆ setOverflow()

void xAOD::NSWCandData_v1::setOverflow ( bool ovf )

Set the segment total capacity overflow state flag.

Parameters

ovf	Overflow flag state

Definition at line 34 of file NSWCandData_v1.cxx.

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

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const NSWCandData_v1 &	obj )

friend

Produce a formatted string representation of the candidates.

Returns: A string summary of the candidates

Definition at line 92 of file NSWCandData_v1.cxx.

                                                                   {
    os << "\n*BEGIN* xAOD::NSWCandData" << std::endl;
    os << "   BCID:                             " << obj.bcid() << std::endl;
    os << "   Board ID:                         " << static_cast<int>(obj.boardId()) << std::endl;
    os << "   Fiber ID:                         " << static_cast<int>(obj.fiberId()) << std::endl;
    os << "   Number of Segments:               " << static_cast<int>(obj.nSegments()) << std::endl;
    os << "   Overflow Flag:                    " << (obj.overflow() ? "TRUE" : "FALSE") << std::endl;
    
    const auto& words = obj.segmentWords();
    os << "   Stored Packed Segment Count:      " << words.size() << std::endl;
    
    for (size_t i = 0; i < words.size(); ++i) {
      os << "   -- Segment #" << i << std::endl;
      os << "      Eta Index:                     " << obj.segEtaIndex(i) << " (eta ~ " << obj.segEta(i) << ")" << std::endl;
      os << "      Phi Index:                     " << obj.segPhiIndex(i) << " (phi ~ " << obj.segPhi(i) << ")" << std::endl;
      os << "      Delta Theta Index:             " << static_cast<int>(obj.segDeltaThetaIndex(i)) << std::endl;
      os << "      Quality Flag:                  " << static_cast<int>(obj.segQuality(i)) << std::endl;
    }
    os << "*END* xAOD::NSWCandData" << std::endl;
    return os;
  }

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

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ NSWCandData_v1()

◆ ~NSWCandData_v1()

Member Function Documentation

◆ addSegment()

◆ bcid()

◆ boardId()

◆ clearSegments()

◆ fiberId()

◆ nSegments()

◆ overflow()

◆ segDeltaThetaIndex()

◆ segEta()

◆ segEtaIndex()

◆ segmentWords()

◆ segPhi()

◆ segPhiIndex()

◆ segQuality()

◆ setBCID()

◆ setBoardId()

◆ setFiberId()

◆ setNSegments()

◆ setOverflow()

Friends And Related Symbol Documentation

◆ operator<<