Tool to perform ROB fragments to JEM RoI and CMM RoI, and JEP RoI container to raw data conversions. More...

#include <JepRoiByteStreamTool.h>

Inheritance diagram for LVL1BS::JepRoiByteStreamTool:

Collaboration diagram for LVL1BS::JepRoiByteStreamTool:

Public Member Functions
	JepRoiByteStreamTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~JepRoiByteStreamTool ()
virtual StatusCode	initialize () override
virtual StatusCode	finalize () override
StatusCode	convert (const IROBDataProviderSvc::VROBFRAG &robFrags, DataVector< LVL1::JEMRoI > *jeCollection) const
	Convert ROB fragments to JEM RoIs.
StatusCode	convert (const IROBDataProviderSvc::VROBFRAG &robFrags, LVL1::CMMRoI *cmCollection) const
	Convert ROB fragments to CMM RoIs.
StatusCode	convert (const LVL1::JEPRoIBSCollection *jep) const
	Convert JEP RoI Container to bytestream.
const std::vector< uint32_t > &	sourceIDs (const std::string &sgKey) const
	Return reference to vector with all possible Source Identifiers.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	AlgTool InterfaceID.

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef DataVector< LVL1::JEMRoI >	JemRoiCollection
typedef DataVector< LVL1::CMMJetHits >	CmmHitsCollection
typedef DataVector< LVL1::CMMEtSums >	CmmSumsCollection
typedef std::map< uint32_t, const LVL1::JEMRoI * >	JemRoiMap
typedef std::map< int, const LVL1::CMMJetHits * >	CmmHitsMap
typedef std::map< int, const LVL1::CMMEtSums * >	CmmSumsMap
typedef IROBDataProviderSvc::VROBFRAG::const_iterator	ROBIterator
typedef OFFLINE_FRAGMENTS_NAMESPACE::PointerType	ROBPointer
typedef OFFLINE_FRAGMENTS_NAMESPACE::PointerType	RODPointer
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	convertBs (const IROBDataProviderSvc::VROBFRAG &robFrags, DataVector< LVL1::JEMRoI > jeCollection, LVL1::CMMRoI cmCollection) const
	Convert bytestream to given container type.
const LVL1::CMMJetHits *	findCmmHits (int crate, int dataID, const CmmHitsMap &cmmHitsMap) const
	Find CMM hits for given crate, data ID.
const LVL1::CMMEtSums *	findCmmSums (int crate, int dataID, const CmmSumsMap &cmmEtMap) const
	Find CMM energy sums for given crate, data ID.
std::vector< uint32_t >	makeSourceIDs (bool roiDaq) const
void	setupJemRoiMap (const JemRoiCollection *jeCollection, JemRoiMap &roiMap) const
	Set up JEM RoIs map.
void	setupCmmHitsMap (const CmmHitsCollection *hitCollection, CmmHitsMap &cmmHitsMap) const
	Set up CMM hits map.
void	setupCmmEtMap (const CmmSumsCollection *enCollection, CmmSumsMap &cmmEtMap) const
	Set up CMM energy sums map.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ServiceHandle< IByteStreamCnvSvc >	m_byteStreamCnvSvc { this, "ByteStreamCnvSvc", "ByteStreamCnvSvc" }
ToolHandle< LVL1BS::L1CaloErrorByteStreamTool >	m_errorTool
	Error collection tool.
int	m_crateOffsetHw
	Property: Hardware crate number offset.
int	m_crateOffsetSw
	Property: Software crate number offset.
int	m_version
	Property: Sub_block header version.
int	m_dataFormat
	Property: Data compression format.
const int	m_crates
	Number of crates.
const int	m_modules
	Number of JEM modules per crate.
int	m_slinks
	Property: Number of slinks per crate when writing out bytestream.
std::vector< uint32_t >	m_sourceIDsProp
	Property: ROB source IDs.
std::vector< uint32_t >	m_sourceIDsRoIBProp
	Property: ROB source IDs for RoIB.
const eformat::SubDetector	m_subDetector
	Sub-detector type.
const L1CaloSrcIdMap	m_srcIdMap
	Source ID converter.
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Tool to perform ROB fragments to JEM RoI and CMM RoI, and JEP RoI container to raw data conversions.

Based on ROD document version 1_09h.

Author: Peter Faulkner

Definition at line 53 of file JepRoiByteStreamTool.h.

Member Typedef Documentation

◆ CmmHitsCollection

typedef DataVector<LVL1::CMMJetHits> LVL1BS::JepRoiByteStreamTool::CmmHitsCollection

private

Definition at line 84 of file JepRoiByteStreamTool.h.

◆ CmmHitsMap

typedef std::map<int, const LVL1::CMMJetHits*> LVL1BS::JepRoiByteStreamTool::CmmHitsMap

private

Definition at line 87 of file JepRoiByteStreamTool.h.

◆ CmmSumsCollection

typedef DataVector<LVL1::CMMEtSums> LVL1BS::JepRoiByteStreamTool::CmmSumsCollection

private

Definition at line 85 of file JepRoiByteStreamTool.h.

◆ CmmSumsMap

typedef std::map<int, const LVL1::CMMEtSums*> LVL1BS::JepRoiByteStreamTool::CmmSumsMap

private

Definition at line 88 of file JepRoiByteStreamTool.h.

◆ JemRoiCollection

typedef DataVector<LVL1::JEMRoI> LVL1BS::JepRoiByteStreamTool::JemRoiCollection

private

Definition at line 83 of file JepRoiByteStreamTool.h.

◆ JemRoiMap

typedef std::map<uint32_t, const LVL1::JEMRoI*> LVL1BS::JepRoiByteStreamTool::JemRoiMap

private

Definition at line 86 of file JepRoiByteStreamTool.h.

◆ ROBIterator

typedef IROBDataProviderSvc::VROBFRAG::const_iterator LVL1BS::JepRoiByteStreamTool::ROBIterator

private

Definition at line 89 of file JepRoiByteStreamTool.h.

◆ ROBPointer

typedef OFFLINE_FRAGMENTS_NAMESPACE::PointerType LVL1BS::JepRoiByteStreamTool::ROBPointer

private

Definition at line 90 of file JepRoiByteStreamTool.h.

◆ RODPointer

typedef OFFLINE_FRAGMENTS_NAMESPACE::PointerType LVL1BS::JepRoiByteStreamTool::RODPointer

private

Definition at line 91 of file JepRoiByteStreamTool.h.

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ JepRoiByteStreamTool()

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

Definition at line 47 of file JepRoiByteStreamTool.cxx.

  : AthAlgTool(type, name, parent),
    m_errorTool("LVL1BS::L1CaloErrorByteStreamTool/L1CaloErrorByteStreamTool"),
    m_crates(2), m_modules(16),
    m_subDetector (eformat::TDAQ_CALO_JET_PROC_ROI)
{
  declareInterface<JepRoiByteStreamTool>(this);
 
  declareProperty("CrateOffsetHw",  m_crateOffsetHw = 12,
                  "Offset of JEP crate numbers in bytestream");
  declareProperty("CrateOffsetSw",  m_crateOffsetSw = 0,
                  "Offset of JEP crate numbers in RDOs");
 
  // Properties for reading bytestream only
  declareProperty("ROBSourceIDs",       m_sourceIDsProp,
                  "ROB fragment source identifiers");
  declareProperty("ROBSourceIDsRoIB",   m_sourceIDsRoIBProp,
                  "ROB fragment source identifiers");
 
  // Properties for writing bytestream only
  declareProperty("DataVersion",    m_version       = 1,
                  "Format version number in sub-block header");
  declareProperty("DataFormat",     m_dataFormat    = 1,
                  "Format identifier (0-1) in sub-block header");
  declareProperty("SlinksPerCrate", m_slinks        = 1,
                  "The number of S-Links per crate");
 
}

◆ ~JepRoiByteStreamTool()

LVL1BS::JepRoiByteStreamTool::~JepRoiByteStreamTool ( )

virtual

Definition at line 80 of file JepRoiByteStreamTool.cxx.

81{

82}

Member Function Documentation

◆ convert() [1/3]

StatusCode LVL1BS::JepRoiByteStreamTool::convert	(	const IROBDataProviderSvc::VROBFRAG &	robFrags,
		DataVector< LVL1::JEMRoI > *	jeCollection ) const

Convert ROB fragments to JEM RoIs.

Definition at line 106 of file JepRoiByteStreamTool.cxx.

{
  return convertBs(robFrags, jeCollection, nullptr);
}

◆ convert() [2/3]

StatusCode LVL1BS::JepRoiByteStreamTool::convert	(	const IROBDataProviderSvc::VROBFRAG &	robFrags,
		LVL1::CMMRoI *	cmCollection ) const

Convert ROB fragments to CMM RoIs.

Definition at line 115 of file JepRoiByteStreamTool.cxx.

{
  return convertBs(robFrags, nullptr, cmCollection);
}

◆ convert() [3/3]

StatusCode LVL1BS::JepRoiByteStreamTool::convert ( const LVL1::JEPRoIBSCollection * jep ) const

Convert JEP RoI Container to bytestream.

Sub-block for neutral format

Definition at line 124 of file JepRoiByteStreamTool.cxx.

{
  const bool debug = msgLvl(MSG::DEBUG);
  if (debug) msg(MSG::DEBUG);
 
  // Get the event assembler
  FullEventAssembler<L1CaloSrcIdMap>* fea = nullptr;
  ATH_CHECK( m_byteStreamCnvSvc->getFullEventAssembler (fea,
                                                        "JepRoiByteStream") );
  const uint16_t minorVersion = m_srcIdMap.minorVersion();
  fea->setRodMinorVersion(minorVersion);
 
  // Pointer to ROD data vector
 
  FullEventAssembler<L1CaloSrcIdMap>::RODDATA* theROD = 0;
  JemRoiSubBlock subBlock;
 
  // Set up the container maps
 
  const bool neutralFormat = m_dataFormat == L1CaloSubBlock::NEUTRAL;
 
  // JEM RoI map
  JemRoiMap  roiMap;
  setupJemRoiMap(jep->JemRoi(), roiMap);
  JemRoiMap::const_iterator mapIter    = roiMap.begin();
  JemRoiMap::const_iterator mapIterEnd = roiMap.end();
 
  // CMM hits map
  CmmHitsMap cmmHitsMap;
  // CMM energy sums map
  CmmSumsMap cmmEtMap;
  if (neutralFormat) {
    setupCmmHitsMap(jep->CmmHits(), cmmHitsMap);
    setupCmmEtMap(jep->CmmSums(), cmmEtMap);
  }
 
  // Loop over JEM RoI data
 
  const int modulesPerSlink = m_modules / m_slinks;
  for (int crate = 0; crate < m_crates; ++crate) {
    const int hwCrate = crate + m_crateOffsetHw;
 
    for (int module = 0; module < m_modules; ++module) {
 
      // Pack required number of modules per slink
 
      if (module % modulesPerSlink == 0) {
        const int daqOrRoi = 1;
        const int slink = module / modulesPerSlink;
        if (debug) {
          msg() << "Treating crate " << hwCrate
                << " slink " << slink << endmsg
                << "Data Version/Format: " << m_version
                << " " << m_dataFormat << endmsg;
        }
        const uint32_t rodIdJem = m_srcIdMap.getRodID(hwCrate, slink, daqOrRoi,
                                  m_subDetector);
        theROD = fea->getRodData(rodIdJem);
        if (neutralFormat) {
          const L1CaloUserHeader userHeader;
          theROD->push_back(userHeader.header());
        }
      }
      if (debug) msg() << "JEM Module " << module << endmsg;
      if (!theROD) break; // for coverity, shouldn't happen
 
      // Create a sub-block (Neutral format only)
 
      if (neutralFormat) {
        subBlock.clear();
        subBlock.setRoiHeader(m_version, hwCrate, module);
      }
 
      // Find JEM RoIs for this module
 
      for (; mapIter != mapIterEnd; ++mapIter) {
        const LVL1::JEMRoI* const roi = mapIter->second;
        if (roi->crate() < crate)  continue;
        if (roi->crate() > crate)  break;
        if (roi->jem()   < module) continue;
        if (roi->jem()   > module) break;
        if (roi->hits() || roi->error()) {
          if (neutralFormat) subBlock.fillRoi(*roi);
          else theROD->push_back(roi->roiWord());
        }
      }
 
      // Pack and write the sub-block
 
      if (neutralFormat) {
        if ( !subBlock.pack()) {
          msg(MSG::ERROR) << "JEM RoI sub-block packing failed" << endmsg;
          return StatusCode::FAILURE;
        }
        if (debug) {
          msg() << "JEM RoI sub-block data words: "
                << subBlock.dataWords() << endmsg;
        }
        subBlock.write(theROD);
      }
    }
    if (!theROD) break; // for coverity, shouldn't happen
 
    // Append CMM RoIs to last S-Link of the system crate
 
    if (crate != m_crates - 1) continue;
 
    // Create sub-blocks for Neutral format
 
    if (neutralFormat) {
      const int timeslices = 1;
      const int slice = 0;
 
      // CMM-Energy
 
      CmmEnergySubBlock enBlock;
      const int cmmEnergyVersion = 2; // with Missing-ET-Sig
      enBlock.setCmmHeader(cmmEnergyVersion, m_dataFormat, slice, hwCrate,
                           CmmSubBlock::SYSTEM, CmmSubBlock::CMM_ENERGY,
                           CmmSubBlock::LEFT, timeslices);
      int maxDataID = static_cast<int>(LVL1::CMMEtSums::MAXID);
      for (int dataID = 0; dataID < maxDataID; ++dataID) {
        int source = dataID;
        if (dataID >= m_modules) {
          // coverity[mixed_enums : FALSE]
          // coverity[switch_on_enum : FALSE]
          // coverity[first_enum_type : FALSE]
          switch (dataID) {
          case LVL1::CMMEtSums::LOCAL:
            source = CmmEnergySubBlock::LOCAL;
            break;
          case LVL1::CMMEtSums::REMOTE:
            source = CmmEnergySubBlock::REMOTE;
            break;
          case LVL1::CMMEtSums::TOTAL:
            source = CmmEnergySubBlock::TOTAL;
            break;
          case LVL1::CMMEtSums::MISSING_ET_MAP:
          case LVL1::CMMEtSums::SUM_ET_MAP:
          case LVL1::CMMEtSums::MISSING_ET_SIG_MAP:
            break;
          default:
            continue;
          }
        }
        const LVL1::CMMEtSums* const sums = findCmmSums(crate, dataID, cmmEtMap);
        if ( sums ) {
          const unsigned int ex = sums->Ex();
          const unsigned int ey = sums->Ey();
          const unsigned int et = sums->Et();
          const int exErr = sums->ExError();
          const int eyErr = sums->EyError();
          const int etErr = sums->EtError();
          if (dataID == LVL1::CMMEtSums::MISSING_ET_MAP) {
            enBlock.setMissingEtHits(slice, et);
          } else if (dataID == LVL1::CMMEtSums::SUM_ET_MAP) {
            enBlock.setSumEtHits(slice, et);
          } else if (dataID == LVL1::CMMEtSums::MISSING_ET_SIG_MAP) {
            enBlock.setMissingEtSigHits(slice, et);
          } else {
            enBlock.setSubsums(slice, source, ex, ey, et, exErr, eyErr, etErr);
          }
        }
      }
      if ( !enBlock.pack()) {
        msg(MSG::ERROR) << "CMM-Energy sub-block packing failed" << endmsg;
        return StatusCode::FAILURE;
      }
      if (debug) {
        msg() << "CMM-Energy sub-block data words: "
              << enBlock.dataWords() << endmsg;
      }
      enBlock.write(theROD);
 
      // CMM-Jet
 
      CmmJetSubBlock jetBlock;
      jetBlock.setCmmHeader(m_version, m_dataFormat, slice, hwCrate,
                            CmmSubBlock::SYSTEM, CmmSubBlock::CMM_JET,
                            CmmSubBlock::RIGHT, timeslices);
      maxDataID = static_cast<int>(LVL1::CMMJetHits::MAXID);
      for (int dataID = 0; dataID < maxDataID; ++dataID) {
        int source = dataID;
        if (dataID >= m_modules) {
          // coverity[mixed_enums : FALSE]
          // coverity[switch_on_enum : FALSE]
          // coverity[first_enum_type : FALSE]
          switch (dataID) {
          case LVL1::CMMJetHits::LOCAL_MAIN:
            source = CmmJetSubBlock::LOCAL_MAIN;
            break;
          case LVL1::CMMJetHits::REMOTE_MAIN:
            source = CmmJetSubBlock::REMOTE_MAIN;
            break;
          case LVL1::CMMJetHits::TOTAL_MAIN:
            source = CmmJetSubBlock::TOTAL_MAIN;
            break;
          case LVL1::CMMJetHits::LOCAL_FORWARD:
            source = CmmJetSubBlock::LOCAL_FORWARD;
            break;
          case LVL1::CMMJetHits::REMOTE_FORWARD:
            source = CmmJetSubBlock::REMOTE_FORWARD;
            break;
          case LVL1::CMMJetHits::TOTAL_FORWARD:
            source = CmmJetSubBlock::TOTAL_FORWARD;
            break;
          case LVL1::CMMJetHits::ET_MAP:
            break;
          default:
            continue;
          }
        }
        const LVL1::CMMJetHits* const ch = findCmmHits(crate, dataID, cmmHitsMap);
        if ( ch ) {
          const unsigned int hits = ch->Hits();
          const int          errs = ch->Error();
          if (dataID == LVL1::CMMJetHits::ET_MAP) {
            jetBlock.setJetEtMap(slice, hits);
          } else {
            jetBlock.setJetHits(slice, source, hits, errs);
          }
        }
      }
      if ( !jetBlock.pack()) {
        msg(MSG::ERROR) << "CMM-Jet sub-block packing failed" << endmsg;
        return StatusCode::FAILURE;
      }
      if (debug) {
        msg() << "CMM-Jet sub-block data words: "
              << jetBlock.dataWords() << endmsg;
      }
      jetBlock.write(theROD);
 
    } else {
 
      // Standard format
 
      const LVL1::CMMRoI* const roi = jep->CmmRoi();
      if ( roi ) {
        // Make sure word IDs are correct
        const LVL1::CMMRoI roid(roi->jetEtHits(), roi->sumEtHits(),
                                roi->missingEtHits(), roi->missingEtSigHits(),
                                roi->ex(), roi->ey(), roi->et(),
                                roi->jetEtError(), roi->sumEtError(),
                                roi->missingEtError(), roi->missingEtSigError(),
                                roi->exError(), roi->eyError(), roi->etError());
        if (roid.jetEtHits() || roid.jetEtError()) {
          theROD->push_back(roid.jetEtRoiWord());
        }
        // CMM-Energy RoIs are not zero-supressed unless all are zero
        if (roid.sumEtHits() || roid.missingEtHits() ||
            roid.missingEtSigHits() || roid.ex() || roid.ey() || roid.et() ||
            roid.sumEtError() || roid.missingEtError() ||
            roid.missingEtSigError() || roid.exError() || roid.eyError() ||
            roid.etError()) {
          theROD->push_back(roid.energyRoiWord0());
          theROD->push_back(roid.energyRoiWord1());
          theROD->push_back(roid.energyRoiWord2());
        }
      }
    }
  }
 
  return StatusCode::SUCCESS;
}

◆ convertBs()

StatusCode LVL1BS::JepRoiByteStreamTool::convertBs	(	const IROBDataProviderSvc::VROBFRAG &	robFrags,
		DataVector< LVL1::JEMRoI > *	jeCollection,
		LVL1::CMMRoI *	cmCollection ) const

private

Convert bytestream to given container type.

Definition at line 449 of file JepRoiByteStreamTool.cxx.

{
  const bool debug = msgLvl(MSG::DEBUG);
  if (debug) msg(MSG::DEBUG);
 
  // Loop over ROB fragments
 
  int robCount = 0;
  std::set<uint32_t> dupCheck;
  std::set<uint32_t> dupRoiCheck;
  ROBIterator rob    = robFrags.begin();
  ROBIterator robEnd = robFrags.end();
  for (; rob != robEnd; ++rob) {
 
    if (debug) {
      ++robCount;
      msg() << "Treating ROB fragment " << robCount << endmsg;
    }
 
    // Skip fragments with ROB status errors
 
    uint32_t robid = (*rob)->source_id();
    if ((*rob)->nstatus() > 0) {
      ROBPointer robData;
      (*rob)->status(robData);
      if (*robData != 0) {
        m_errorTool->robError(robid, *robData);
        if (debug) msg() << "ROB status error - skipping fragment" << endmsg;
        continue;
      }
    }
 
    // Skip duplicate fragments
 
    if (!dupCheck.insert(robid).second) {
      m_errorTool->rodError(robid, L1CaloSubBlock::ERROR_DUPLICATE_ROB);
      if (debug) msg() << "Skipping duplicate ROB fragment" << endmsg;
      continue;
    }
 
    // Unpack ROD data (slinks)
 
    RODPointer payloadBeg;
    RODPointer payload;
    RODPointer payloadEnd;
    (*rob)->rod_data(payloadBeg);
    payloadEnd = payloadBeg + (*rob)->rod_ndata();
    payload = payloadBeg;
    if (payload == payloadEnd) {
      if (debug) msg() << "ROB fragment empty" << endmsg;
      continue;
    }
 
    // Check identifier
    const uint32_t sourceID = (*rob)->rod_source_id();
    if (m_srcIdMap.getRobID(sourceID) != robid           ||
        m_srcIdMap.subDet(sourceID)   != m_subDetector   ||
        m_srcIdMap.daqOrRoi(sourceID) != 1               ||
        (m_srcIdMap.slink(sourceID) != 0 && m_srcIdMap.slink(sourceID) != 2) ||
        m_srcIdMap.crate(sourceID)    <  m_crateOffsetHw ||
        m_srcIdMap.crate(sourceID)    >= m_crateOffsetHw + m_crates) {
      m_errorTool->rodError(robid, L1CaloSubBlock::ERROR_ROD_ID);
      if (debug) {
        msg() << "Wrong source identifier in data: "
              << MSG::hex << sourceID << MSG::dec << endmsg;
      }
      continue;
    }
    const int rodCrate = m_srcIdMap.crate(sourceID);
    if (debug) {
      msg() << "Treating crate " << rodCrate
            << " slink " << m_srcIdMap.slink(sourceID) << endmsg;
    }
 
    // First word may be User Header
    if (L1CaloUserHeader::isValid(*payload)) {
      L1CaloUserHeader userHeader(*payload);
      const int minorVersion = (*rob)->rod_version() & 0xffff;
      userHeader.setVersion(minorVersion);
      const int headerWords = userHeader.words();
      if (headerWords != 1) {
        m_errorTool->rodError(robid, L1CaloSubBlock::ERROR_USER_HEADER);
        if (debug) msg() << "Unexpected number of user header words: "
                           << headerWords << endmsg;
        continue;
      }
      for (int i = 0; i < headerWords; ++i) ++payload;
    }
 
    // Loop over sub-blocks if there are any
 
    unsigned int rodErr = L1CaloSubBlock::ERROR_NONE;
    while (payload != payloadEnd) {
 
      if (L1CaloSubBlock::wordType(*payload) == L1CaloSubBlock::HEADER) {
        const int slice = 0;
        if (CmmSubBlock::cmmBlock(*payload)) {
          // CMMs
          if (CmmSubBlock::cmmType(*payload) == CmmSubBlock::CMM_JET) {
            CmmJetSubBlock subBlock;
            payload = subBlock.read(payload, payloadEnd);
            if (cmCollection != nullptr) {
              if (subBlock.dataWords() && !subBlock.unpack()) {
                if (debug) {
                  std::string errMsg(subBlock.unpackErrorMsg());
                  msg() << "CMM-Jet sub-block unpacking failed: "
                        << errMsg << endmsg;
                }
                rodErr = subBlock.unpackErrorCode();
                break;
              }
              const LVL1::CMMRoI roi(subBlock.jetEtMap(slice),
                                     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0);
              cmCollection->setRoiWord(roi.jetEtRoiWord());
            }
          } else {
            CmmEnergySubBlock subBlock;
            payload = subBlock.read(payload, payloadEnd);
            if (cmCollection != nullptr) {
              if (subBlock.dataWords() && !subBlock.unpack()) {
                if (debug) {
                  std::string errMsg(subBlock.unpackErrorMsg());
                  msg() << "CMM-Energy sub-block unpacking failed: "
                        << errMsg << endmsg;
                }
                rodErr = subBlock.unpackErrorCode();
                break;
              }
              const LVL1::CMMRoI roi(0, subBlock.sumEtHits(slice),
                                     subBlock.missingEtHits(slice),
                                     subBlock.missingEtSigHits(slice),
                                     subBlock.ex(slice, CmmEnergySubBlock::TOTAL),
                                     subBlock.ey(slice, CmmEnergySubBlock::TOTAL),
                                     subBlock.et(slice, CmmEnergySubBlock::TOTAL),
                                     0, 0, 0, 0,
                                     subBlock.exError(slice, CmmEnergySubBlock::TOTAL),
                                     subBlock.eyError(slice, CmmEnergySubBlock::TOTAL),
                                     subBlock.etError(slice, CmmEnergySubBlock::TOTAL));
              cmCollection->setRoiWord(roi.energyRoiWord0());
              cmCollection->setRoiWord(roi.energyRoiWord1());
              cmCollection->setRoiWord(roi.energyRoiWord2());
            }
          }
        } else {
          // JEM RoI
          JemRoiSubBlock subBlock;
          payload = subBlock.read(payload, payloadEnd);
          if (jeCollection != nullptr) {
            if (subBlock.dataWords() && !subBlock.unpack()) {
              if (debug) {
                std::string errMsg(subBlock.unpackErrorMsg());
                msg() << "JEM RoI sub-block unpacking failed: "
                      << errMsg << endmsg;
              }
              rodErr = subBlock.unpackErrorCode();
              break;
            }
            for (int frame = 0; frame < 8; ++frame) {
              for (int forward = 0; forward < 2; ++forward) {
                const LVL1::JEMRoI roi = subBlock.roi(frame, forward);
                if (roi.hits() || roi.error()) {
                  jeCollection->push_back(new LVL1::JEMRoI(roi));
                }
              }
            }
          }
        }
      } else {
        // Just RoI word
        LVL1::JEMRoI jroi;
        LVL1::CMMRoI croi;
        if (jroi.setRoiWord(*payload)) {
          if (jeCollection != nullptr) {
            if (jroi.crate() != rodCrate - m_crateOffsetHw) {
              if (debug) msg() << "Inconsistent RoI crate number: "
                                 << jroi.crate() << endmsg;
              rodErr = L1CaloSubBlock::ERROR_CRATE_NUMBER;
              break;
            }
            const uint32_t location = (*payload) & 0xfffc0000;
            if (dupRoiCheck.insert(location).second) {
              if (jroi.hits() || jroi.error()) {
                jeCollection->push_back(new LVL1::JEMRoI(*payload));
              }
            } else {
              if (debug) msg() << "Duplicate RoI word "
                                 << MSG::hex << *payload << MSG::dec << endmsg;
              rodErr = L1CaloSubBlock::ERROR_DUPLICATE_DATA;
              break;
            }
          }
        } else if (croi.setRoiWord(*payload)) {
          if (cmCollection != nullptr) {
            uint32_t roiType = (*payload) & 0xf0000000;
            if ((roiType & 0xe0000000) == 0xa0000000) roiType = 0xa0000000;
            if (dupRoiCheck.insert(roiType).second) {
              cmCollection->setRoiWord(*payload);
            } else {
              if (debug) msg() << "Duplicate RoI word "
                                 << MSG::hex << *payload << MSG::dec << endmsg;
              rodErr = L1CaloSubBlock::ERROR_DUPLICATE_DATA;
              break;
            }
          }
        } else {
          if (debug) msg() << "Invalid RoI word "
                             << MSG::hex << *payload << MSG::dec << endmsg;
          rodErr = L1CaloSubBlock::ERROR_ROI_TYPE;
          break;
        }
        ++payload;
      }
    }
    if (rodErr != L1CaloSubBlock::ERROR_NONE)
      m_errorTool->rodError(robid, rodErr);
  }
 
  return StatusCode::SUCCESS;
}

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ finalize()

StatusCode LVL1BS::JepRoiByteStreamTool::finalize ( )

overridevirtual

Definition at line 99 of file JepRoiByteStreamTool.cxx.

{
  return StatusCode::SUCCESS;
}

◆ findCmmHits()

const LVL1::CMMJetHits * LVL1BS::JepRoiByteStreamTool::findCmmHits	(	int	crate,
		int	dataID,
		const CmmHitsMap &	cmmHitsMap ) const

private

Find CMM hits for given crate, data ID.

Definition at line 674 of file JepRoiByteStreamTool.cxx.

{
  const LVL1::CMMJetHits* hits = 0;
  CmmHitsMap::const_iterator mapIter;
  mapIter = cmmHitsMap.find(crate * 100 + dataID);
  if (mapIter != cmmHitsMap.end()) hits = mapIter->second;
  return hits;
}

◆ findCmmSums()

const LVL1::CMMEtSums * LVL1BS::JepRoiByteStreamTool::findCmmSums	(	int	crate,
		int	dataID,
		const CmmSumsMap &	cmmEtMap ) const

private

Find CMM energy sums for given crate, data ID.

Definition at line 687 of file JepRoiByteStreamTool.cxx.

{
  const LVL1::CMMEtSums* sums = 0;
  CmmSumsMap::const_iterator mapIter;
  mapIter = cmmEtMap.find(crate * 100 + dataID);
  if (mapIter != cmmEtMap.end()) sums = mapIter->second;
  return sums;
}

◆ initialize()

StatusCode LVL1BS::JepRoiByteStreamTool::initialize ( )

overridevirtual

Definition at line 87 of file JepRoiByteStreamTool.cxx.

{
  ATH_MSG_INFO( "Initializing " << name());
 
  ATH_CHECK( m_errorTool.retrieve() );
  ATH_CHECK( m_byteStreamCnvSvc.retrieve() );
 
  return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ interfaceID()

const InterfaceID & LVL1BS::JepRoiByteStreamTool::interfaceID ( )

static

AlgTool InterfaceID.

Definition at line 40 of file JepRoiByteStreamTool.cxx.

{
  return IID_IJepRoiByteStreamTool;
}

◆ makeSourceIDs()

std::vector< uint32_t > LVL1BS::JepRoiByteStreamTool::makeSourceIDs ( bool roiDaq ) const

private

Definition at line 395 of file JepRoiByteStreamTool.cxx.

{
  std::vector<uint32_t> sourceIDs;
 
  if (roiDaq) {
    sourceIDs = m_sourceIDsProp;
  }
  else {
    sourceIDs = m_sourceIDsRoIBProp;
  }
 
  if (sourceIDs.empty()) {
        const int maxCrates = m_crates + m_crateOffsetHw;
        const int maxSlinks = m_srcIdMap.maxSlinks();
        for (int hwCrate = m_crateOffsetHw; hwCrate < maxCrates; ++hwCrate)
        {
            for (int slink = 0; slink < maxSlinks; ++slink)
            {
                const int daqOrRoi = 1;
                const uint32_t rodId = m_srcIdMap.getRodID(hwCrate, slink, daqOrRoi,
                                       m_subDetector);
                const uint32_t robId = m_srcIdMap.getRobID(rodId);
                if (roiDaq)
                {
                    if (slink < 2) sourceIDs.push_back(robId);
                }
                else if (slink >= 2) sourceIDs.push_back(robId);
            }
        }
 
  }
  return sourceIDs;
}

◆ msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ setupCmmEtMap()

void LVL1BS::JepRoiByteStreamTool::setupCmmEtMap	(	const CmmSumsCollection *	enCollection,
		CmmSumsMap &	cmmEtMap ) const

private

Set up CMM energy sums map.

Definition at line 737 of file JepRoiByteStreamTool.cxx.

{
  cmmEtMap.clear();
  if (etCollection) {
    CmmSumsCollection::const_iterator pos  = etCollection->begin();
    CmmSumsCollection::const_iterator pose = etCollection->end();
    for (; pos != pose; ++pos) {
      const LVL1::CMMEtSums* const sums = *pos;
      const int crate = sums->crate() - m_crateOffsetSw;
      const int key   = crate * 100 + sums->dataID();
      cmmEtMap.insert(std::make_pair(key, sums));
    }
  }
}

◆ setupCmmHitsMap()

void LVL1BS::JepRoiByteStreamTool::setupCmmHitsMap	(	const CmmHitsCollection *	hitCollection,
		CmmHitsMap &	cmmHitsMap ) const

private

Set up CMM hits map.

Definition at line 718 of file JepRoiByteStreamTool.cxx.

{
  cmmHitsMap.clear();
  if (hitCollection) {
    CmmHitsCollection::const_iterator pos  = hitCollection->begin();
    CmmHitsCollection::const_iterator pose = hitCollection->end();
    for (; pos != pose; ++pos) {
      const LVL1::CMMJetHits* const hits = *pos;
      const int crate = hits->crate() - m_crateOffsetSw;
      const int key   = crate * 100 + hits->dataID();
      cmmHitsMap.insert(std::make_pair(key, hits));
    }
  }
}

◆ setupJemRoiMap()

void LVL1BS::JepRoiByteStreamTool::setupJemRoiMap	(	const JemRoiCollection *	jeCollection,
		JemRoiMap &	roiMap ) const

private

Set up JEM RoIs map.

Definition at line 700 of file JepRoiByteStreamTool.cxx.

{
  roiMap.clear();
  if (jeCollection) {
    JemRoiCollection::const_iterator pos  = jeCollection->begin();
    JemRoiCollection::const_iterator pose = jeCollection->end();
    for (; pos != pose; ++pos) {
      const LVL1::JEMRoI* const roi = *pos;
      const uint32_t key = roi->roiWord();
      roiMap.insert(std::make_pair(key, roi));
    }
  }
}

◆ sourceIDs()

const std::vector< uint32_t > & LVL1BS::JepRoiByteStreamTool::sourceIDs ( const std::string & sgKey ) const

Return reference to vector with all possible Source Identifiers.

Definition at line 429 of file JepRoiByteStreamTool.cxx.

{
  const std::string flag("RoIB");
  const std::string::size_type pos = sgKey.find(flag);
  const bool roiDaq =
    (pos == std::string::npos || pos != sgKey.length() - flag.length());
 
  if (roiDaq) {
    static const std::vector<uint32_t> sourceIDs = makeSourceIDs(roiDaq);
    return sourceIDs;
  }
  else {
    static const std::vector<uint32_t> sourceIDsRoIB = makeSourceIDs(roiDaq);
    return sourceIDsRoIB;
  }
}

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_byteStreamCnvSvc

ServiceHandle<IByteStreamCnvSvc> LVL1BS::JepRoiByteStreamTool::m_byteStreamCnvSvc { this, "ByteStreamCnvSvc", "ByteStreamCnvSvc" }

private

Definition at line 80 of file JepRoiByteStreamTool.h.

81{ this, "ByteStreamCnvSvc", "ByteStreamCnvSvc" };

◆ m_crateOffsetHw

int LVL1BS::JepRoiByteStreamTool::m_crateOffsetHw

private

Property: Hardware crate number offset.

Definition at line 121 of file JepRoiByteStreamTool.h.

◆ m_crateOffsetSw

int LVL1BS::JepRoiByteStreamTool::m_crateOffsetSw

private

Property: Software crate number offset.

Definition at line 123 of file JepRoiByteStreamTool.h.

◆ m_crates

const int LVL1BS::JepRoiByteStreamTool::m_crates

private

Number of crates.

Definition at line 129 of file JepRoiByteStreamTool.h.

◆ m_dataFormat

int LVL1BS::JepRoiByteStreamTool::m_dataFormat

private

Property: Data compression format.

Definition at line 127 of file JepRoiByteStreamTool.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_errorTool

ToolHandle<LVL1BS::L1CaloErrorByteStreamTool> LVL1BS::JepRoiByteStreamTool::m_errorTool

private

Error collection tool.

Definition at line 99 of file JepRoiByteStreamTool.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_modules

const int LVL1BS::JepRoiByteStreamTool::m_modules

private

Number of JEM modules per crate.

Definition at line 131 of file JepRoiByteStreamTool.h.

◆ m_slinks

int LVL1BS::JepRoiByteStreamTool::m_slinks

private

Property: Number of slinks per crate when writing out bytestream.

Definition at line 133 of file JepRoiByteStreamTool.h.

◆ m_sourceIDsProp

std::vector<uint32_t> LVL1BS::JepRoiByteStreamTool::m_sourceIDsProp

private

Property: ROB source IDs.

Definition at line 135 of file JepRoiByteStreamTool.h.

◆ m_sourceIDsRoIBProp

std::vector<uint32_t> LVL1BS::JepRoiByteStreamTool::m_sourceIDsRoIBProp

private

Property: ROB source IDs for RoIB.

Definition at line 137 of file JepRoiByteStreamTool.h.

◆ m_srcIdMap

const L1CaloSrcIdMap LVL1BS::JepRoiByteStreamTool::m_srcIdMap

private

Source ID converter.

Definition at line 141 of file JepRoiByteStreamTool.h.

◆ m_subDetector

const eformat::SubDetector LVL1BS::JepRoiByteStreamTool::m_subDetector

private

Sub-detector type.

Definition at line 139 of file JepRoiByteStreamTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_version

int LVL1BS::JepRoiByteStreamTool::m_version

private

Property: Sub_block header version.

Definition at line 125 of file JepRoiByteStreamTool.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CmmHitsCollection

◆ CmmHitsMap

◆ CmmSumsCollection

◆ CmmSumsMap

◆ JemRoiCollection

◆ JemRoiMap

◆ ROBIterator

◆ ROBPointer

◆ RODPointer

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ JepRoiByteStreamTool()

◆ ~JepRoiByteStreamTool()

Member Function Documentation

◆ convert() [1/3]

◆ convert() [2/3]

◆ convert() [3/3]

◆ convertBs()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ findCmmHits()

◆ findCmmSums()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ makeSourceIDs()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setupCmmEtMap()

◆ setupCmmHitsMap()

◆ setupJemRoiMap()

◆ sourceIDs()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_byteStreamCnvSvc

◆ m_crateOffsetHw

◆ m_crateOffsetSw

◆ m_crates

◆ m_dataFormat

◆ m_detStore

◆ m_errorTool

◆ m_evtStore

◆ m_modules

◆ m_slinks

◆ m_sourceIDsProp

◆ m_sourceIDsRoIBProp

◆ m_srcIdMap

◆ m_subDetector

◆ m_varHandleArraysDeclared

◆ m_version

◆ m_vhka