LArRawCalibDataReadingAlg.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#include "LArRawCalibDataReadingAlg.h"
#include "LArIdentifier/LArOnlineID.h"
#include "ByteStreamCnvSvcBase/IROBDataProviderSvc.h" 
#include "LArRawEvent/LArDigitContainer.h"
#include "LArRawEvent/LArCalibDigitContainer.h"
#include "LArRawEvent/LArAccumulatedDigitContainer.h"
#include "LArRawEvent/LArAccumulatedCalibDigitContainer.h"
#include "LArRawEvent/LArFebHeaderContainer.h"
#include "eformat/Version.h"
#include "eformat/index.h"
 
#include "LArByteStream/LArRodBlockStructure.h"
#include "LArByteStream/LArRodBlockAccumulatedV3.h"
#include "LArByteStream/LArRodBlockCalibrationV3.h"
#include "LArByteStream/LArRodBlockTransparentV0.h"
 
#include "LArFebHeaderReader.h"
 
LArRawCalibDataReadingAlg::LArRawCalibDataReadingAlg(const std::string& name, ISvcLocator* pSvcLocator) :  
  AthReentrantAlgorithm(name, pSvcLocator) {}
 
  StatusCode LArRawCalibDataReadingAlg::initialize() {
 
  if (m_DigitKey.key().size()>0) {
    ATH_CHECK(m_DigitKey.initialize());
    m_doDigits=true;
  }
  else {
    m_doDigits=false;
  }
 
  if (m_calibDigitKey.key().size()>0) {
    ATH_CHECK(m_calibDigitKey.initialize());
    m_doCalibDigits=true;
  }
  else {
    m_doCalibDigits=false;
  }
 
  if (m_accDigitKey.key().size()>0) {
    ATH_CHECK(m_accDigitKey.initialize());
    m_doAccDigits=true;
  }
  else {
    m_doAccDigits=false;
  }
 
  if (m_accCalibDigitKey.key().size()>0) {
    ATH_CHECK(m_accCalibDigitKey.initialize());
    m_doAccCalibDigits=true;
  }
  else {
    m_doAccCalibDigits=false;
  }
 
  if (m_febHeaderKey.key().size()>0) {
    ATH_CHECK(m_febHeaderKey.initialize());
    m_doFebHeaders=true;
  }
  else {
    m_doFebHeaders=false;
  }
  
  if(!(m_doDigits || m_doCalibDigits || m_doAccDigits || m_doAccCalibDigits)) {
     ATH_MSG_FATAL("Needs ether Digits or CalibDigits or AccDigits  or AccCalibDigit Key");
     return StatusCode::FAILURE;
  }
 
  if(m_doCalibDigits && m_doAccCalibDigits) {
     ATH_MSG_FATAL("Could not have both CalibDigits, AccCalibDigits Key");
     return StatusCode::FAILURE;
  }
 
  if(m_doAccDigits && (m_doDigits || m_doCalibDigits || m_doAccCalibDigits)) {
     ATH_MSG_FATAL("Could not have AccDigits with Calib Key");
     return StatusCode::FAILURE;
  }
 
  ATH_CHECK(m_robDataProviderSvc.retrieve());
  ATH_CHECK(detStore()->retrieve(m_onlineId,"LArOnlineID"));  
 
  ATH_CHECK(m_CLKey.initialize());
 
 
  //Fill FT list if only Barrel/EC and side is given:
  if (m_vBEPreselection.size() &&  m_vPosNegPreselection.size() &&  m_vFTPreselection.size()==0) {
    std::set<unsigned> fts;
    if (std::find(m_vBEPreselection.begin(),m_vBEPreselection.end(),0)!=m_vBEPreselection.end()) { //Barrel selected
      fts.insert({0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31});
    }
    if (std::find(m_vBEPreselection.begin(),m_vBEPreselection.end(),1)!=m_vBEPreselection.end()) { //Endcap selected
      fts.insert({0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24});
    }
    m_vFTPreselection.value().insert(m_vFTPreselection.begin(),fts.begin(),fts.end());
  }
 
  //Build list of preselected Feedthroughs
  if (m_vBEPreselection.size() &&  m_vPosNegPreselection.size() && m_vFTPreselection.size()) {
    ATH_MSG_INFO("Building list of selected feedthroughs");
    for (const unsigned iBE : m_vBEPreselection) {
      for (const unsigned iPN: m_vPosNegPreselection) {
    for (const unsigned iFT: m_vFTPreselection) {
      HWIdentifier finalFTId=m_onlineId->feedthrough_Id(iBE,iPN,iFT);
      ATH_MSG_INFO("Adding feedthrough Barrel/Endcap=" << iBE << " pos/neg=" << iPN << " FT=" << iFT 
               << " (0x" << std::hex << finalFTId.get_identifier32().get_compact() << std::dec << ")");
      m_vFinalPreselection.insert(finalFTId);
    }
      }
    }
  }//end if something set
 
  if (!m_subCaloPreselection.value().empty()) {
    ATH_MSG_INFO("Adding list of selected subcalo"<<m_subCaloPreselection.value());
    std::set<HWIdentifier> subcaloFTs;
    if (m_subCaloPreselection.value().compare("EM")==0) {
      for (auto febid : m_onlineId->feb_range()) {
    if (m_onlineId->isEMBchannel(febid) || m_onlineId->isEMECchannel(febid)) {
      subcaloFTs.insert(m_onlineId->feedthrough_Id(febid));
    }
      }
    }
    else if (m_subCaloPreselection.value().find("HEC")!=std::string::npos || m_subCaloPreselection.value().find("FCAL")!=std::string::npos) {
        if (m_subCaloPreselection.value().find("HEC")!=std::string::npos) {
         for (auto febid : m_onlineId->feb_range()) {
           if (m_onlineId->isHECchannel(febid)) {
             subcaloFTs.insert(m_onlineId->feedthrough_Id(febid));
           } 
         }
       }
       if (m_subCaloPreselection.value().find("FCAL")!=std::string::npos) {
         for (auto febid : m_onlineId->feb_range()) {
           if (m_onlineId->isFCALchannel(febid)) {
             subcaloFTs.insert(m_onlineId->feedthrough_Id(febid));
           } 
         }
       }
    } else {
      ATH_MSG_ERROR("Configuration problem, property 'SubCaloPreselection' set to " << m_subCaloPreselection.value() << ", expect 'EM', 'HEC' or 'FCAL'");
      return StatusCode::FAILURE;
    }
    if (m_vFinalPreselection.size()>0) {
      //Form the intersection of the preselection give as subdet and side/FT/slot
      for(auto it = m_vFinalPreselection.begin(); it != m_vFinalPreselection.end(); ) {
    if (subcaloFTs.find(*it)==subcaloFTs.end()) 
      it=m_vFinalPreselection.erase(it);
    else 
      ++it;
      }
      if (m_vFinalPreselection.empty()) {
    ATH_MSG_WARNING("Apparently inconistent configuration of FT preselections. No preselection left after intersecting 'SubCaloPreselection' with 'PosNeg/BE/FT' preselection");
      }
    }
    else {
      m_vFinalPreselection.swap(subcaloFTs);
    }
  }//end if subCaloPreselection set
 
  if (!m_vFinalPreselection.empty()) {
    ATH_MSG_INFO("Give pre-selection covers " << m_vFinalPreselection.size() << " feedthroughts. Will ignore bytestream data from other feedthroughs.");
  }
 
  return StatusCode::SUCCESS;
}     
  
StatusCode LArRawCalibDataReadingAlg::execute(const EventContext& ctx) const {
  LArDigitContainer* digits=nullptr;
  LArCalibDigitContainer* cdigits=nullptr;
  LArAccumulatedDigitContainer* accdigits=nullptr;
  LArAccumulatedCalibDigitContainer* caccdigits=nullptr;
  LArFebHeaderContainer* febHeaders=nullptr;
 
  if (m_doDigits) {
    SG::WriteHandle<LArDigitContainer> digitsHdl(m_DigitKey,ctx);
    ATH_CHECK(digitsHdl.record(std::make_unique<LArDigitContainer>()));
    digits=digitsHdl.ptr();
    digits->reserve(200000); //Enough space for the full calo
  }
 
  if (m_doCalibDigits) {
    SG::WriteHandle<LArCalibDigitContainer> cdigitsHdl(m_calibDigitKey,ctx);
    ATH_CHECK(cdigitsHdl.record(std::make_unique<LArCalibDigitContainer>()));
    cdigits=cdigitsHdl.ptr();
    cdigits->reserve(200000); //Enough space for the full calo
  }
 
  if (m_doAccDigits) {
    SG::WriteHandle<LArAccumulatedDigitContainer> accdigitsHdl(m_accDigitKey,ctx);
    ATH_CHECK(accdigitsHdl.record(std::make_unique<LArAccumulatedDigitContainer>()));
    accdigits=accdigitsHdl.ptr();
    accdigits->reserve(200000); //Enough space for the full calo
  }
 
  if (m_doAccCalibDigits) {
    SG::WriteHandle<LArAccumulatedCalibDigitContainer> caccdigitsHdl(m_accCalibDigitKey,ctx);
    ATH_CHECK(caccdigitsHdl.record(std::make_unique<LArAccumulatedCalibDigitContainer>()));
    caccdigits=caccdigitsHdl.ptr();
    caccdigits->reserve(200000); //Enough space for the full calo
  }
 
  if (m_doFebHeaders) {
    SG::WriteHandle<LArFebHeaderContainer> febHeadersHdl(m_febHeaderKey,ctx);
    ATH_CHECK(febHeadersHdl.record(std::make_unique<LArFebHeaderContainer>()));
    febHeaders=febHeadersHdl.ptr();
    febHeaders->reserve(1524); //Total number of LAr Front End Boards
  }
 
  //Get full events and filter out LAr ROBs
  const RawEvent* fullEvent=m_robDataProviderSvc->getEvent(ctx);
  std::map<eformat::SubDetectorGroup, std::vector<const uint32_t*> > rawEventTOC;
  eformat::helper::build_toc(*fullEvent, rawEventTOC);
  auto larRobs=rawEventTOC.find(eformat::LAR);
  if (larRobs==rawEventTOC.end()) {
     ATH_MSG_DEBUG("No LAr data found in this event.");
     return StatusCode::SUCCESS;
  } 
  
  
  std::unique_ptr<LArRodBlockStructure> rodBlock;
  uint16_t rodMinorVersion=0x0;
  uint32_t rodBlockType=0x0;
 
  const LArCalibLineMapping *calibMap=nullptr;
  if (m_doAccCalibDigits) {
      SG::ReadCondHandle<LArCalibLineMapping> clHdl{m_CLKey,ctx};
      calibMap = *clHdl;
      if(!calibMap) {
         ATH_MSG_ERROR( "Do not have calib line mapping !!!" );
         return StatusCode::FAILURE;
      }
  }
 
  for (const uint32_t* robPtr : larRobs->second) {
    OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment rob(robPtr);
    ATH_MSG_VERBOSE("Decoding ROB fragment 0x" << std::hex << rob.rob_source_id () << " with " << std::dec << rob.rod_fragment_size_word() << "ROB words");
 
    if (rob.rod_fragment_size_word() <3) {
      ATH_MSG_ERROR("Encountered corrupt ROD fragment, less than 3 words!");
      if (m_failOnCorruption) {
    return StatusCode::FAILURE;
      }else 
    continue; //Jump to next ROD block
    }else if(rob.rob_source_id()& 0x1000 ){
        ATH_MSG_VERBOSE(" skip Latome fragment with source ID "<< std::hex << rob.rob_source_id());
        rodBlock=nullptr;
        continue;
    }
    
     eformat::helper::Version ver(rob.rod_version());
    //(re-)init rodBlock only once per event or if (very unlikly or even impossible) some FEBs have a differnt firmware
    if (rodBlock==nullptr || rodMinorVersion !=ver.minor_version() || rodBlockType!=(rob.rod_detev_type()&0xff)) {
      rodMinorVersion=ver.minor_version();
      rodBlockType=rob.rod_detev_type()&0xff;
      ATH_MSG_VERBOSE("Found version " << rodMinorVersion <<  " of Rod Block Type  " <<  rodBlockType);
      if (rodBlockType==10) { // Accumulated  digits
         rodBlock.reset(new LArRodBlockAccumulatedV3 (this->msgSvc().get()));
      }//end of rodBlockType ==10
      else if (rodBlockType==7 || rodBlockType==2) { // Calib. digits
         if(rodMinorVersion>=6) { // Accumulated calib. digits
            rodBlock.reset(new LArRodBlockCalibrationV3 (this->msgSvc().get()));
         } else {
            ATH_MSG_ERROR("Found unsupported ROD Block version " << rodMinorVersion
                        << " of ROD block type " << rodBlockType);
            return m_failOnCorruption ? StatusCode::FAILURE : StatusCode::SUCCESS;
         }
      } else {
    ATH_MSG_ERROR("Found unsupported Rod block type " << rodBlockType << " in ROB sourceId: 0x" << std::hex << rob.rob_source_id () << std::dec
                      << ", ROD source ID: 0x" << rob.rod_source_id() << std::dec);
    if (m_failOnCorruption) 
      return StatusCode::FAILURE;
    else 
      continue; //Jump to next ROD block
      }
    }//End if need to re-init RodBlock
 
    const uint32_t* pData=rob.rod_data();
    const uint32_t  nData=rob.rod_ndata();
    if (!rodBlock->setFragment(pData,nData)) {
      ATH_MSG_ERROR("Failed to assign fragment pointer to LArRodBlockStructure");
      return StatusCode::FAILURE;
    }
 
    if(m_verifyChecksum) {
      const uint32_t onsum  = rodBlock->onlineCheckSum();
      const uint32_t offsum = rodBlock->offlineCheckSum();
      if(onsum!=offsum) {
    ATH_MSG_ERROR("Checksum error:");
    ATH_MSG_ERROR("online checksum  = 0x" << MSG::hex << onsum);
    ATH_MSG_ERROR("offline checksum = 0x" << MSG::hex << offsum << MSG::dec);
    if (m_failOnCorruption) 
      return StatusCode::FAILURE;
    else
      continue; //Jump to the next ROD-block
      }
    }
 
    //Loop over FEBs in ROD:
    do {
      HWIdentifier fId(Identifier32(rodBlock->getFEBID()));
      if (!m_onlineId->isValidId(fId)) {
    ATH_MSG_ERROR("Invalid FEB identifer 0x" << std::hex << fId.get_identifier32().get_compact()); 
    if (m_failOnCorruption) 
      return StatusCode::FAILURE;
    else
      continue;
      }
 
      if (m_vFinalPreselection.size()) {
    const auto ftId=m_onlineId->feedthrough_Id(fId);
    if (m_vFinalPreselection.find(ftId)==m_vFinalPreselection.end()) {
      ATH_MSG_DEBUG("Feedthrough with id 0x" << MSG::hex << ftId << MSG::dec <<" not in preselection. Ignored.");
      continue;
    }
      }
 
 
      const int NthisFebChannel=m_onlineId->channelInSlotMax(fId);
 
      //Decode LArDigits (if requested)
      if (m_doDigits) {
    uint32_t gain;
    int fcNb;
    std::vector<short> samples;
    while (rodBlock->getNextRawData(fcNb,samples,gain)) {
      if (fcNb>=NthisFebChannel)
        continue;
      if (samples.size()==0) continue; // Ignore missing cells
      HWIdentifier cId = m_onlineId->channel_Id(fId,fcNb);
      digits->emplace_back(new LArDigit(cId, (CaloGain::CaloGain)gain, std::move(samples)));
      samples.clear();
    }//end getNextRawData loop
      }//end if m_doDigits
 
      //Decode LArCalibDigits (if requested)
      if (m_doCalibDigits) {
    uint32_t gain;
        uint16_t dac;
        uint16_t delay;
        bool ispulsed;
    int fcNb;
    std::vector<short> samples;
    while (rodBlock->getNextRawData(fcNb,samples,gain)) {
      if (fcNb>=NthisFebChannel)
        continue;
      if (samples.size()==0) continue; // Ignore missing cells
          dac = rodBlock->getDAC();
          delay = rodBlock->getDelay();
          ispulsed = rodBlock->getPulsed(fcNb);
      HWIdentifier cId = m_onlineId->channel_Id(fId,fcNb);
      cdigits->emplace_back(new LArCalibDigit(cId, (CaloGain::CaloGain)gain, std::move(samples), dac, delay, ispulsed));
      samples.clear();
    }//end getNextRawData loop
      }//end if m_doCalibDigits
 
      //Decode LArAccumulatedDigits (if requested)
      if (m_doAccDigits && rodBlockType==10) {
    uint32_t gain;
    int fcNb;
    std::vector<uint64_t> samplesSum;
    std::vector<uint64_t> samples2Sum;
        uint32_t nTrigger;
    while (rodBlock->getNextAccumulatedDigit(fcNb,samplesSum,samples2Sum,gain)) {
      if (fcNb>=NthisFebChannel)
        continue;
      if (samplesSum.size()==0 || samples2Sum.size()==0) continue; // Ignore missing cells
          nTrigger = rodBlock->getNTrigger();
      HWIdentifier cId = m_onlineId->channel_Id(fId,fcNb);
      accdigits->emplace_back(new LArAccumulatedDigit(cId, (CaloGain::CaloGain)gain, std::move(samplesSum), std::move(samples2Sum), nTrigger));
      samplesSum.clear();
      samples2Sum.clear();
    }//end getNext loop
      }//end if m_doAccDigits
 
      //Decode LArAccumulatedCalibDigits (if requested)
      if (m_doAccCalibDigits) {
    uint32_t gain;
    uint32_t itmp;
        uint16_t dac;
        uint16_t delay;
        uint16_t nstep;
        uint16_t istep;
        bool     ispulsed=false;
        uint16_t ispulsed_int;
        unsigned bitShift;
    int fcNb;
    std::vector<uint64_t> samplesSum;
    std::vector<uint64_t> samples2Sum;
        uint32_t nTrigger;
    while (rodBlock->getNextAccumulatedCalibDigit(fcNb,samplesSum,samples2Sum,itmp,gain)) {
      if (fcNb>=NthisFebChannel)
        continue;
      if (samplesSum.size()==0 || samples2Sum.size()==0) continue; // Ignore missing cells
          ispulsed_int=0;
          bitShift=0;
          dac = rodBlock->getDAC();
          delay = rodBlock->getDelay();
          nTrigger = rodBlock->getNTrigger();
          nstep = rodBlock->getNStep();
          istep = rodBlock->getStepIndex();
      HWIdentifier cId = m_onlineId->channel_Id(fId,fcNb);
          const std::vector<HWIdentifier>& calibChannelIDs = calibMap->calibSlotLine(cId);
          for(std::vector<HWIdentifier>::const_iterator csl_it=calibChannelIDs.begin(); csl_it!=calibChannelIDs.end();++csl_it){
            uint32_t calibLine = m_onlineId->channel(*csl_it);
            ispulsed=rodBlock->getPulsed(calibLine);
            ispulsed_int=( ispulsed_int | ((uint16_t)ispulsed<<bitShift) );
            bitShift++;
          }
          caccdigits->emplace_back(new LArAccumulatedCalibDigit(cId, (CaloGain::CaloGain)gain, std::move(samplesSum), std::move(samples2Sum), nTrigger, dac, delay, ispulsed_int, nstep, istep));
    }//end getNext loop
        caccdigits->setDelayScale(m_delayScale);
      }//end if m_doAccDigits
 
      //Decode FebHeaders (if requested)
      if (m_doFebHeaders) {
    std::unique_ptr<LArFebHeader> larFebHeader(new LArFebHeader(fId));
    LArFebHeaderReader::fillFebHeader(larFebHeader.get(),rodBlock.get(),rob);
    febHeaders->push_back(std::move(larFebHeader));
      }//end if m_doFebHeaders
 
    }while (rodBlock->nextFEB()); //Get NextFeb
  } //end loop over ROBs
  return StatusCode::SUCCESS;
}