A tool to decode MM ROB fragments into MM RDO (based on the sTGC tool). More...

#include <MM_RawDataProviderTool.h>

Inheritance diagram for Muon::MM_RawDataProviderTool:

Collaboration diagram for Muon::MM_RawDataProviderTool:

Public Member Functions
virtual	~MM_RawDataProviderTool ()=default
	Default destructor.
virtual StatusCode	initialize () override
	Standard AlgTool method.
virtual StatusCode	convert (const EventContext &) const override
virtual StatusCode	convert (const std::vector< IdentifierHash > &, const EventContext &) const override
virtual StatusCode	convert (const std::vector< uint32_t > &, const EventContext &) const override

Protected Member Functions
virtual StatusCode	convertIntoContainer (const EventContext &ctx, const ROBFragmentList &, const std::vector< IdentifierHash > &, MM_RawDataContainer &) const
	Method that converts the ROBFragments into the passed container.
StatusCode	initRdoContainer (const EventContext &, MM_RawDataContainer *&) const

Protected Attributes
ServiceHandle< Muon::IMuonIdHelperSvc >	m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}
	The ID helper.
ToolHandle< IMM_ROD_Decoder >	m_decoder {this, "Decoder", "Muon::MmROD_Decoder/MmROD_Decoder"}
	Decoder for ROB fragment RDO conversion.
SG::WriteHandleKey< MM_RawDataContainer >	m_rdoContainerKey { this, "RdoLocation", "MMRDO", "Name of the MMRDO produced by RawDataProvider"}
	RDO container key.
unsigned int	m_maxhashtoUse {0}
ServiceHandle< IROBDataProviderSvc >	m_robDataProvider {this, "ROBDataProviderSvc", "ROBDataProviderSvc"}
Gaudi::Property< bool >	m_skipDecoding {this, "SkipDecoding", false, "Skip the decoding but still write the container"}
	Flag to skip decoding and write empty container.
std::vector< uint32_t >	m_allRobIds
SG::UpdateHandleKey< MM_RawDataCollection_Cache >	m_rdoContainerCacheKey

Detailed Description

A tool to decode MM ROB fragments into MM RDO (based on the sTGC tool).

Author: Leonidas Fountas leoni.nosp@m.das..nosp@m.fount.nosp@m.as@c.nosp@m.ern.c.nosp@m.h

Definition at line 29 of file MM_RawDataProviderTool.h.

Constructor & Destructor Documentation

◆ ~MM_RawDataProviderTool()

virtual Muon::MM_RawDataProviderTool::~MM_RawDataProviderTool ( )

virtualdefault

Default destructor.

Member Function Documentation

◆ convert() [1/3]

StatusCode Muon::MM_RawDataProviderTool::convert ( const EventContext & ctx ) const

overridevirtual

Definition at line 154 of file MM_RawDataProviderTool.cxx.

{
  // method for unseeded mode. just decode everything.
 
  MM_RawDataContainer* rdoContainer{nullptr};
  ATH_CHECK(initRdoContainer(ctx, rdoContainer));
  if(m_skipDecoding) return StatusCode::SUCCESS;
 
  ROBFragmentList vecRobf;
  m_robDataProvider->getROBData(ctx, m_allRobIds, vecRobf);
  
  // dummy hashID vector for the decoder (empty = unseeded mode)
  const std::vector<IdentifierHash> rdoIdhVect;
 
  return convertIntoContainer(ctx, vecRobf, rdoIdhVect, *rdoContainer);
}

◆ convert() [2/3]

StatusCode Muon::MM_RawDataProviderTool::convert	(	const std::vector< IdentifierHash > &	rdoIdhVect,
		const EventContext &	ctx ) const

overridevirtual

Definition at line 137 of file MM_RawDataProviderTool.cxx.

{
  // method for RoI-seeded mode via hash IDs. we don't let empty hash containers reach the decoder, 
  // since an empty container means unseeded mode (decode everything).
 
  MM_RawDataContainer* rdoContainer{nullptr};
  ATH_CHECK(initRdoContainer(ctx, rdoContainer));
 
  if (rdoIdhVect.empty() || m_skipDecoding) return StatusCode::SUCCESS;
  
  ROBFragmentList vecRobf;
  m_robDataProvider->getROBData(ctx, m_allRobIds, vecRobf);
 
  return convertIntoContainer(ctx, vecRobf, rdoIdhVect, *rdoContainer);
}

◆ convert() [3/3]

StatusCode Muon::MM_RawDataProviderTool::convert	(	const std::vector< uint32_t > &	robIds,
		const EventContext &	ctx ) const

overridevirtual

Definition at line 121 of file MM_RawDataProviderTool.cxx.

                                                                                                               {
  // method for RoI-seeded mode via ROB IDs
  MM_RawDataContainer* rdoContainer{nullptr};
  ATH_CHECK(initRdoContainer(ctx, rdoContainer));
 
  if (robIds.empty() || m_skipDecoding) return StatusCode::SUCCESS;
  
  ROBFragmentList vecRobf;
  m_robDataProvider->getROBData(ctx, robIds, vecRobf);
 
  // pass empty list of ID hashes, every ROB ID in list will be decoded
  const std::vector<IdentifierHash> hashIDList;
  return convertIntoContainer(ctx, vecRobf, hashIDList, *rdoContainer);
}

◆ convertIntoContainer()

StatusCode Muon::MM_RawDataProviderTool::convertIntoContainer	(	const EventContext &	ctx,
		const ROBFragmentList &	,
		const std::vector< IdentifierHash > &	,
		MM_RawDataContainer &	) const

protectedvirtual

Method that converts the ROBFragments into the passed container.

Definition at line 55 of file MM_RawDataProviderTool.cxx.

{
  // Since there can be multiple ROBFragments contributing to the same RDO collection a temporary cache is setup and passed to fillCollection by reference. Once all ROBFragments are processed the collections are added into the rdo container
 
  std::unordered_map<IdentifierHash, std::unique_ptr<MM_RawDataCollection>> rdo_map;
 
  // Loop on the passed ROB fragments, and call the decoder for each one to fill the RDO container.
  for (const ROBFragment* fragment : vecRobs)
    ATH_CHECK( m_decoder->fillCollection(ctx, *fragment, rdoIdhVect, rdo_map) ); // always returns StatusCode::SUCCESS
 
  // error counters
  int nerr_duplicate{0}, nerr_rdo{0};
 
  // add the RDO collections created from the data of this ROB into the identifiable container.
  for (auto& [hash, collection]: rdo_map) {
 
    if ((!collection) or collection->empty()) continue; // skip empty collections
 
    MM_RawDataContainer::IDC_WriteHandle lock = mmRdoContainer.getWriteHandle(hash);
 
    if (lock.alreadyPresent()) {
      ++nerr_duplicate;
    } else if (!lock.addOrDelete(std::move(collection)).isSuccess()) {
      // since we prevent duplicates above, this error should never happen.
      ++nerr_rdo;
    }
  }
 
  // error summary (to reduce the number of messages)
  if (nerr_duplicate) ATH_MSG_WARNING(nerr_duplicate << " elinks skipped since the same module hash has been added by a previous ROB fragment");
  if (nerr_rdo){
     ATH_MSG_ERROR("Failed to add "<<nerr_rdo<<" RDOs into the identifiable container");
     return StatusCode::FAILURE;
  }
 
  ATH_MSG_DEBUG("Size of mmRdoContainer is " << mmRdoContainer.size());
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode Muon::MM_RawDataProviderTool::initialize ( )

overridevirtual

Standard AlgTool method.

Definition at line 18 of file MM_RawDataProviderTool.cxx.

{
  ATH_CHECK(m_idHelperSvc.retrieve());
  ATH_CHECK(m_decoder.retrieve());
  ATH_CHECK(m_robDataProvider.retrieve());
  ATH_CHECK(m_rdoContainerKey.initialize());
 
  m_maxhashtoUse = m_idHelperSvc->mmIdHelper().module_hash_max();  
 
  // generate all the Source Identifiers for MicroMegas to request the fragments.
  // assume 16 RODs per side (one per sector) and that ROB ID = ROD ID.
  for (uint32_t detID : {eformat::MUON_MMEGA_ENDCAP_A_SIDE, eformat::MUON_MMEGA_ENDCAP_C_SIDE}) { //0x6B, 0x6C
    for (uint8_t sectorID(0); sectorID < 16; ++sectorID) {
       // for now lets build all the possible ROB ids of all possible readout configurations
       // maybe later we can come up with a smart way to detect which readout sheme is running and only request the relevant ROB ids from the ROBDataProviderSvc
 
       uint16_t moduleID = (0x0 << 8) | sectorID; // combined/single ROB
       SourceIdentifier sid(static_cast<eformat::SubDetector>(detID), moduleID);
       m_allRobIds.push_back(sid.simple_code());
       
       moduleID = (0x1 << 8) | sectorID; // full device ROB (split configuration)
       sid = SourceIdentifier(static_cast<eformat::SubDetector>(detID), moduleID);
       m_allRobIds.push_back(sid.simple_code());
       
       moduleID = (0x2 << 8) | sectorID; // shared device ROB (split configuration)
       sid = SourceIdentifier(static_cast<eformat::SubDetector>(detID), moduleID);
       m_allRobIds.push_back(sid.simple_code());
    }
  }
 
  ATH_CHECK(m_rdoContainerCacheKey.initialize(!m_rdoContainerCacheKey.key().empty()));
 
  return StatusCode::SUCCESS;
}

◆ initRdoContainer()

StatusCode Muon::MM_RawDataProviderTool::initRdoContainer	(	const EventContext &	ctx,
		MM_RawDataContainer *&	rdoContainer ) const

protected

Definition at line 95 of file MM_RawDataProviderTool.cxx.

{
  // Create the identifiable RdoContainer in StoreGate to be filled with decoded fragment contents.
  SG::WriteHandle<MM_RawDataContainer> rdoContainerHandle(m_rdoContainerKey, ctx); 
 
  const bool externalCacheRDO = !m_rdoContainerCacheKey.key().empty();
  if(!externalCacheRDO){
    ATH_CHECK(rdoContainerHandle.record(std::make_unique<MM_RawDataContainer>(m_maxhashtoUse)));
    ATH_MSG_DEBUG("Created MM container");
  } else {
    SG::UpdateHandle<MM_RawDataCollection_Cache> update(m_rdoContainerCacheKey, ctx);
    ATH_CHECK(update.isValid());
    ATH_CHECK(rdoContainerHandle.record(std::make_unique<MM_RawDataContainer>(update.ptr())));
    ATH_MSG_DEBUG("Created MM container using cache for " << m_rdoContainerCacheKey.key());
  }
 
  // this should never happen, but since we dereference the pointer, we should check
  if (!(rdoContainer = rdoContainerHandle.ptr())) {
    ATH_MSG_ERROR("the MM RDO container is null, cannot decode MM data");
    return StatusCode::FAILURE;
  }
 
  return StatusCode::SUCCESS;
}

Member Data Documentation

◆ m_allRobIds

std::vector<uint32_t> Muon::MM_RawDataProviderTool::m_allRobIds

protected

Definition at line 71 of file MM_RawDataProviderTool.h.

◆ m_decoder

ToolHandle<IMM_ROD_Decoder> Muon::MM_RawDataProviderTool::m_decoder {this, "Decoder", "Muon::MmROD_Decoder/MmROD_Decoder"}

protected

Decoder for ROB fragment RDO conversion.

Definition at line 57 of file MM_RawDataProviderTool.h.

57{this, "Decoder", "Muon::MmROD_Decoder/MmROD_Decoder"};

◆ m_idHelperSvc

ServiceHandle<Muon::IMuonIdHelperSvc> Muon::MM_RawDataProviderTool::m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}

protected

The ID helper.

Definition at line 54 of file MM_RawDataProviderTool.h.

54{this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"};

◆ m_maxhashtoUse

unsigned int Muon::MM_RawDataProviderTool::m_maxhashtoUse {0}

protected

Definition at line 62 of file MM_RawDataProviderTool.h.

62{0};

◆ m_rdoContainerCacheKey

SG::UpdateHandleKey<MM_RawDataCollection_Cache> Muon::MM_RawDataProviderTool::m_rdoContainerCacheKey

protected

Initial value:

{this, "MmContainerCacheKey",

"", "Optional external cache for the MM container"}

Definition at line 74 of file MM_RawDataProviderTool.h.

74 {this, "MmContainerCacheKey",

75 "", "Optional external cache for the MM container"};

◆ m_rdoContainerKey

SG::WriteHandleKey<MM_RawDataContainer> Muon::MM_RawDataProviderTool::m_rdoContainerKey { this, "RdoLocation", "MMRDO", "Name of the MMRDO produced by RawDataProvider"}

protected

RDO container key.

Definition at line 60 of file MM_RawDataProviderTool.h.

60{ this, "RdoLocation", "MMRDO", "Name of the MMRDO produced by RawDataProvider"};

◆ m_robDataProvider

ServiceHandle<IROBDataProviderSvc> Muon::MM_RawDataProviderTool::m_robDataProvider {this, "ROBDataProviderSvc", "ROBDataProviderSvc"}

protected

Definition at line 65 of file MM_RawDataProviderTool.h.

65{this, "ROBDataProviderSvc", "ROBDataProviderSvc"};

◆ m_skipDecoding

Gaudi::Property<bool> Muon::MM_RawDataProviderTool::m_skipDecoding {this, "SkipDecoding", false, "Skip the decoding but still write the container"}

protected

Flag to skip decoding and write empty container.

Definition at line 69 of file MM_RawDataProviderTool.h.

69{this, "SkipDecoding", false, "Skip the decoding but still write the container"};

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~MM_RawDataProviderTool()

Member Function Documentation

◆ convert() [1/3]

◆ convert() [2/3]

◆ convert() [3/3]

◆ convertIntoContainer()

◆ initialize()

◆ initRdoContainer()

Member Data Documentation

◆ m_allRobIds

◆ m_decoder

◆ m_idHelperSvc

◆ m_maxhashtoUse

◆ m_rdoContainerCacheKey

◆ m_rdoContainerKey

◆ m_robDataProvider

◆ m_skipDecoding