ExampleL1TriggerByteStreamTool Class Reference

Example implementation of a tool for L1 RoI conversion from BS to xAOD and from xAOD to BS (IL1TriggerByteStreamTool interface) More...

#include <ExampleL1TriggerByteStreamTool.h>

Inheritance diagram for ExampleL1TriggerByteStreamTool:

Collaboration diagram for ExampleL1TriggerByteStreamTool:

Public Member Functions
	ExampleL1TriggerByteStreamTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~ExampleL1TriggerByteStreamTool () override=default
virtual StatusCode	initialize () override
virtual StatusCode	convertFromBS (const std::vector< const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment * > &vrobf, const EventContext &eventContext) const override
	BS->xAOD conversion. More...
virtual StatusCode	convertToBS (std::vector< OFFLINE_FRAGMENTS_NAMESPACE_WRITE::ROBFragment * > &vrobf, const EventContext &eventContext) override
	xAOD->BS conversion More...
virtual const std::vector< uint32_t > &	robIds () const override
	Declare ROB IDs for conversion. More...

Private Attributes
Gaudi::Property< std::vector< uint32_t > >	m_robIds
SG::WriteHandleKey< xAOD::MuonRoIContainer >	m_roiWriteKey
SG::ReadHandleKey< xAOD::MuonRoIContainer >	m_roiReadKey

Detailed Description

Example implementation of a tool for L1 RoI conversion from BS to xAOD and from xAOD to BS (IL1TriggerByteStreamTool interface)

This example decodes Muon RoIs from MUCTPI raw data, filling the results with dummy values. Real implementations should have very similar structure and should implement the same functionality and properties. In particular, the convertFromBS method should record a new xAOD collection in the event store using a WriteHandle, and the convertToBS method should take the xAOD collection from the event store using a ReadHandle.

Definition at line 27 of file ExampleL1TriggerByteStreamTool.h.

Constructor & Destructor Documentation

ExampleL1TriggerByteStreamTool()

ExampleL1TriggerByteStreamTool::ExampleL1TriggerByteStreamTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Definition at line 21 of file ExampleL1TriggerByteStreamTool.cxx.

: base_class(type, name, parent) {}

~ExampleL1TriggerByteStreamTool()

virtual ExampleL1TriggerByteStreamTool::~ExampleL1TriggerByteStreamTool ( )

overridevirtualdefault

Member Function Documentation

convertFromBS()

StatusCode ExampleL1TriggerByteStreamTool::convertFromBS ( const std::vector< const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment * > &  vrobf, const EventContext &  eventContext  ) const

overridevirtual

BS->xAOD conversion.

Definition at line 37 of file ExampleL1TriggerByteStreamTool.cxx.

                                                                                                 {
  if (m_roiWriteKey.empty()) {
    ATH_MSG_ERROR("Conversion from BS to xAOD RoI requested but RoI WriteHandleKey is empty");
    return StatusCode::FAILURE;
  }
 
  // Create and record the RoI container
  auto handle = SG::makeHandle(m_roiWriteKey, eventContext);
  auto cont = std::make_unique<xAOD::MuonRoIContainer>();
  auto auxcont = std::make_unique<xAOD::MuonRoIAuxContainer>();
  cont->setStore(auxcont.get());
  ATH_CHECK(handle.record(std::move(cont), std::move(auxcont)));
  ATH_MSG_DEBUG("Recorded MuonRoIContainer with key " << m_roiWriteKey.key());
 
  // Find the ROB fragment to decode
  const eformat::helper::SourceIdentifier sid(m_robIds.value().at(0));
  auto it = std::find_if(vrobf.begin(), vrobf.end(), [&sid](const ROBF* rob){return rob->rob_source_id() == sid.code();});
  if (it == vrobf.end()) {
    ATH_MSG_DEBUG("No MUCTPI ROB fragment with ID 0x" << std::hex << sid.code() << std::dec
                  << " was found, MuonRoIContainer will be empty");
    return StatusCode::SUCCESS;
  }
 
  // Iterate over ROD words and decode
  const ROBF* rob = *it;
  const uint32_t ndata = rob->rod_ndata();
  const uint32_t* data = rob->rod_data();
  ATH_MSG_DEBUG("Starting to decode " << ndata << " ROD words");
  for (const uint32_t word : std::span{data, ndata}) {
    ATH_MSG_DEBUG("Muon RoI raw word: 0x" << std::hex << word << std::dec);
    // Here comes the decoding
    // Using some dummy values as this is not real decoding, just an example
    handle->push_back(new xAOD::MuonRoI);
    handle->back()->initialize(word, 99, 99, "DummyThreshold", 99);
  }
 
  ATH_MSG_DEBUG("Decoded " << handle->size() << " Muon RoIs");
  return StatusCode::SUCCESS;
}

convertToBS()

StatusCode ExampleL1TriggerByteStreamTool::convertToBS ( std::vector< OFFLINE_FRAGMENTS_NAMESPACE_WRITE::ROBFragment * > &  vrobf, const EventContext &  eventContext  )

overridevirtual

xAOD->BS conversion

Definition at line 79 of file ExampleL1TriggerByteStreamTool.cxx.

                                                                                         {
  // Retrieve the RoI container
  auto muonRoIs = SG::makeHandle(m_roiReadKey, eventContext);
  ATH_CHECK(muonRoIs.isValid());
 
  // Clear BS data cache
  clearCache(eventContext);
 
  // Create raw ROD data words
  ATH_MSG_DEBUG("Converting " << muonRoIs->size() << " L1 Muon RoIs to ByteStream");
  uint32_t* data = newRodData(eventContext, muonRoIs->size());
  for (size_t i=0; i<muonRoIs->size(); ++i) {
    data[i] = muonRoIs->at(i)->roiWord();
  }
 
  // Create ROBFragment containing the ROD words
  const eformat::helper::SourceIdentifier sid(m_robIds.value().at(0));
  vrobf.push_back(newRobFragment(eventContext, sid.code(), muonRoIs->size(), data));
 
  return StatusCode::SUCCESS;
}

initialize()

StatusCode ExampleL1TriggerByteStreamTool::initialize ( )

overridevirtual

Definition at line 26 of file ExampleL1TriggerByteStreamTool.cxx.

                                                      {
  ConversionMode mode = getConversionMode(m_roiReadKey, m_roiWriteKey, msg());
  ATH_CHECK(mode!=ConversionMode::Undefined);
  ATH_CHECK(m_roiWriteKey.initialize(mode==ConversionMode::Decoding));
  ATH_CHECK(m_roiReadKey.initialize(mode==ConversionMode::Encoding));
  ATH_MSG_DEBUG((mode==ConversionMode::Encoding ? "Encoding" : "Decoding") << " ROB IDs: "
                << MSG::hex << m_robIds.value() << MSG::dec);
  return StatusCode::SUCCESS;
}

robIds()

virtual const std::vector<uint32_t>& ExampleL1TriggerByteStreamTool::robIds ( ) const

inlineoverridevirtual

Declare ROB IDs for conversion.

Definition at line 43 of file ExampleL1TriggerByteStreamTool.h.

{return m_robIds.value();}

Member Data Documentation

m_robIds

Gaudi::Property<std::vector<uint32_t> > ExampleL1TriggerByteStreamTool::m_robIds

private

Initial value:

{
    this, "ROBIDs", {}, "List of ROB IDs required for conversion to/from xAOD RoI"}

Definition at line 48 of file ExampleL1TriggerByteStreamTool.h.

m_roiReadKey

SG::ReadHandleKey<xAOD::MuonRoIContainer> ExampleL1TriggerByteStreamTool::m_roiReadKey

private

Initial value:

{
    this, "MuonRoIContainerReadKey", "", "Read handle key to MuonRoIContainer for conversion to ByteStream"}

Definition at line 55 of file ExampleL1TriggerByteStreamTool.h.

m_roiWriteKey

SG::WriteHandleKey<xAOD::MuonRoIContainer> ExampleL1TriggerByteStreamTool::m_roiWriteKey

private

Initial value:

{
    this, "MuonRoIContainerWriteKey", "", "Write handle key to MuonRoIContainer for conversion from ByteStream"}

Definition at line 52 of file ExampleL1TriggerByteStreamTool.h.

---

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

• ExampleL1TriggerByteStreamTool.h
• ExampleL1TriggerByteStreamTool.cxx