LArNoisyROMonAlg.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
#include "LArNoisyROMonAlg.h"
 
#include "LArRecEvent/LArEventBitInfo.h"
#include "LArIdentifier/LArOnlineID.h"
 
#include <sstream>
#include <stdexcept>
#include <cmath>
 
LArNoisyROMonAlg::LArNoisyROMonAlg(const std::string& name, ISvcLocator* pSvcLocator):
  AthMonitorAlgorithm(name, pSvcLocator), 
  m_LArOnlineIDHelper(nullptr) {
  
}
 
 
StatusCode LArNoisyROMonAlg::initialize()
{
  ATH_CHECK(detStore()->retrieve(m_LArOnlineIDHelper, "LArOnlineID" ));
  ATH_CHECK(m_inputKey.initialize());
  ATH_CHECK(m_badFebKey.initialize());
  ATH_CHECK(m_MNBFebKey.initialize());
  ATH_CHECK( m_eventInfoDecorKey.initialize() );
  
  m_histoGroups.reserve(m_SubDetNames.size());
  for (unsigned i=0; i<m_SubDetNames.size(); ++i) {
    std::vector<std::string> part;
    part.push_back(m_partitions[2*i]);
    part.push_back(m_partitions[2*i+1]);
    ATH_MSG_INFO(i<<" "<<m_SubDetNames[i]<<" "<<part[0] <<" " <<part[1]);
    m_histoGroups.push_back(Monitored::buildToolMap<int>(m_tools,m_SubDetNames[i],part));
  }
 
  return AthMonitorAlgorithm::initialize();
}
 
 
void LArNoisyROMonAlg::fillHistogramsOnce(const EventContext& ctx, const bool isMC) const {
  
  SG::ReadCondHandle<LArBadFebCont> badHdl{m_badFebKey, ctx};
  const LArBadFebCont *badCont{*badHdl};
  if(badCont) {
    if( !isMC && badCont->size()==0) {
      ATH_MSG_DEBUG("List of known Bad FEBs empty !? ");
    } else {
      auto sl=Monitored::Scalar<unsigned>("slotBad",0);
      auto FT=Monitored::Scalar<unsigned>("FTBad",0);
      for(LArBadFebCont::BadChanVec::const_iterator i = badCont->begin(); i!=badCont->end(); ++i) {
    HWIdentifier chid(i->first);
    sl = m_LArOnlineIDHelper->slot(chid);
    FT = m_LArOnlineIDHelper->feedthrough(chid);
    unsigned sd = partitionNumber(chid)/2;
    unsigned part = partitionNumber(chid);
    ATH_MSG_DEBUG("Filled known Bad FEBs for " << sd << " and " << part<<": "<<sl<<" "<<FT);
    fill(m_tools[m_histoGroups.at(sd).at(m_partitions[part])],sl,FT);
      }
    }
  } else {
    ATH_MSG_WARNING("Known Bad FEBs container not existing !? ");
  }
        
  SG::ReadCondHandle<LArBadFebCont> mnbHdl(m_MNBFebKey, ctx);
  const LArBadFebCont* mnbCont{*mnbHdl};
  if(mnbCont) {
    if( !isMC && mnbCont->size()==0) {
      ATH_MSG_WARNING("List of known MNB FEBs empty !? ");
    } else {
      auto sl=Monitored::Scalar<unsigned>("slotMNB",0);
      auto FT=Monitored::Scalar<unsigned>("FTMNB",0);
      for(LArBadFebCont::BadChanVec::const_iterator i = mnbCont->begin(); i!=mnbCont->end(); ++i) {
    HWIdentifier chid(i->first);
    sl = m_LArOnlineIDHelper->slot(chid);
    FT = m_LArOnlineIDHelper->feedthrough(chid);
    unsigned sd = partitionNumber(chid)/2;
    unsigned part = partitionNumber(chid);
    ATH_MSG_DEBUG("Filled known MNB FEBs for " << sd << " and " << m_partitions[part]<<": "<<sl<<" "<<FT);
    fill(m_tools[m_histoGroups.at(sd).at(m_partitions[part])],sl,FT);
      }
    }
  } else {
    ATH_MSG_WARNING("Known MNB FEBs container not existing !? ");
  }
  return;
} 
 
 
StatusCode LArNoisyROMonAlg::fillHistograms(const EventContext& ctx) const {
 
  SG::ReadHandle<xAOD::EventInfo> eventInfo = GetEventInfo(ctx);
  ATH_CHECK(eventInfo.isValid());
  const bool isMC=eventInfo->eventType( xAOD::EventInfo::IS_SIMULATION);
  std::call_once(m_onceFlag, &LArNoisyROMonAlg::fillHistogramsOnce, this, ctx, isMC);
  
 
  // retrieve 
  SG::ReadHandle<LArNoisyROSummary> noisyRO{m_inputKey, ctx};
  if (!noisyRO.isValid()) 
  {
    ATH_MSG_WARNING( "Can't retrieve LArNoisyROSummary " );
    return StatusCode::SUCCESS;
  }
  
  unsigned int LBN = eventInfo->lumiBlock();
  bool burstveto = eventInfo->isEventFlagBitSet(xAOD::EventInfo::LAr,LArEventBitInfo::NOISEBURSTVETO);
 
  const std::vector<HWIdentifier>& mnbtightFEB = noisyRO->get_MNBTight_febs();  
  const std::vector<HWIdentifier>& mnbtight_PsVetoFEB = noisyRO->get_MNBTight_PsVeto_febs();
  const std::vector<HWIdentifier>& mnblooseFEB = noisyRO->get_MNBLoose_febs();  
 
  // Filling Candidate MNB Tree
  std::vector<int> v_candidate_MNBTightFEB;
  std::vector<int> v_candidate_MNBTight_PsVetoFEB;
  std::vector<int> v_candidate_MNBLooseFEB;
 
  for(unsigned int iFeb=0; iFeb<mnbtightFEB.size(); iFeb++) 
    v_candidate_MNBTightFEB.push_back(mnbtightFEB.at(iFeb).get_identifier32().get_compact());
 
  for(unsigned int iFeb=0; iFeb<mnbtight_PsVetoFEB.size(); iFeb++) 
    v_candidate_MNBTight_PsVetoFEB.push_back(mnbtight_PsVetoFEB.at(iFeb).get_identifier32().get_compact());
 
  if (m_storeLooseMNBFEBs){ // joboption - By default the FEB flagged as MNB-Loose are not stored in the TTree
    for(unsigned int iFeb=0; iFeb<mnblooseFEB.size(); iFeb++)
      v_candidate_MNBLooseFEB.push_back(mnblooseFEB.at(iFeb).get_identifier32().get_compact());
  }
 
  if(v_candidate_MNBLooseFEB.size() > 0 || v_candidate_MNBTightFEB.size() > 0) {
    auto candidate_MNB_time = Monitored::Scalar<unsigned int>("candidate_MNB_time", eventInfo->timeStamp());
    auto candidate_MNB_time_ns = Monitored::Scalar<unsigned int>("candidate_MNB_time_ns", eventInfo->timeStampNSOffset());
    auto n_candidate_MNBTight_FEB = Monitored::Scalar<unsigned int>("n_candidate_MNBTight_FEB", mnbtightFEB.size());
    auto n_candidate_MNBTight_PsVeto_FEB = Monitored::Scalar<unsigned int>("n_candidate_MNBTight_PsVeto_FEB", mnbtightFEB.size());
    auto n_candidate_MNBLoose_FEB = Monitored::Scalar<unsigned int>("n_candidate_MNBLoose_FEB", mnblooseFEB.size());  
 
    auto mon_candidate_MNBTightFEB = Monitored::Collection("v_candidate_MNBTightFEB", v_candidate_MNBTightFEB);
    auto mon_candidate_MNBTight_PsVetoFEB = Monitored::Collection("v_candidate_MNBTight_PsVetoFEB", v_candidate_MNBTight_PsVetoFEB);
    auto mon_candidate_MNBLooseFEB = Monitored::Collection("v_candidate_MNBLooseFEB", v_candidate_MNBLooseFEB);  
 
    ATH_MSG_DEBUG("Filling CandidateMNB tree");
 
    fill(m_MonGroupName,candidate_MNB_time,candidate_MNB_time_ns,n_candidate_MNBTight_FEB,n_candidate_MNBTight_PsVeto_FEB,n_candidate_MNBLoose_FEB,mon_candidate_MNBTightFEB,mon_candidate_MNBTight_PsVetoFEB,mon_candidate_MNBLooseFEB);  
  }
 
  // Fill the noise bursts timestamp ttree
  auto time =  Monitored::Scalar<int>("time",eventInfo->timeStamp());
  auto time_ns = Monitored::Scalar<int>("time_ns",eventInfo->timeStampNSOffset()); 
  auto algo = Monitored::Scalar<unsigned char>("algo",0);
  if ( eventInfo->isEventFlagBitSet(xAOD::EventInfo::LAr,LArEventBitInfo::BADFEBS) ) 
  {
    algo |= 0x1;
  }
  if ( eventInfo->isEventFlagBitSet(xAOD::EventInfo::LAr,LArEventBitInfo::TIGHTSATURATEDQ) ) 
  {
    algo |= 0x2;
  }
  if ( eventInfo->isEventFlagBitSet(xAOD::EventInfo::LAr,LArEventBitInfo::BADFEBS_W) ) 
  {
    algo |= 0x8;
  }
  if (eventInfo->isEventFlagBitSet(xAOD::EventInfo::LAr,LArEventBitInfo::MININOISEBURSTLOOSE))
  {
    algo |= 0x10;
  }
  if (eventInfo->isEventFlagBitSet(xAOD::EventInfo::LAr,LArEventBitInfo::MININOISEBURSTTIGHT))
  {
    algo |= 0x20;
  }
  if (eventInfo->isEventFlagBitSet(xAOD::EventInfo::LAr,LArEventBitInfo::MININOISEBURSTTIGHT_PSVETO))
  {
    algo |= 0x40;
  }
 
  if ( algo != 0 ) {
    if ( burstveto ) algo |= 0x4;
    ATH_MSG_DEBUG("Filling LArNoise tree with algo: " << algo);
    fill(m_MonGroupName,time,time_ns,algo);
  } else { 
    ATH_MSG_DEBUG("Not a noisy event");
  }
 
  // Triggers
  unsigned long trigbits = 0;
  unsigned long L1trigbits = 0;
  if ( m_doTrigger ) {
    for ( size_t i = 0; i < m_EF_NoiseBurst_Triggers.size(); i++) {
      if ( m_trigDecTool->isPassed(m_EF_NoiseBurst_Triggers[i]))  trigbits |= (0x1 << i);
    }
    for ( size_t i = 0; i < m_L1_NoiseBurst_Triggers.size(); i++) {
      if ( m_trigDecTool->isPassed(m_L1_NoiseBurst_Triggers[i]))  L1trigbits |= (0x1 << i);
    }
    ATH_MSG_DEBUG("Trigger words: " << std::hex << trigbits << " " << L1trigbits << std::dec);
  }
  if(!m_doHisto) return StatusCode::SUCCESS;
 
  // Fill the 2D map of noisy and mini-noisy FEBs
  const std::vector<HWIdentifier>& noisyFEB = noisyRO->get_noisy_febs();
 
  // Loop on all FEBs noisy in Std definition (i.e >30 channels with q factor > 4000)
  // And fill the 2D maps of fraction of fraction of noisy events
  unsigned int NbNoisyFEB = 0;
  constexpr auto partMask=std::to_array<unsigned>({LArNoisyROSummary::EMBCMask,LArNoisyROSummary::EMBAMask,LArNoisyROSummary::EMECCMask,LArNoisyROSummary::EMECAMask});
 
  ATH_MSG_DEBUG("NoisyFEB vector size " << noisyFEB.size());
 
  auto slotN=Monitored::Scalar<unsigned>("slotNoisy",0);
  auto FTN=Monitored::Scalar<unsigned>("FTNoisy",0);
  for (size_t i = 0; i<noisyFEB.size(); i++) {
    NbNoisyFEB++;
    const HWIdentifier& febid = noisyFEB[i];
    HWIdentifier id = m_LArOnlineIDHelper->channel_Id(febid,0);
    unsigned partition = partitionNumber(febid);
    unsigned sd = partitionNumber(id)/2;
 
    if (partition<4){
       FTN = m_LArOnlineIDHelper->feedthrough(id);
       slotN = m_LArOnlineIDHelper->slot(id);
       fill(m_tools[m_histoGroups.at(sd).at(m_partitions[partition])],slotN,FTN);
    }
  } // End of loop on all RNB - noisy FEB
 
  auto n_noisyFEB = Monitored::Scalar<int>("n_noisyFEBs",NbNoisyFEB);
  auto lb = Monitored::Scalar<int>("LBN",LBN);
  fill(m_MonGroupName,n_noisyFEB,lb);
 
  // Loop on all FEBs noisy in MNB-tight definition
  // And fill the 2D maps of fraction of fraction of noisy events
  // Fill two histograms with veto cut and all events
  ATH_MSG_DEBUG("MNBTight FEB vector size " << mnbtightFEB.size());
  auto slotTightCan=Monitored::Scalar<unsigned>("slotTightCan",0);
  auto FTTightCan=Monitored::Scalar<unsigned>("FTTightCan",0);
  auto slotTight=Monitored::Scalar<unsigned>("slotTight",0);
  auto FTTight=Monitored::Scalar<unsigned>("FTTight",0);
  for (size_t i = 0; i<mnbtightFEB.size(); i++) {
    const HWIdentifier& febid = mnbtightFEB[i];
    HWIdentifier id = m_LArOnlineIDHelper->channel_Id(febid,0);
    unsigned partition = partitionNumber(febid);
 
    if (partition<4){
       unsigned sd = partitionNumber(id)/2;
       FTTightCan = m_LArOnlineIDHelper->feedthrough(id);
       slotTightCan = m_LArOnlineIDHelper->slot(id);
       // FIXME: could not this be done with cutmask ?
       fill(m_tools[m_histoGroups.at(sd).at(m_partitions[partition])],slotTightCan,FTTightCan);
       if((noisyRO->MNBTightFlaggedPartitions() & partMask[partition]) != 0){ 
             slotTight = unsigned(slotTightCan);
             FTTight = unsigned(FTTightCan);
             fill(m_tools[m_histoGroups.at(sd).at(m_partitions[partition])],slotTight,FTTight);
       }
    }
  }// End of loop on all MNB-Tight - noisy FEB
 
  // Loop on all FEBs noisy in MNB-tight-PsVeto definition
  // And fill the 2D maps of fraction of fraction of noisy events
  // Fill two histograms with veto cut and all events
  auto slot_PsVetoTightCan=Monitored::Scalar<unsigned>("slot_PsVetoTightCan",0);
  auto FT_PsVetoTightCan=Monitored::Scalar<unsigned>("FT_PsVetoTightCan",0);
  auto slot_PsVetoTight=Monitored::Scalar<unsigned>("slot_PsVetoTight",0);
  auto FT_PsVetoTight=Monitored::Scalar<unsigned>("FT_PsVetoTight",0);
  ATH_MSG_DEBUG("MNBTight_PsVeto FEB vector size " << mnbtight_PsVetoFEB.size());
  for (size_t i = 0; i<mnbtight_PsVetoFEB.size(); i++) {
    const HWIdentifier& febid = mnbtight_PsVetoFEB[i];
    HWIdentifier id = m_LArOnlineIDHelper->channel_Id(febid,0);
    int partition = partitionNumber(febid);
 
    if (partition<4){
       unsigned sd = partitionNumber(id)/2;
       FT_PsVetoTightCan = m_LArOnlineIDHelper->feedthrough(id);
       slot_PsVetoTightCan = m_LArOnlineIDHelper->slot(id);
       // FIXME: could not this be done with cutmask ?
       fill(m_tools[m_histoGroups.at(sd).at(m_partitions[partition])],slot_PsVetoTightCan,FT_PsVetoTightCan);
       if((noisyRO->MNBTight_PsVetoFlaggedPartitions() & partMask[partition]) != 0){ 
            slot_PsVetoTight = unsigned(slot_PsVetoTightCan);
            FT_PsVetoTight = unsigned(FT_PsVetoTightCan);
            fill(m_tools[m_histoGroups.at(sd).at(m_partitions[partition])],slot_PsVetoTight,FT_PsVetoTight);
       }
    }
  }// End of loop on all MNB-Tight-PsVeto - noisy FEB
 
  // Loop on all FEBs noisy in MNB-loose definition
  // And fill the 2D maps of fraction of fraction of noisy events
  // Fill two histograms with veto cut and all events
  auto slotLooseCan=Monitored::Scalar<unsigned>("slotLooseCan",0);
  auto FTLooseCan=Monitored::Scalar<unsigned>("FTLooseCan",0);
  auto slotLoose=Monitored::Scalar<unsigned>("slotLoose",0);
  auto FTLoose=Monitored::Scalar<unsigned>("FTLoose",0);
  ATH_MSG_DEBUG("MNBLoose FEB vector size " << mnblooseFEB.size());
  for (size_t i = 0; i<mnblooseFEB.size(); i++) {
    const HWIdentifier& febid = mnblooseFEB[i];
    // Will be used in next iteration:
    HWIdentifier id = m_LArOnlineIDHelper->channel_Id(febid,0);
    int partition = partitionNumber(febid);
 
    if (partition<4){
      unsigned sd = partitionNumber(id)/2;
      FTLooseCan = m_LArOnlineIDHelper->feedthrough(id);
      slotLooseCan = m_LArOnlineIDHelper->slot(id);
      fill(m_tools[m_histoGroups.at(sd).at(m_partitions[partition])],slotLooseCan,FTLooseCan);
      if((noisyRO->MNBLooseFlaggedPartitions() & partMask[partition]) != 0){ 
            slotLoose = unsigned(slotLoose);
            FTLoose = unsigned(FTLoose);
            fill(m_tools[m_histoGroups.at(sd).at(m_partitions[partition])],slotLoose,FTLoose);
      }
    }
  }// End of loop on all MNB-Loose - noisy FEB
  // End of 2D map of FEB found as noisy (in any definition : Std, MNB-Tight, MNB-Tight-PsVeto or MNB-Loose)
  
  // Now fill 1D histograms of events found as noisy vetoed or not
  // Event found noisy by Std method
  uint8_t BadFEBPartitions = noisyRO->BadFEBFlaggedPartitions();
  if ( BadFEBPartitions != 0) {
    auto LBStd = Monitored::Scalar<unsigned>("LBStd",LBN);
    auto LBStdV = Monitored::Scalar<unsigned>("LBStd_Veto",LBN);
    for (size_t i= 0;i<m_partitions.size();i++){
      if ( (BadFEBPartitions & partMask[i]) != 0 ) {
        fill(m_tools[m_histoGroups.at(i/2).at(m_partitions[i])],LBStd);
    if ( m_doTrigger ) {
           fillTriggerHisto(i,trigbits,L1trigbits);
        }
    if ( ! burstveto ) {
           fill(m_tools[m_histoGroups.at(i/2).at(m_partitions[i])],LBStdV);
        }
      }
    }
  } // End of test on RNB
 
  // event flagged by # of saturated quality cells
  uint8_t SatTightPartitions = noisyRO->SatTightFlaggedPartitions();
  if ( eventInfo->isEventFlagBitSet(xAOD::EventInfo::LAr,LArEventBitInfo::TIGHTSATURATEDQ) ) {
    auto LBSat = Monitored::Scalar<unsigned>("LBSat",LBN);
    auto LBSatV = Monitored::Scalar<unsigned>("LBSat_Veto",LBN);
    for (size_t i= 0;i<m_partitions.size();i++){
      if ( (SatTightPartitions & partMask[i]) != 0 ) {
        fill(m_tools[m_histoGroups.at(i/2).at(m_partitions[i])],LBSat);
    if ( ! burstveto ) {
           fill(m_tools[m_histoGroups.at(i/2).at(m_partitions[i])],LBSatV);
        }
      }
    }
  } // end of test on RNB-Saturated
 
 
  // event flagged by tight-MNB
  uint8_t MNBTightPartitions = noisyRO->MNBTightFlaggedPartitions();
  if ( MNBTightPartitions != 0) {
    auto LBMTight = Monitored::Scalar<unsigned>("LBMNBTight",LBN);
    auto LBMTightV = Monitored::Scalar<unsigned>("LBMNBTight_Veto",LBN);
    for (size_t i= 0;i<m_partitions.size();i++){
      if ( (MNBTightPartitions & partMask[i]) != 0 ) {
         fill(m_tools[m_histoGroups.at(i/2).at(m_partitions[i])],LBMTight);
     if ( ! burstveto ) {
            fill(m_tools[m_histoGroups.at(i/2).at(m_partitions[i])],LBMTightV);
         }
      }
    }
  } // End of test on MNB-Tight
 
  // event flagged by tight-MNB-PsVeto
  uint8_t MNBTight_PsVetoPartitions = noisyRO->MNBTight_PsVetoFlaggedPartitions();
  if ( MNBTight_PsVetoPartitions != 0) {
    auto LBMTight_PsVeto = Monitored::Scalar<unsigned>("LBMNBTight_PsVeto",LBN);
    auto LBMTight_PsVetoV = Monitored::Scalar<unsigned>("LBMNBTight_PsVeto_Veto",LBN);
    for (size_t i= 0;i<m_partitions.size();i++){
      if ( (MNBTight_PsVetoPartitions & partMask[i]) != 0 ) {
         fill(m_tools[m_histoGroups.at(i/2).at(m_partitions[i])],LBMTight_PsVeto);
         if ( ! burstveto ) {
            fill(m_tools[m_histoGroups.at(i/2).at(m_partitions[i])],LBMTight_PsVetoV);
         }
      }
    }
  } // End of test on MNB-Tight-PsVeto
 
  // event flagged by loose-MNB
  uint8_t MNBLoosePartitions = noisyRO->MNBLooseFlaggedPartitions();
  if ( MNBLoosePartitions != 0) {
    auto LBMLoose = Monitored::Scalar<unsigned>("LBMNBLoose",LBN);
    auto LBMLooseV = Monitored::Scalar<unsigned>("LBMNBLoose_Veto",LBN);
    for (size_t i= 0;i<m_partitions.size();i++){
      if ( (MNBLoosePartitions & partMask[i]) != 0 ) {
         fill(m_tools[m_histoGroups.at(i/2).at(m_partitions[i])],LBMLoose);
     if ( ! burstveto ) {
            fill(m_tools[m_histoGroups.at(i/2).at(m_partitions[i])],LBMLooseV);
         }
      }
    }
  } // end fo test on MNB-Loose
    
  return StatusCode::SUCCESS;
}
 
void LArNoisyROMonAlg::fillTriggerHisto(size_t partition, 
                                        unsigned long triggerbits, unsigned long L1triggerbits) const{
 
  auto trig = Monitored::Scalar<unsigned>("Triggers",0);
  if ( triggerbits ==0 ) {
     trig = m_EF_NoiseBurst_Triggers.size()+1;
     fill(m_tools[m_histoGroups.at(partition/2).at(m_partitions[partition])],trig);
  } else {
     for ( size_t i = 0; i < m_EF_NoiseBurst_Triggers.size(); i++) {
       if ( triggerbits & (0x1 << i) ) {
          trig = i+1;
          fill(m_tools[m_histoGroups.at(partition/2).at(m_partitions[partition])],trig);
       }
     }
  }
 
  auto l1trig = Monitored::Scalar<unsigned>("L1Triggers",0);
  if ( L1triggerbits ==0 ) {
     l1trig = m_L1_NoiseBurst_Triggers.size()+1;
     fill(m_tools[m_histoGroups.at(partition/2).at(m_partitions[partition])],l1trig);
  } else {
     for ( size_t i = 0; i < m_L1_NoiseBurst_Triggers.size(); i++) {
       if ( L1triggerbits & (0x1 << i) ) {
          l1trig = i+1;
          fill(m_tools[m_histoGroups.at(partition/2).at(m_partitions[partition])],l1trig);
       }
     }
  }
}