A tool to decode STGC ROB fragments into STGC RDO (based on the TGC tool). More...

#include <STGC_RawDataProviderTool.h>

Inheritance diagram for Muon::STGC_RawDataProviderTool:

Collaboration diagram for Muon::STGC_RawDataProviderTool:

Public Member Functions
virtual	~STGC_RawDataProviderTool ()=default
	Default destructor.
virtual StatusCode	initialize () override
	Standard AlgTool method.
virtual StatusCode	convert (const EventContext &ctx) const override
virtual StatusCode	convert (const std::vector< IdentifierHash > &chamberHashes, const EventContext &ctx) const override
virtual StatusCode	convert (const std::vector< uint32_t > &robIDs, const EventContext &ctx) const override
virtual StatusCode	convert (const ROBFragmentList &) const
virtual StatusCode	convert (const ROBFragmentList &, const std::vector< IdentifierHash > &) const
virtual StatusCode	convert () const
	the new ones
virtual StatusCode	convert (const std::vector< IdentifierHash > &) const
	for a selection of rdo collections
virtual StatusCode	convert (const std::vector< uint32_t > &) const
virtual StatusCode	convert (const ROBFragmentList &, const EventContext &) const
virtual StatusCode	convert (const ROBFragmentList &, const std::vector< IdentifierHash > &, const EventContext &) const

Private Member Functions
StatusCode	convertIntoContainer (const EventContext &ctx, const ROBFragmentList &fragements, const std::vector< IdentifierHash > &chamberHashes, STGC_RawDataContainer &target) const
	Method that converts the ROBFragments into the passed container.
StatusCode	initRdoContainer (const EventContext &, STGC_RawDataContainer *&) const

Private Attributes
ServiceHandle< Muon::IMuonIdHelperSvc >	m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}
	The ID helper.
ToolHandle< ISTGC_ROD_Decoder >	m_decoder {this, "Decoder", "Muon::STGC_ROD_Decoder/STGC_ROD_Decoder"}
	Decoder for ROB fragment RDO conversion.
SG::WriteHandleKey< STGC_RawDataContainer >	m_rdoContainerKey { this, "RdoLocation", "sTGCRDO", "Name of the sTGCRDO produced by RawDataProvider"}
	RDO container key.
unsigned int	m_maxhashtoUse {0}
ServiceHandle< IROBDataProviderSvc >	m_robDataProvider {this, "RobProviderSvc", "ROBDataProviderSvc"}
	Rob Data Provider handle.
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< STGC_RawDataCollection_Cache >	m_rdoContainerCacheKey

Detailed Description

A tool to decode STGC ROB fragments into STGC RDO (based on the TGC tool).

Author: Stelios Angelidakis sange.nosp@m.lid@.nosp@m.cern..nosp@m.ch

Definition at line 24 of file STGC_RawDataProviderTool.h.

Constructor & Destructor Documentation

◆ ~STGC_RawDataProviderTool()

virtual Muon::STGC_RawDataProviderTool::~STGC_RawDataProviderTool ( )

virtualdefault

Default destructor.

Member Function Documentation

◆ convert() [1/10]

virtual StatusCode Muon::IMuonRawDataProviderTool::convert ( ) const

inline

the new ones

for the entire event

Definition at line 31 of file IMuonRawDataProviderTool.h.

◆ convert() [2/10]

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

overridevirtual

Definition at line 147 of file STGC_RawDataProviderTool.cxx.

                                                                               {
  // method for unseeded mode. just decode everything.
 
  STGC_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() [3/10]

virtual StatusCode Muon::IMuonRawDataProviderTool::convert ( const ROBFragmentList & ) const

inline

Definition at line 28 of file IMuonRawDataProviderTool.h.

28{ return StatusCode::FAILURE; }

◆ convert() [4/10]

virtual StatusCode Muon::IMuonRawDataProviderTool::convert	(	const ROBFragmentList &	,
		const EventContext &	) const

inline

Definition at line 36 of file IMuonRawDataProviderTool.h.

36{return StatusCode::FAILURE;}

◆ convert() [5/10]

virtual StatusCode Muon::IMuonRawDataProviderTool::convert	(	const ROBFragmentList &	,
		const std::vector< IdentifierHash > &	) const

inline

Definition at line 29 of file IMuonRawDataProviderTool.h.

29{ return StatusCode::FAILURE; }

◆ convert() [6/10]

virtual StatusCode Muon::IMuonRawDataProviderTool::convert	(	const ROBFragmentList &	,
		const std::vector< IdentifierHash > &	,
		const EventContext &	) const

inline

Definition at line 37 of file IMuonRawDataProviderTool.h.

37{return StatusCode::FAILURE;}

◆ convert() [7/10]

virtual StatusCode Muon::IMuonRawDataProviderTool::convert ( const std::vector< IdentifierHash > & ) const

inline

for a selection of rdo collections

Definition at line 32 of file IMuonRawDataProviderTool.h.

◆ convert() [8/10]

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

overridevirtual

Definition at line 129 of file STGC_RawDataProviderTool.cxx.

{
  // method for RoI-seeded mode. we don't let empty hash containers reach the decoder, 
  // since an empty container means unseeded mode (decode everything).
 
  STGC_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() [9/10]

virtual StatusCode Muon::IMuonRawDataProviderTool::convert ( const std::vector< uint32_t > & ) const

inline

Definition at line 33 of file IMuonRawDataProviderTool.h.

33{return StatusCode::FAILURE;}

◆ convert() [10/10]

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

overridevirtual

Definition at line 163 of file STGC_RawDataProviderTool.cxx.

{
  STGC_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::STGC_RawDataProviderTool::convertIntoContainer	(	const EventContext &	ctx,
		const ROBFragmentList &	fragements,
		const std::vector< IdentifierHash > &	chamberHashes,
		STGC_RawDataContainer &	target ) const

private

Method that converts the ROBFragments into the passed container.

Definition at line 56 of file STGC_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<STGC_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
 
    STGC_RawDataContainer::IDC_WriteHandle lock = stgcRdoContainer.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 sTgcRdoContainer is " << stgcRdoContainer.size());
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode Muon::STGC_RawDataProviderTool::initialize ( )

overridevirtual

Standard AlgTool method.

Definition at line 15 of file STGC_RawDataProviderTool.cxx.

                                                    {
 
 
  ATH_CHECK(m_idHelperSvc.retrieve());
  ATH_CHECK(m_decoder.retrieve());
  ATH_CHECK(m_robDataProvider.retrieve()); // ROBDataProviderSvc
  ATH_CHECK(m_rdoContainerKey.initialize());
 
  m_maxhashtoUse = m_idHelperSvc->stgcIdHelper().module_hash_max();  
  // generate all the Source Identifiers to request the fragments.
  // assume 16 RODs per side (one per sector) and that ROB ID = ROD ID.
  for (uint32_t detID : {eformat::MUON_STGC_ENDCAP_A_SIDE, eformat::MUON_STGC_ENDCAP_C_SIDE}) { //0x6D, 0x6E
    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
       // reference: slide 6 of https://indico.cern.ch/event/1260377/contributions/5294286/attachments/2603399/4495810/NSW-SwRod-Felix-v3.pdf
 
       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());
       
       moduleID = (0x3 << 8) | sectorID; // spare 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::STGC_RawDataProviderTool::initRdoContainer	(	const EventContext &	ctx,
		STGC_RawDataContainer *&	rdoContainer ) const

private

Definition at line 102 of file STGC_RawDataProviderTool.cxx.

{
  // Create the identifiable RdoContainer in StoreGate to be filled with decoded fragment contents.
  SG::WriteHandle rdoContainerHandle(m_rdoContainerKey, ctx); 
 
  const bool externalCacheRDO = !m_rdoContainerCacheKey.key().empty();
  if(!externalCacheRDO){
    ATH_CHECK(rdoContainerHandle.record(std::make_unique<STGC_RawDataContainer>(m_maxhashtoUse)));
    ATH_MSG_DEBUG("Created STGC RDO container");
  } else {
    SG::UpdateHandle<STGC_RawDataCollection_Cache> update(m_rdoContainerCacheKey, ctx);
    ATH_CHECK(update.isValid());
    ATH_CHECK(rdoContainerHandle.record(std::make_unique<STGC_RawDataContainer>(update.ptr())));
    ATH_MSG_DEBUG("Created STGC RDO 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 STGC RDO container is null, cannot decode STGC data");
    return StatusCode::FAILURE;
  }
 
  return StatusCode::SUCCESS;
}

Member Data Documentation

◆ m_allRobIds

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

private

Definition at line 68 of file STGC_RawDataProviderTool.h.

◆ m_decoder

ToolHandle<ISTGC_ROD_Decoder> Muon::STGC_RawDataProviderTool::m_decoder {this, "Decoder", "Muon::STGC_ROD_Decoder/STGC_ROD_Decoder"}

private

Decoder for ROB fragment RDO conversion.

Definition at line 53 of file STGC_RawDataProviderTool.h.

53{this, "Decoder", "Muon::STGC_ROD_Decoder/STGC_ROD_Decoder"};

◆ m_idHelperSvc

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

private

The ID helper.

Definition at line 50 of file STGC_RawDataProviderTool.h.

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

◆ m_maxhashtoUse

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

private

Definition at line 58 of file STGC_RawDataProviderTool.h.

58{0}; //MT

◆ m_rdoContainerCacheKey

SG::UpdateHandleKey<STGC_RawDataCollection_Cache> Muon::STGC_RawDataProviderTool::m_rdoContainerCacheKey

private

Initial value:

{this, "sTgcContainerCacheKey", "" ,

"Optional external cache for the sTGC container"}

Definition at line 70 of file STGC_RawDataProviderTool.h.

70 {this, "sTgcContainerCacheKey", "" ,

71 "Optional external cache for the sTGC container"};

◆ m_rdoContainerKey

SG::WriteHandleKey<STGC_RawDataContainer> Muon::STGC_RawDataProviderTool::m_rdoContainerKey { this, "RdoLocation", "sTGCRDO", "Name of the sTGCRDO produced by RawDataProvider"}

private

RDO container key.

Definition at line 56 of file STGC_RawDataProviderTool.h.

56{ this, "RdoLocation", "sTGCRDO", "Name of the sTGCRDO produced by RawDataProvider"}; //MT

◆ m_robDataProvider

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

private

Rob Data Provider handle.

Definition at line 61 of file STGC_RawDataProviderTool.h.

61{this, "RobProviderSvc", "ROBDataProviderSvc"};

◆ m_skipDecoding

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

private

Flag to skip decoding and write empty container.

Definition at line 64 of file STGC_RawDataProviderTool.h.

64{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

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~STGC_RawDataProviderTool()

Member Function Documentation

◆ convert() [1/10]

◆ convert() [2/10]

◆ convert() [3/10]

◆ convert() [4/10]

◆ convert() [5/10]

◆ convert() [6/10]

◆ convert() [7/10]

◆ convert() [8/10]

◆ convert() [9/10]

◆ convert() [10/10]

◆ convertIntoContainer()

◆ initialize()

◆ initRdoContainer()

Member Data Documentation

◆ m_allRobIds

◆ m_decoder

◆ m_idHelperSvc

◆ m_maxhashtoUse

◆ m_rdoContainerCacheKey

◆ m_rdoContainerKey

◆ m_robDataProvider

◆ m_skipDecoding