L1TopoSimulation.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#include "L1TopoSimulation.h"
 
// General Athena/Gaudi includes
#include "AthenaBaseComps/AthAlgTool.h"
 
// Histogram Service
#include "AthenaL1TopoHistSvc.h"
 
// Trigger includes
#include "TrigConfData/L1ThrExtraInfo.h"
#include "TrigT1Interfaces/TrigT1CaloDefs.h"
#include "TrigT1CaloEvent/EmTauROI_ClassDEF.h"
 
 
// L1Topo includes
#include "L1TopoConfig/L1TopoMenu.h"
#include "L1TopoEvent/TopoInputEvent.h"
#include "L1TopoCommon/Types.h"
 
#include "L1TopoInterfaces/IL1TopoHistSvc.h"
 
#include "L1TopoRDO/BlockTypes.h"
#include "L1TopoRDO/Header.h"
#include "L1TopoRDO/Helpers.h"
#include "L1TopoRDO/L1TopoTOB.h"
#include "L1TopoRDO/L1TopoRDOCollection.h"
#include "L1TopoRDO/L1TopoResult.h"
 
// xAOD
#include "xAODTrigger/L1TopoSimResults.h"
#include "xAODTrigger/L1TopoSimResultsAuxContainer.h"
 
using namespace LVL1;
 
 
L1TopoSimulation::L1TopoSimulation(const std::string &name, ISvcLocator *pSvcLocator) :
   AthAlgorithm(name, pSvcLocator),
   m_topoSteering( std::make_unique<TCS::TopoSteering>() ),
   m_scaler( std::make_unique<LVL1::PeriodicScaler>() )
{
}
 
 
bool
L1TopoSimulation::isClonable() const
{
   return true;
}
 
StatusCode
L1TopoSimulation::initialize ATLAS_NOT_THREAD_SAFE () {
   ATH_MSG_INFO("initialize");
 
   m_topoSteering->setMsgLevel( TrigConf::MSGTC::Level((int)m_topoSteeringOutputLevel) );
 
   m_topoSteering->setLegacyMode(m_isLegacyTopo);
   
   ATH_MSG_DEBUG("retrieving " << m_histSvc);
   CHECK( m_histSvc.retrieve() );
 
   if (m_emtauInputProvider.isEnabled()) {
      ATH_MSG_DEBUG("retrieving " << m_emtauInputProvider);
      CHECK( m_emtauInputProvider.retrieve() );
   }
   
   if (m_jetInputProvider.isEnabled()) {
      ATH_MSG_DEBUG("retrieving " << m_jetInputProvider);
      CHECK( m_jetInputProvider.retrieve() );
   }
   
   if (m_energyInputProvider.isEnabled()) {
      ATH_MSG_DEBUG("retrieving " << m_energyInputProvider);
      CHECK( m_energyInputProvider.retrieve() );
   }
   
   if (m_muonInputProvider.isEnabled()) {
      ATH_MSG_DEBUG("retrieving " << m_muonInputProvider);
      CHECK( m_muonInputProvider.retrieve(DisableTool{m_isLegacyTopo}) );
   }
   
   ATH_MSG_DEBUG("retrieving " << m_ControlHistSvc);
   CHECK( m_ControlHistSvc.retrieve());
 
   CHECK(m_l1topoRawDataKey.initialize(m_fillHistogramsBasedOnHardwareDecision));
 
   CHECK(m_legacyTopoCTPLocation.initialize(m_isLegacyTopo));
   CHECK(m_legacyTopoOverflowCTPLocation.initialize(m_isLegacyTopo));
   CHECK(m_topoCTPLocation.initialize(!m_isLegacyTopo));
   CHECK(m_topoOverflowCTPLocation.initialize(!m_isLegacyTopo));
   if (m_isLegacyTopo){
     ATH_MSG_DEBUG("Legacy output trigger key property " << m_legacyTopoCTPLocation);
     ATH_MSG_DEBUG("Legacy output overflow key property " << m_legacyTopoOverflowCTPLocation);
   }
   else {
     ATH_MSG_DEBUG("Output trigger key property " << m_topoCTPLocation);
     ATH_MSG_DEBUG("Output overflow key property " << m_topoOverflowCTPLocation);
   }
   
   ATH_MSG_DEBUG("Prescale factor set to " << m_prescale);
   ATH_MSG_DEBUG("PrescaleDAQROBAccess factor set to " << m_prescaleForDAQROBAccess);
   ATH_MSG_DEBUG("FillHistoBasedOnHardware " << m_fillHistogramsBasedOnHardwareDecision);
   if(m_fillHistogramsBasedOnHardwareDecision and
      (m_prescaleForDAQROBAccess % m_prescale)) {
      ATH_MSG_FATAL("PrescaleDAQROBAccess must be a multiple of Prescale"
                    <<" : current values :"
                    <<" "<<m_prescaleForDAQROBAccess
                    <<", "<<m_prescale);
      return StatusCode::FAILURE;
   }
 
   const TrigConf::L1Menu * l1menu = nullptr;
   ATH_CHECK( detStore()->retrieve(l1menu) ); 
   ATH_MSG_INFO( "initialize(): retrieving new-style L1 trigger menu from Detector Store" );
   
   // retrieve cXE coefficients from menu and pass them to the m_jetInputProvider (if it's a jFEXInputProvider)
   // Cannot set properties on IInputTOBConverter instances, 
   // but (relevant) inputProvider also inherits from AthAlgTool
   AthAlgTool* jetProviderAsAlgTool = dynamic_cast<AthAlgTool*>( m_jetInputProvider.get() ); 
   // if there is no particular cXE threshold defined the corresponding extraInfo is not populated!
   if ( jetProviderAsAlgTool && l1menu->thrExtraInfo().hasInfo("cXE") ) {
      const TrigConf::L1ThrExtraInfo_cXE & cXeExtraInfo = l1menu->thrExtraInfo().cXE();
      if ( jetProviderAsAlgTool->hasProperty("cXEweight_jFEX") ) {  
         float jXEweight = cXeExtraInfo.jXeWeight();
         jetProviderAsAlgTool->setProperty("cXEweight_jFEX", jXEweight).ignore();
      }
      if ( jetProviderAsAlgTool->hasProperty("cXEweight_gFEX") ) {  
         float gXEweight = cXeExtraInfo.gXeWeight();
         jetProviderAsAlgTool->setProperty("cXEweight_gFEX", gXEweight).ignore();
      }
   }
   
   m_topoSteering->setUseBitwise(m_enableBitwise);
   try {
      m_topoSteering->setupFromConfiguration(*l1menu);
   }
   catch(std::exception & e) {
      ATH_MSG_FATAL("Caught exception when configuring topo steering from menu: " << e.what() );
      return StatusCode::FAILURE;
   }
 
   m_topoSteering->setAlgMsgLevel( TrigConf::MSGTC::Level((int)m_topoOutputLevel) );
   m_topoSteering->setOutputAlgosFillBasedOnHardware(m_fillHistogramsBasedOnHardwareDecision);
 
   if (m_doMonitoring) {ATH_CHECK(m_ControlHistSvc->SetHistSvc(m_topoSteering, m_histBaseDir.value()));}
 
   ATH_CHECK(m_legacyL1topoKey.initialize(m_isLegacyTopo));
   ATH_CHECK(m_l1topoKey.initialize(!m_isLegacyTopo));
   
   return StatusCode::SUCCESS;
}
 
 
// Exectued once per offline job and for every new run online
StatusCode
L1TopoSimulation::start() {
   ATH_MSG_DEBUG("start");
 
   m_scaler->reset();
 
   try {
      m_topoSteering->initializeAlgorithms();
   }
   catch(std::exception & e) {
      ATH_MSG_FATAL("Caught exception when initializing topo algorithms" << e.what() );
      return StatusCode::FAILURE;
   }
 
   if( m_enableInputDump ) {
      m_topoSteering->inputEvent().enableInputDump( m_inputDumpFile );
      m_topoSteering->inputEvent().dumpStart();
   }
 
   return StatusCode::SUCCESS;
}
 
 
 
StatusCode
L1TopoSimulation::execute(const EventContext& ctx) {
 
   if (m_prescale>1 && not m_scaler->decision(m_prescale)){
      ATH_MSG_DEBUG( "This event not processed due to prescale");
      return StatusCode::SUCCESS;
      // do not record dummy output: 
      // LVL1::FrontPanelCTP is initialised with all 6 32-bit words set to 0 which is valid data
      // LVL1::FrontPanelCTP * topo2CTP = new LVL1::FrontPanelCTP();
      // CHECK(evtStore()->record( topo2CTP, m_topoCTPLocation ));
   } 
   else {
     ATH_MSG_DEBUG( "This event is processed - not prescaled");
   }
 
   // reset input and internal state
   m_topoSteering->reset();
 
   // fill the L1Topo Input Event
   TCS::TopoInputEvent & inputEvent = m_topoSteering->inputEvent();
 
   inputEvent.setEventInfo(ctx.eventID().run_number(),
                           ctx.eventID().event_number(),
                           ctx.eventID().lumi_block(),
                           ctx.eventID().bunch_crossing_id());
 
   // EM TAU
   if (m_emtauInputProvider.isEnabled()) {
      CHECK(m_emtauInputProvider->fillTopoInputEvent(inputEvent));
   }
   // JET
   if (m_jetInputProvider.isEnabled()) {
      CHECK(m_jetInputProvider->fillTopoInputEvent(inputEvent));
   }
   // ET sum, ET miss
   if (m_energyInputProvider.isEnabled()) {
      CHECK(m_energyInputProvider->fillTopoInputEvent(inputEvent));
   }
   // Muon
   if (m_muonInputProvider.isEnabled()) {
      CHECK(m_muonInputProvider->fillTopoInputEvent(inputEvent));
   }
 
   ATH_MSG_DEBUG("" << inputEvent);
 
   inputEvent.dump();
   
   if(m_fillHistogramsBasedOnHardwareDecision){
     if (retrieveHardwareDecision(m_isLegacyTopo, ctx).isSuccess()) {
       m_topoSteering->propagateHardwareBitsToAlgos();
       m_topoSteering->setOutputAlgosSkipHistograms(false);
     }
     else {
       m_topoSteering->setOutputAlgosSkipHistograms(true);
     }
     if (!m_scaler->decision(m_prescaleForDAQROBAccess) and m_prescaleForDAQROBAccess>1) {
       m_topoSteering->setOutputAlgosSkipHistograms(true);
     }
   }
 
   // execute the toposteering
   m_topoSteering->executeEvent();
 
   ATH_MSG_DEBUG("Global Decision:\n" << m_topoSteering->simulationResult().globalOutput());
   

 
   // Format for CTP still undecided
 
   const TCS::GlobalOutput & globalOutput = m_topoSteering->simulationResult().globalOutput();
   auto topoOutput2CTP = std::make_unique< LVL1::FrontPanelCTP >();
   auto topoOverflow2CTP = std::make_unique< LVL1::FrontPanelCTP >();
 
   const TrigConf::L1Menu * l1menu = nullptr;
   ATH_CHECK( detStore()->retrieve(l1menu) );
 
 
   SG::WriteHandle<xAOD::L1TopoSimResultsContainer> outputHandle(m_isLegacyTopo ? m_legacyL1topoKey : m_l1topoKey, ctx);
   ATH_MSG_DEBUG("  write: " << outputHandle.key() << " = " << "..." );
   ATH_CHECK(outputHandle.record(std::make_unique<xAOD::L1TopoSimResultsContainer>(), std::make_unique<xAOD::L1TopoSimResultsAuxContainer>()));
    
   
   if( m_isLegacyTopo ) {
     // set electrical connectors 
     std::string conn1 = l1menu->board("LegacyTopo0").connectorNames()[0];
     std::string conn2 = l1menu->board("LegacyTopo1").connectorNames()[0];
     for(unsigned int clock=0; clock<2; ++clock) {
       topoOutput2CTP->setCableWord0( clock, 0 ); // ALFA
       ATH_MSG_DEBUG("Word 1 " << conn1 << " clock " << clock << "  " << globalOutput.decision_field( conn1, clock) );
       topoOutput2CTP->setCableWord1( clock, globalOutput.decision_field( conn1, clock) );  // TOPO 0
       WriteEDM(outputHandle,conn1,clock,globalOutput.decision_field( conn1, clock));
       ATH_MSG_DEBUG("Word 2 " << conn2 << " clock " << clock << "  " << globalOutput.decision_field( conn2, clock) );
       topoOutput2CTP->setCableWord2( clock, globalOutput.decision_field( conn2, clock) );  // TOPO 1
       WriteEDM(outputHandle,conn2,clock,globalOutput.decision_field( conn2, clock));
       // topoOverflow2CTP->setCableWord0( clock, 0 ); // ALFA
       // topoOverflow2CTP->setCableWord1( clock, dec.overflow( 0, clock) );  // TOPO 0
       // topoOverflow2CTP->setCableWord2( clock, dec.overflow( 1, clock) );  // TOPO 1
     }    
    
     CHECK(SG::makeHandle(m_legacyTopoCTPLocation, ctx)        .record(std::move(topoOutput2CTP)));
     CHECK(SG::makeHandle(m_legacyTopoOverflowCTPLocation, ctx).record(std::move(topoOverflow2CTP)));
     
   } else {
     // set electrical connectors 
     std::string conn1 = l1menu->board("Topo2").connectorNames()[0];
     std::string conn2 = l1menu->board("Topo3").connectorNames()[0];
     for(unsigned int clock=0; clock<2; ++clock) {
       ATH_MSG_DEBUG("Word 1 " << conn1 << " clock " << clock << "  " << globalOutput.decision_field( conn1, clock) );
       topoOutput2CTP->setCableWord1( clock, globalOutput.decision_field( conn1, clock) | globalOutput.overflow_field(conn1, clock) );  // TOPO 0
       WriteEDM(outputHandle,conn1,clock,globalOutput.decision_field( conn1, clock));
       ATH_MSG_DEBUG("Word 2 " << conn2 << " clock " << clock << "  " << globalOutput.decision_field( conn2, clock) );
       topoOutput2CTP->setCableWord2( clock, globalOutput.decision_field( conn2, clock) | globalOutput.overflow_field(conn2, clock) );  // TOPO 1
       WriteEDM(outputHandle,conn2,clock,globalOutput.decision_field( conn2, clock));
       
       topoOverflow2CTP->setCableWord0( clock, 0 ); // ALFA
       topoOverflow2CTP->setCableWord1( clock, globalOutput.overflow_field( conn1, clock) );  // TOPO 0
       WriteEDM_Overflow(outputHandle,"Overflow"+conn1,clock,globalOutput.overflow_field( conn1, clock));
       topoOverflow2CTP->setCableWord2( clock, globalOutput.overflow_field( conn2, clock) );  // TOPO 1
       WriteEDM_Overflow(outputHandle,"Overflow"+conn2,clock,globalOutput.overflow_field( conn2, clock));
 
       WriteEDM(outputHandle,"Ambiguity"+conn1,clock,globalOutput.ambiguity_field( conn1, clock));
       WriteEDM(outputHandle,"Ambiguity"+conn2,clock,globalOutput.ambiguity_field( conn2, clock));
     }    
 
     // set optical connectors
     for( const auto& connOpt : l1menu->board("Topo1").connectorNames() ) {
       auto outputOpt = globalOutput.count_field(connOpt);
       std::bitset<64> outputOpt_1(outputOpt.to_string());
       std::bitset<64> outputOpt_2((outputOpt<<64).to_string());
       topoOutput2CTP->setOptCableWord( connOpt, outputOpt );
       WriteEDM(outputHandle,connOpt,1,outputOpt_1.to_ulong());
       WriteEDM(outputHandle,connOpt,0,outputOpt_2.to_ulong());
     }
    
     CHECK(SG::makeHandle(m_topoCTPLocation, ctx)        .record(std::move(topoOutput2CTP)));
     CHECK(SG::makeHandle(m_topoOverflowCTPLocation, ctx).record(std::move(topoOverflow2CTP)));
   }
 
   return StatusCode::SUCCESS;
}
 
 
StatusCode
L1TopoSimulation::finalize() {
   m_topoSteering->inputEvent().dumpFinish();
   return StatusCode::SUCCESS;
}
 
void
L1TopoSimulation::WriteEDM(SG::WriteHandle<xAOD::L1TopoSimResultsContainer> &handle, const std::string &name, unsigned int clock, uint32_t word) {
 
  handle->push_back(std::make_unique<xAOD::L1TopoSimResults>());
  handle->back()->setConnectionId(TCS::outputType(name));
  handle->back()->setClock(clock);
  handle->back()->setBitWidth(32);
  handle->back()->setTopoWord(word);
 
  ATH_MSG_DEBUG( "L1Topo EDM:: Connection Id: " << handle->back()->connectionId() << " Clock: " << handle->back()->clock() << " Decision: " << handle->back()->topoWord() );
}
 
void
L1TopoSimulation::WriteEDM_Overflow(SG::WriteHandle<xAOD::L1TopoSimResultsContainer> &handle, const std::string &name, unsigned int clock, uint32_t word) {
 
  handle->push_back(std::make_unique<xAOD::L1TopoSimResults>());
  handle->back()->setConnectionId(TCS::outputType(name));
  handle->back()->setClock(clock);
  handle->back()->setBitWidth(32);
  handle->back()->setTopoWordOverflow(word);
 
  ATH_MSG_DEBUG( "L1Topo EDM:: Connection Id: " << handle->back()->connectionId() << " Clock: " << handle->back()->clock() << " Decision: " << handle->back()->topoWord() );
}
 
void
L1TopoSimulation::WriteEDM(SG::WriteHandle<xAOD::L1TopoSimResultsContainer> &handle, const std::string &name, unsigned int clock, uint64_t word) {
  
  handle->push_back(std::make_unique<xAOD::L1TopoSimResults>());
  handle->back()->setConnectionId(TCS::outputType(name));
  handle->back()->setClock(clock);
  handle->back()->setBitWidth(64);
  handle->back()->setTopoWord64(word);
 
  ATH_MSG_DEBUG( "L1Topo EDM:: Connection Id: " << handle->back()->connectionId() << " Clock: " << handle->back()->clock() << " Decision: " << handle->back()->topoWord() );
}
 
void
L1TopoSimulation::WriteEDM_Overflow(SG::WriteHandle<xAOD::L1TopoSimResultsContainer> &handle, const std::string &name, unsigned int clock, uint64_t word) {
  
  handle->push_back(std::make_unique<xAOD::L1TopoSimResults>());
  handle->back()->setConnectionId(TCS::outputType(name));
  handle->back()->setClock(clock);
  handle->back()->setBitWidth(64);
  handle->back()->setTopoWord64Overflow(word);
 
  ATH_MSG_DEBUG( "L1Topo EDM:: Connection Id: " << handle->back()->connectionId() << " Clock: " << handle->back()->clock() << " Decision: " << handle->back()->topoWord() );
}
 
StatusCode
L1TopoSimulation::retrieveHardwareDecision(bool isLegacy, const EventContext& ctx)
{
  if (isLegacy) {return hardwareDecisionLegacy();}
  else          {return hardwareDecisionPhase1(ctx);}
}
 
StatusCode
L1TopoSimulation::hardwareDecisionLegacy()
{
    // some duplication with L1TopoRDO::Helpers
    // getDecisionAndOverflowBits() ?
    StatusCode sc = StatusCode::SUCCESS;
    std::bitset<TCS::TopoSteering::numberOfL1TopoBits> hardwareDaqRobTriggerBits;
    std::bitset<TCS::TopoSteering::numberOfL1TopoBits> hardwareDaqRobOvrflowBits;
    bool prescalForDAQROBAccess = true; // DG-2017-06-30 decide what to do when the hdw dec is not to be retrieved
    if (prescalForDAQROBAccess){
        std::vector<L1Topo::L1TopoTOB> daqTobsBC0;
        std::vector<uint32_t> tobsbc0SourceIds; // to compute bit indices
        const L1TopoRDOCollection* rdos = 0;
        sc = evtStore()->retrieve(rdos);
        if (sc.isFailure() or 0 == rdos) {
            ATH_MSG_INFO ( "Could not retrieve L1Topo DAQ RDO collection from StoreGate" );
        } else if (rdos->empty()) {
            ATH_MSG_INFO ( "L1Topo DAQ RDO collection is empty" );
        } else {
            for (const L1TopoRDO* rdo : *rdos){
                const std::vector<uint32_t> cDataWords = rdo->getDataWords();
                // initialise header: set version 15, BCN -7, which is unlikely
                L1Topo::Header header(0xf,0,0,0,0,1,0x7);
                for (const uint32_t word : cDataWords){
                    switch (L1Topo::blockType(word)){
                    case L1Topo::BlockTypes::HEADER: {
                        header = L1Topo::Header(word);
                        break;
                    }
                    case L1Topo::BlockTypes::L1TOPO_TOB: {
                        auto tob = L1Topo::L1TopoTOB(word);
                        if (header.bcn_offset()==0){
                            daqTobsBC0.push_back(tob);
                            tobsbc0SourceIds.push_back(rdo->getSourceID());
                        }
                        break;
                    }
                    default: break;
                    }
                } // for(word)
            } // for(rdo)
        }
        for(uint32_t iTob=0; iTob<daqTobsBC0.size(); ++iTob){
            const L1Topo::L1TopoTOB &tob = daqTobsBC0[iTob];
            const uint32_t &sourceId = tobsbc0SourceIds[iTob];
            for(unsigned int i=0; i<8; ++i){
                unsigned int index = L1Topo::triggerBitIndexNew(sourceId, tob, i);
                hardwareDaqRobTriggerBits[index] = (tob.trigger_bits()>>i)&1;
                hardwareDaqRobOvrflowBits[index] = (tob.overflow_bits()>>i)&1;
            }
        }
        m_topoSteering->setHardwareBits(hardwareDaqRobTriggerBits,
                                        hardwareDaqRobOvrflowBits);
    }
    return sc;
}
 
 
StatusCode
L1TopoSimulation::hardwareDecisionPhase1(const EventContext& ctx)
{
    // some duplication with L1TopoRDO::Helpers
    // getDecisionAndOverflowBits() ?
  StatusCode sc = StatusCode::SUCCESS;
    
  std::bitset<TCS::TopoSteering::numberOfL1TopoBits> hardwareDaqRobTriggerBits;
  std::bitset<TCS::TopoSteering::numberOfL1TopoBits> hardwareDaqRobOvrflowBits;
 
  SG::ReadHandle<xAOD::L1TopoRawDataContainer> cont(m_l1topoRawDataKey, ctx);
  if(!cont.isValid()){
    ATH_MSG_FATAL("Could not retrieve L1Topo RAW Data Container from the BS data.");
    return StatusCode::FAILURE;
  }
 
  std::unique_ptr<L1Topo::L1TopoResult> l1topoResult = std::make_unique<L1Topo::L1TopoResult>(*cont);
  if (!l1topoResult->getStatus()) {
    ATH_MSG_WARNING("Decoding L1Topo results failed!!");
    return StatusCode::FAILURE;
  }
  hardwareDaqRobTriggerBits = l1topoResult->getDecisions();
  hardwareDaqRobOvrflowBits = l1topoResult->getOverflows();
 
 
  
  m_topoSteering->setHardwareBits(hardwareDaqRobTriggerBits,
                  hardwareDaqRobOvrflowBits);
  
  return sc;
}