ITkStripRawDataProvider.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#include "ITkStripRawDataProvider.h"
#include "ITkStripsByteStreamCnv/IITkStripRawDataProviderTool.h"
#include "ITkStripCabling/IITkStripCablingTool.h"
#include "InDetIdentifier/SCT_ID.h"
#include "EventContainers/IdentifiableContTemp.h"
#include "EventContainers/IdentifiableContainerBase.h"
 
#include <memory>
 
using OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment;
 
 
// Initialize
 
StatusCode ITkStripRawDataProvider::initialize()
{
  // Get ROBDataProviderSvc
  ATH_CHECK(m_robDataProvider.retrieve());
 
  // Get the SCT ID helper
  ATH_CHECK(detStore()->retrieve(m_sctID, "SCT_ID"));
  if (m_roiSeeded.value()) {
    // Don't need SCT cabling if running in RoI-seeded mode
    ATH_CHECK(m_roiCollectionKey.initialize());
    ATH_CHECK(m_regionSelector.retrieve());
    m_cabling.disable();
  }
  else {
    //Disable Roi requirement
    ATH_CHECK(m_roiCollectionKey.initialize(false));
    // Retrieve Cabling tool
    ATH_CHECK(m_cabling.retrieve());
    m_regionSelector.disable();
  }
 
  //Initialize
  ATH_CHECK(m_rdoContainerKey.initialize());
  ATH_CHECK(m_lvl1CollectionKey.initialize(m_storeInDetTimeColls));
  ATH_CHECK(m_bcIDCollectionKey.initialize(m_storeInDetTimeColls));
  ATH_CHECK(m_bsIDCErrContainerKey.initialize());
  ATH_CHECK(m_rdoContainerCacheKey.initialize(!m_rdoContainerCacheKey.key().empty()));
  ATH_CHECK(m_bsErrContainerCacheKey.initialize(!m_bsErrContainerCacheKey.key().empty()));
 
  ATH_CHECK( m_rawDataTool.retrieve() );
 
  return StatusCode::SUCCESS;
}
 
// Execute
 
StatusCode ITkStripRawDataProvider::execute(const EventContext& ctx) const
{
  SG::WriteHandle<SCT_RDO_Container> rdoContainer(m_rdoContainerKey, ctx);
  bool externalCacheRDO = !m_rdoContainerCacheKey.key().empty();
  if (not externalCacheRDO) {
    ATH_CHECK(rdoContainer.record (std::make_unique<SCT_RDO_Container>(m_sctID->wafer_hash_max(), EventContainers::Mode::OfflineFast)));
    ATH_MSG_DEBUG("Created container for " << m_sctID->wafer_hash_max());
  }
  else {
    SG::UpdateHandle<SCT_RDO_Cache> rdoCache(m_rdoContainerCacheKey, ctx);
    ATH_CHECK(rdoCache.isValid());
    ATH_CHECK(rdoContainer.record (std::make_unique<SCT_RDO_Container>(rdoCache.ptr())));
    ATH_MSG_DEBUG("Created container using cache for " << m_rdoContainerCacheKey.key());
  }
 
  SG::WriteHandle<IDCInDetBSErrContainer> bsIDCErrContainer(m_bsIDCErrContainerKey, ctx);
  if ( m_bsErrContainerCacheKey.key().empty() ) {
    ATH_CHECK(bsIDCErrContainer.record( std::make_unique<IDCInDetBSErrContainer>(m_sctID->wafer_hash_max(), std::numeric_limits<IDCInDetBSErrContainer::ErrorCode>::min() )));
    ATH_MSG_DEBUG("Created IDCInDetBSErrContainer w/o using external cache");
  } else { // use cache
    SG::UpdateHandle<IDCInDetBSErrContainer_Cache> cacheHandle( m_bsErrContainerCacheKey, ctx );
    ATH_CHECK( cacheHandle.isValid() );
    ATH_CHECK(bsIDCErrContainer.record( std::make_unique<IDCInDetBSErrContainer>(cacheHandle.ptr())) );
    ATH_MSG_DEBUG("Created SCT IDCInDetBSErrContainer using external cache");
  }
 
  // Ask ROBDataProviderSvc for the vector of ROBFragment for all SCT ROBIDs
  std::vector<const ROBFragment*> vecROBFrags;
  std::vector<IdentifierHash> hashIDs;
  if (not m_roiSeeded.value()) {
    std::vector<uint32_t> rodList;
    m_cabling->getAllRods(rodList, ctx);
    ATH_MSG_DEBUG("Size of rodList: " << rodList.size());
    m_robDataProvider->getROBData(ctx, rodList, vecROBFrags);
  }
  else {
    // Only load ROBs from RoI
    std::vector<uint32_t> listOfROBs;
    SG::ReadHandle<TrigRoiDescriptorCollection> roiCollection{m_roiCollectionKey, ctx};
    ATH_CHECK(roiCollection.isValid());
    TrigRoiDescriptor superRoI; // Add all RoIs to a super-RoI
    superRoI.reserve(roiCollection->size());
    superRoI.setComposite(true);
    superRoI.manageConstituents(false);
    for (const TrigRoiDescriptor* roi : *roiCollection) {
      superRoI.push_back(roi);
    }
 
    m_regionSelector->lookup(ctx)->ROBIDList(superRoI, listOfROBs );
    m_regionSelector->lookup(ctx)->HashIDList(superRoI, hashIDs );
 
    m_robDataProvider->getROBData(ctx, listOfROBs, vecROBFrags);
  }
 
 
  ATH_MSG_DEBUG("Number of ROB fragments " << vecROBFrags.size());
 
  if (m_storeInDetTimeColls) {
    SG::WriteHandle<InDetTimeCollection> lvl1Collection;
    SG::WriteHandle<InDetTimeCollection> bcIDCollection;
    lvl1Collection = SG::makeHandle(m_lvl1CollectionKey,ctx);
    bcIDCollection = SG::makeHandle(m_bcIDCollectionKey,ctx);
 
    ATH_CHECK(lvl1Collection.record(std::make_unique<InDetTimeCollection>()));
    ATH_CHECK(bcIDCollection.record(std::make_unique<InDetTimeCollection>()));
 
    lvl1Collection->reserve(vecROBFrags.size());
    bcIDCollection->reserve(vecROBFrags.size());
 
    for (const ROBFragment* robFrag : vecROBFrags) {
      // Store LVL1ID and BCID information in InDetTimeCollection
      // to be stored in StoreGate at the end of the loop.
      // We want to store a pair<ROBID, LVL1ID> for each ROD, once per event.
      uint32_t robID{(robFrag)->rod_source_id()};
 
      unsigned int lvl1ID{(robFrag)->rod_lvl1_id()};
      lvl1Collection->emplace_back(robID, lvl1ID);
 
      unsigned int bcID{(robFrag)->rod_bc_id()};
      bcIDCollection->emplace_back(robID, bcID);
 
      ATH_MSG_DEBUG("Stored LVL1ID " << lvl1ID << " and BCID " << bcID << " in InDetTimeCollections");
    }
  }
 
  if ( not hashIDs.empty() ) {
    int missingCount{};
    for ( IdentifierHash hash: hashIDs ) {
      if ( not rdoContainer->tryAddFromCache( hash ) ) missingCount++;
      bsIDCErrContainer->tryAddFromCache( hash );
    }
    ATH_MSG_DEBUG("Out of: " << hashIDs.size() << "Hash IDs missing: " << missingCount );
    if ( missingCount == 0 ) {
      return StatusCode::SUCCESS;
    }
  }
 
  std::unique_ptr<DataPool<SCT3_RawData>> dataItemsPool = nullptr;
  if(!externalCacheRDO){
    dataItemsPool = std::make_unique<DataPool<SCT3_RawData>>(ctx);
    dataItemsPool->reserve(10000);  // Some large default size
  } else if (m_useDataPoolWithCache) {
    dataItemsPool = std::make_unique<DataPool<SCT3_RawData>>(ctx);
    // for now a default size 1024.
  }
 
  // Ask SCTRawDataProviderTool to decode it and to fill the IDC
  StatusCode statConv = m_rawDataTool->convert(vecROBFrags,
                           *(rdoContainer.ptr()),
                           *bsIDCErrContainer,
                 dataItemsPool.get(),
                 ctx);
 
  if (statConv.isFailure() && statConv != StatusCode::RECOVERABLE) {
    ATH_MSG_WARNING("BS conversion into RDOs failed");
    return statConv;
  } else {
    return StatusCode::SUCCESS;
  }
 
}