Classes
class	Fibre
	Represents the L1Topo fibre word of the L1Topo DAQ header, with decoder and encoder. More...
class	Header
	Represents the L1Topo header word of the L1Topo DAQ data, with decoder and encoder. More...
class	L1TopoFPGA
class	L1TopoResult
class	L1TopoROD
class	L1TopoTOB
	Represents the L1Topo TOB word of the L1Topo ROI data, with decode and encoder. More...
class	ModuleID
	Represents the L1Topo module ID, with decoder and encoder. More...
class	Status
	Represents the L1Topo status word of the L1Topo DAQ header, with decoder and encoder. More...

Enumerations
enum class	BlockTypes { HEADER =0xc , FIBRE =0xd , STATUS =0xe , EM_TOB =0x0 , TAU_TOB =0x1 , MUON_TOB =0x2 , JET1_TOB =0x4 , JET2_TOB =0x5 , ENERGY_TOB =0x6 , L1TOPO_TOB =0x8 }
	L1Topo data block types and their 4-bit codes. More...
enum class	Error { ROB_ERROR =0 , ROD_ERROR , SLINK_STATUS_ERROR }
	The different types of error that can be flagged in the L1TopoRDO. More...

Functions
L1Topo::BlockTypes	blockType (const uint32_t word, uint32_t offset=28, uint32_t size=0x0f)
	Function to return the block type of a data word from L1Topo.
std::string	blockTypeString (L1Topo::BlockTypes type)
std::ostream &	operator<< (std::ostream &, const Error)
	Helper to print errors as text rather than numbers.
std::ostream &	operator<< (std::ostream &, const std::vector< Error > &)
	Helper to print vectors of errors.
std::ostream &	operator<< (std::ostream &, const Fibre &)
	Helper for printing.
int	signedBCN (const uint32_t sign, uint32_t offset)
	helper function to return a relative bunch crossing as a signed integer, given the sign bit and offset that are encoded in the header
std::pair< uint32_t, uint32_t >	signAndOffsetBCN (const int bcn)
	reverse helper function to return the sign and offset bits given a relative bunch crossing number
std::ostream &	operator<< (std::ostream &, const Header &)
	Helper for printing.
uint32_t	decode (const uint32_t &word, const uint32_t &offset, const uint32_t &size)
	Helper function to decode word based on offset and size.
std::string	formatHex8 (uint32_t word)
	Helper function to format a 32-bit integer as an 8-digit hex number for printing.
std::string	formatHex4 (uint32_t word)
	Helper function to format a 32-bit integer as a 4-digit hex number for printing.
const std::string	formatVecHex8 (const std::vector< uint32_t > &vec)
	Helper function to format a vector of 32-bit integers as 8-digit hex numbers for printing.
unsigned int	triggerBitIndex (uint32_t moduleId, const L1Topo::L1TopoTOB &)
	OUT OF DATE DO NOT USE Helper to calculate the index needed to pack trigger bits into the full 128-bit decision. See 4-bit part of L1Topo TOB definition in https://twiki.cern.ch/twiki/pub/Atlas/L1CaloUpgrade/ROD_data_format_v1.0.4.xlsx.
unsigned int	triggerBitIndexNew (uint32_t moduleId, const L1Topo::L1TopoTOB &, unsigned int bitIdx)
	Helper to calculate the index needed to pack trigger bits into the full 128-bit decision. See 4-bit part of L1Topo TOB definition in https://twiki.cern.ch/twiki/pub/Atlas/L1CaloUpgrade/ROD_data_format_v1.0.4.xlsx ; same as TriggerLine::calcCounter()?
unsigned int	triggerBitIndexPhase1 (uint32_t topo, uint32_t fpga, size_t bitIdx)
std::pair< std::bitset< 128 >, std::bitset< 128 > >	getDecisionAndOverflowBits (const L1TopoRDOCollection &)
	Get the trigger decision and overflow bits from the L1Topo ROI data block 'L1Topo TOB' and order them correctly in a bitset. Reference needed for layout.
std::ostream &	operator<< (std::ostream &, const L1TopoFPGA &)
std::ostream &	operator<< (std::ostream &, const L1TopoROD &)
std::ostream &	operator<< (std::ostream &, const L1TopoTOB &)
	Helper for printing.
bool	operator== (const L1TopoTOB &, const L1TopoTOB &)
	Comparison operators, based on word.
bool	operator!= (const L1TopoTOB &, const L1TopoTOB &)
	Comparison operators, based on word.
bool	operator< (const L1TopoTOB &, const L1TopoTOB &)
	Comparison operators, based on word.
bool	operator> (const L1TopoTOB &, const L1TopoTOB &)
	Comparison operators, based on word.
std::ostream &	operator<< (std::ostream &os, const ModuleID &)
	print helpers
std::ostream &	operator<< (std::ostream &, const Status &)

Variables
static const std::map< Error, std::string >	errorText
	Define the text to print for each error type above - bad design to put it in the header file?

Enumeration Type Documentation

◆ BlockTypes

enum class L1Topo::BlockTypes

strong

L1Topo data block types and their 4-bit codes.

Enumerator
HEADER
FIBRE
STATUS
EM_TOB
TAU_TOB
MUON_TOB
JET1_TOB
JET2_TOB
ENERGY_TOB
L1TOPO_TOB

Definition at line 14 of file BlockTypes.h.

                        {
    HEADER=0xc,
    FIBRE=0xd,
    STATUS=0xe,
    EM_TOB=0x0,
    TAU_TOB=0x1,
    MUON_TOB=0x2,
    JET1_TOB=0x4,
    JET2_TOB=0x5,
    ENERGY_TOB=0x6,
    L1TOPO_TOB=0x8
  };

◆ Error

enum class L1Topo::Error

strong

The different types of error that can be flagged in the L1TopoRDO.

Enumerator
ROB_ERROR
ROD_ERROR
SLINK_STATUS_ERROR

Definition at line 16 of file Error.h.

16{ ROB_ERROR=0, ROD_ERROR, SLINK_STATUS_ERROR };

ALFAEventBitInfo::ROB_ERROR

@ ROB_ERROR

ROB status error.

Definition ALFAEventBitInfo.h:10

L1Topo::Error::ROD_ERROR

@ ROD_ERROR

Definition Error.h:16

L1Topo::Error::SLINK_STATUS_ERROR

@ SLINK_STATUS_ERROR

Definition Error.h:16

Function Documentation

◆ blockType()

L1Topo::BlockTypes L1Topo::blockType	(	const uint32_t	word,
		uint32_t	offset = 28,
		uint32_t	size = 0x0f )

Function to return the block type of a data word from L1Topo.

Definition at line 9 of file BlockTypes.cxx.

                                                                                 {
    return static_cast<BlockTypes>(word>>offset & size);
  }

◆ blockTypeString()

std::string L1Topo::blockTypeString ( L1Topo::BlockTypes type )

Definition at line 14 of file BlockTypes.cxx.

                                                   {
    if (type==L1Topo::BlockTypes::HEADER) {return "header";}
    else if (type==L1Topo::BlockTypes::FIBRE) {return "fibre";}
    else if (type==L1Topo::BlockTypes::STATUS) {return "status";}
    else if (type==L1Topo::BlockTypes::EM_TOB) {return "EM TOB";}
    else if (type==L1Topo::BlockTypes::TAU_TOB) {return "Tau TOB";}
    else if (type==L1Topo::BlockTypes::MUON_TOB) {return "Muon TOB";}
    else if (type==L1Topo::BlockTypes::JET1_TOB) {return "Jet1 TOB";}
    else if (type==L1Topo::BlockTypes::JET2_TOB) {return "Jet2 TOB";}
    else if (type==L1Topo::BlockTypes::ENERGY_TOB) {return "Energy TOB";}
    else if (type==L1Topo::BlockTypes::L1TOPO_TOB) {return "L1Topo TOB";}
    else {return "unknown";}
  }

◆ decode()

uint32_t L1Topo::decode	(	const uint32_t &	word,
		const uint32_t &	offset,
		const uint32_t &	size )

Helper function to decode word based on offset and size.

Definition at line 107 of file Trigger/TrigT1/L1Topo/L1TopoRDO/src/Helpers.cxx.

                                                                                      {
    return static_cast<uint32_t>((word >> offset) & size);
  }

◆ formatHex4()

std::string L1Topo::formatHex4 ( uint32_t word )

Helper function to format a 32-bit integer as a 4-digit hex number for printing.

Definition at line 117 of file Trigger/TrigT1/L1Topo/L1TopoRDO/src/Helpers.cxx.

                                     {
    std::ostringstream s;
    s << std::showbase << std::hex << std::internal << std::setfill ('0') << std::setw( 6 ) << word << std::dec << std::noshowbase;
    return s.str();
  }

◆ formatHex8()

std::string L1Topo::formatHex8 ( uint32_t word )

Helper function to format a 32-bit integer as an 8-digit hex number for printing.

Definition at line 111 of file Trigger/TrigT1/L1Topo/L1TopoRDO/src/Helpers.cxx.

                                     {
    std::ostringstream s;
    s << std::showbase << std::hex << std::internal << std::setfill ('0') << std::setw(10) << word << std::dec << std::noshowbase;
    return s.str();
  }

◆ formatVecHex8()

const std::string L1Topo::formatVecHex8 ( const std::vector< uint32_t > & vec )

Helper function to format a vector of 32-bit integers as 8-digit hex numbers for printing.

Definition at line 124 of file Trigger/TrigT1/L1Topo/L1TopoRDO/src/Helpers.cxx.

{
    std::ostringstream s;
    s<<"[ ";
    for (auto elem: vec){
        s<<std::hex<<std::showbase<<std::setfill('0')<<std::setw(10)
         <<elem<<" "<<std::dec<<std::noshowbase;
    }
    s<<"]";
    return s.str();
}

◆ getDecisionAndOverflowBits()

std::pair< std::bitset< 128 >, std::bitset< 128 > > L1Topo::getDecisionAndOverflowBits ( const L1TopoRDOCollection & col )

Get the trigger decision and overflow bits from the L1Topo ROI data block 'L1Topo TOB' and order them correctly in a bitset. Reference needed for layout.

Definition at line 169 of file Trigger/TrigT1/L1Topo/L1TopoRDO/src/Helpers.cxx.

                                                                                                     {
    
    // There is no uint128_t so a bit-wise approach is needed.
    std::bitset<128> decision;
    std::bitset<128> overflow;
 
    //std::cout << "L1Topo::getDecisionAndOverflowBits: number of RDOs " << col.size() << std::endl;
    
    for (L1TopoRDOCollection::const_iterator pRDO = col.begin(); pRDO != col.end(); ++pRDO){
      const std::vector<uint32_t> data = (*pRDO)->getDataWords();
      //std::cout << "L1Topo::getDecisionAndOverflowBits: number of data words " << data.size() << std::endl;
      for(const uint32_t word: data){
    if (L1Topo::blockType(word) == L1Topo::BlockTypes::L1TOPO_TOB){
      L1Topo::L1TopoTOB c(word);
      const uint32_t triggerByte = c.trigger_bits();
      const uint32_t overflowByte = c.overflow_bits();
      // Take one bit at a time and set it in the bitset
      //std::cout << "L1Topo::getDecisionAndOverflowBits: " << c;
      for (unsigned int i=0; i<8; ++i){
            const unsigned int index = L1Topo::triggerBitIndexNew((*pRDO)->getSourceID(),c,i);
        decision[index]=( triggerByte >>i)&1;
        overflow[index]=(overflowByte >>i)&1;
      }
      //std::cout << " index " << index << " updated decision " << decision << std::endl;
      //std::cout << " index " << index << " updated overflow " << overflow << std::endl;
    }
    else{
      //std::cout << "L1Topo::getDecisionAndOverflowBits: skipping block as not L1Topo_TOB " << L1Topo::formatHex8(word) << std::endl;
    }
      }
    }  
    return std::pair< std::bitset<128>,std::bitset<128> >(decision,overflow);
  }

◆ operator!=()

bool L1Topo::operator!=	(	const L1TopoTOB &	lhs,
		const L1TopoTOB &	rhs )

Comparison operators, based on word.

Definition at line 30 of file L1TopoTOB.cxx.

                                                                          {
    return (lhs.word()!=rhs.word());
  }

◆ operator<()

bool L1Topo::operator<	(	const L1TopoTOB &	lhs,
		const L1TopoTOB &	rhs )

Comparison operators, based on word.

Definition at line 33 of file L1TopoTOB.cxx.

                                                                         {
    return (lhs.word()<rhs.word());
  }

◆ operator<<() [1/9]

std::ostream & L1Topo::operator<<	(	std::ostream &	os,
		const Error	e )

Helper to print errors as text rather than numbers.

Definition at line 8 of file Error.cxx.

                                                       {
    std::string text = "Unknown Error";
    auto it = errorText.find(e);
    if (it != errorText.end()){
      text = it->second;
    }  
    os << text;
    return os;
  }

◆ operator<<() [2/9]

std::ostream & L1Topo::operator<<	(	std::ostream &	os,
		const Fibre &	f )

Helper for printing.

Definition at line 56 of file Fibre.cxx.

                                                         {
  
    os << "     Fibre status,sizes: ";
    for (unsigned int i=0; i<5 && i<f.status().size() && i<f.count().size(); ++i){
      os << "(" << f.status().at(i) << "," << f.count().at(i) << ") ";
    }
    return os;
  }

◆ operator<<() [3/9]

std::ostream & L1Topo::operator<<	(	std::ostream &	os,
		const Header &	h )

Helper for printing.

Definition at line 89 of file L1Topo/L1TopoRDO/src/Header.cxx.

                                                          {
    os << "     Block header:" 
       << " version " << h.version() 
       << std::hex
       << " active_fibres 0x" << h.active_fibres()
       << " payload_crc 0x" << h.payload_crc()
       << std::dec
       << " fpga " << h.fpga()
       << " relative bcn " << h.bcn()
       << " last_block " << h.last_block();
    return os;
  }

◆ operator<<() [4/9]

std::ostream & L1Topo::operator<<	(	std::ostream &	os,
		const L1TopoFPGA &	s )

Definition at line 89 of file L1TopoFPGA.cxx.

                                                              {
    os << std::hex << std::showbase << s.fpgaTrailer1() << std::dec <<
      " Block Size= " << s.fpgaBlockSize() << " topoNumber= " << s.topoNumber() <<
      " fpgaNumber= " << s.fpgaNumber() << " numSlices= " << s.numSlices() <<
      " sliceNumber= " << s.sliceNumber() <<
      "\n" <<
      std::hex << std::showbase << s.fpgaTrailer2() << std::dec <<
      " CRC= " << s.crc() <<
      " Errors: CT= " << s.ct() << " sm= " << s.sm() <<
      " pe= " <<s.pe() << " lm= " << s.lm() << " hm= " << s.hm() << " pt= " << s.pt() <<
      std::dec << "\n";
    return os;
  }

◆ operator<<() [5/9]

std::ostream & L1Topo::operator<<	(	std::ostream &	os,
		const L1TopoROD &	s )

Definition at line 93 of file L1TopoROD.cxx.

                                                             {
    os << std::hex << std::showbase << s.rodTrailer1() << std::dec <<
      " Shelf= " << s.shelf() << " ROD= " << s.rod() <<
      " Link error map= " << s.linkErrMap() << " Payload length= " << s.payloadLength() <<
      "\n" <<
      std::hex << std::showbase << s.rodTrailer2() << std::dec <<
      " CRC= " << s.crc() << " Link errors= " << s.linkErrs() <<
      " ROD errors: CT= " << s.ct() << " pc= " << s.pc() << " hc= " << s.hc() <<
      " pe= " <<s.pe() << " lm= " << s.lm() << " hm= " << s.hm() << " pt= " << s.pt() <<
      std::dec << "\n";
    return os;
  }

◆ operator<<() [6/9]

std::ostream & L1Topo::operator<<	(	std::ostream &	os,
		const L1TopoTOB &	c )

Helper for printing.

Definition at line 103 of file L1TopoTOB.cxx.

                                                             {
    os << "     L1Topo TOB: "
       << " ctp_signal 0x" << std::hex << c.ctp_signal() << std::dec
       << " ( index " << c.index() << " clock " << c.clock() << " fpga " << c.fpga() << " )"
       << " CRC error bits 0b" << std::bitset<5>(c.error_bits())
       << " overflow bits 0b" << std::bitset<8>(c.overflow_bits())
       << " trigger bits 0b" << std::bitset<8>(c.trigger_bits())
       << std::dec << "\n";
    return os;
  }

◆ operator<<() [7/9]

std::ostream & L1Topo::operator<<	(	std::ostream &	os,
		const Status &	s )

Definition at line 44 of file Status.cxx.

                                                          {
    os << "     Status: overflow " << s.overflow() << " crc mismatch " << s.crc();
    return os;
  }

◆ operator<<() [8/9]

std::ostream & L1Topo::operator<<	(	std::ostream &	os,
		const std::vector< Error > &	v )

Helper to print vectors of errors.

Definition at line 18 of file Error.cxx.

                                                                   {
    os << "[";
    std::string prefix="";
    for (auto e : v){
      os << prefix << e;
      prefix=", ";
    }
    os << "]";
    return os;
  }

◆ operator<<() [9/9]

std::ostream & L1Topo::operator<<	(	std::ostream &	os,
		const ModuleID &	m )

print helpers

Definition at line 57 of file ModuleID.cxx.

                                                            {
    os << "ModuleID: " << " " << formatHex4(m.id()) << " 0b" << std::bitset<8>(m.id()) << " link " << m.link() << " " << " module " << m.module();
    if (m.isDAQ()){
      os << " DAQ";
    } 
    else if (m.isROI()){
      os << " ROI";
    }
    return os;
  }

◆ operator==()

bool L1Topo::operator==	(	const L1TopoTOB &	lhs,
		const L1TopoTOB &	rhs )

Comparison operators, based on word.

Definition at line 27 of file L1TopoTOB.cxx.

                                                                          {
    return (lhs.word()==rhs.word());
  }

◆ operator>()

bool L1Topo::operator>	(	const L1TopoTOB &	lhs,
		const L1TopoTOB &	rhs )

Comparison operators, based on word.

Definition at line 36 of file L1TopoTOB.cxx.

                                                                         {
    return (lhs.word()>rhs.word());
  }

◆ signAndOffsetBCN()

std::pair< uint32_t, uint32_t > L1Topo::signAndOffsetBCN ( const int bcn )

reverse helper function to return the sign and offset bits given a relative bunch crossing number

Definition at line 83 of file L1Topo/L1TopoRDO/src/Header.cxx.

                                                            {
    uint32_t offset = std::abs(bcn);
    uint32_t sign = (bcn<0)?1:0; // negative bcn encoded as 1
    return std::pair<uint32_t,uint32_t>(sign,offset);
  }

◆ signedBCN()

int L1Topo::signedBCN	(	const uint32_t	sign,
		uint32_t	offset )

helper function to return a relative bunch crossing as a signed integer, given the sign bit and offset that are encoded in the header

Definition at line 79 of file L1Topo/L1TopoRDO/src/Header.cxx.

                                                     {
    return static_cast<int>(offset) * (sign>0 ? -1 : 1); // sign=0 is false
  }

◆ triggerBitIndex()

unsigned int L1Topo::triggerBitIndex	(	uint32_t	moduleId,
		const L1Topo::L1TopoTOB &	c )

OUT OF DATE DO NOT USE Helper to calculate the index needed to pack trigger bits into the full 128-bit decision. See 4-bit part of L1Topo TOB definition in https://twiki.cern.ch/twiki/pub/Atlas/L1CaloUpgrade/ROD_data_format_v1.0.4.xlsx.

Definition at line 137 of file Trigger/TrigT1/L1Topo/L1TopoRDO/src/Helpers.cxx.

                                                                           {
    uint32_t module = (moduleId >>4) & 0x1;
    uint32_t index = 64*module + 32*c.fpga() + 16*c.clock() + 8*c.index();
    return index;
  }

◆ triggerBitIndexNew()

unsigned int L1Topo::triggerBitIndexNew	(	uint32_t	moduleId,
		const L1Topo::L1TopoTOB &	c,
		unsigned int	bitIdx )

Helper to calculate the index needed to pack trigger bits into the full 128-bit decision. See 4-bit part of L1Topo TOB definition in https://twiki.cern.ch/twiki/pub/Atlas/L1CaloUpgrade/ROD_data_format_v1.0.4.xlsx ; same as TriggerLine::calcCounter()?

Definition at line 144 of file Trigger/TrigT1/L1Topo/L1TopoRDO/src/Helpers.cxx.

                                                                                                   {
    uint32_t module = (moduleId >>4) & 0x1;
    uint32_t index = 64*module + 32*c.fpga() + c.clock() + 2*(8*c.index() + bitIdx);
    //std::cout << "L1Topo::triggerBitIndexNew DEBUG index=" << index << " for module=" << module << " fpga=" << c.fpga() << " clock=" << c.clock() << " index=" << c.index() << " bitIdx=" << bitIdx << std::endl;
    return index;
  }

◆ triggerBitIndexPhase1()

unsigned int L1Topo::triggerBitIndexPhase1	(	uint32_t	topo,
		uint32_t	fpga,
		size_t	bitIdx )

Definition at line 152 of file Trigger/TrigT1/L1Topo/L1TopoRDO/src/Helpers.cxx.

                                                                                 {
    uint32_t index = (topo==3 ? (fpga+2)*32:fpga*32);
    index += bitIdx<16 ? 2*(bitIdx) : 2*(bitIdx-16)+1;
    return index;
  }

Variable Documentation

◆ errorText

const std::map<Error, std::string> L1Topo::errorText

static

Initial value:

= {
    {Error::ROB_ERROR,"ROB Error"},
    {Error::ROD_ERROR,"ROD Error"},
    {Error::SLINK_STATUS_ERROR,"S-Link Status Error"}
  }

Define the text to print for each error type above - bad design to put it in the header file?

Definition at line 18 of file Error.h.

                                                    {
    {Error::ROB_ERROR,"ROB Error"},
    {Error::ROD_ERROR,"ROD Error"},
    {Error::SLINK_STATUS_ERROR,"S-Link Status Error"}
  };

Classes

Enumerations

Functions

Variables

Enumeration Type Documentation

◆ BlockTypes

◆ Error

Function Documentation

◆ blockType()

◆ blockTypeString()

◆ decode()

◆ formatHex4()

◆ formatHex8()

◆ formatVecHex8()

◆ getDecisionAndOverflowBits()

◆ operator!=()

◆ operator<()

◆ operator<<() [1/9]

◆ operator<<() [2/9]

◆ operator<<() [3/9]

◆ operator<<() [4/9]

◆ operator<<() [5/9]

◆ operator<<() [6/9]

◆ operator<<() [7/9]

◆ operator<<() [8/9]

◆ operator<<() [9/9]

◆ operator==()

◆ operator>()

◆ signAndOffsetBCN()

◆ signedBCN()

◆ triggerBitIndex()

◆ triggerBitIndexNew()

◆ triggerBitIndexPhase1()

Variable Documentation

◆ errorText