CTPSimulation.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
#ifndef TRIGT1CTP_CTPSIMULATION_H
#define TRIGT1CTP_CTPSIMULATION_H
 
 
#include "AthenaBaseComps/AthReentrantAlgorithm.h"
 
#include "GaudiKernel/ServiceHandle.h"
#include "GaudiKernel/ToolHandle.h"
#include "Gaudi/Property.h"
#include "StoreGate/DataHandle.h"
 
// monitoring from HLT
#include "GaudiKernel/ITHistSvc.h"
 
 
// data default location
#include "TrigT1Interfaces/TrigT1CaloDefs.h"
#include "TrigT1Interfaces/TrigT1StoreGateKeys.h"
 
// input/output data classes
#include "TrigT1Interfaces/MuCTPICTP.h"
#include "TrigT1Interfaces/EmTauCTP.h"
#include "TrigT1Interfaces/JetCTP.h"
#include "TrigT1Interfaces/EnergyCTP.h"
#include "TrigT1Interfaces/FrontPanelCTP.h"
#include "xAODTrigger/JetRoIContainer.h"
#include "xAODTrigger/EnergySumRoI.h"
#include "xAODTrigger/MuonRoIContainer.h"
#include "xAODTrigCalo/TrigEMClusterContainer.h"
#include "xAODTrigger/EmTauRoIContainer.h"
#include "TrigT1Result/CTP_RDO.h"// TODO obsolete it in favour of xAOD::CTPResult - see line below
#include "xAODTrigger/CTPResult.h"
#include "TrigT1Interfaces/CTPSLink.h"
#include "TrigT1Interfaces/ZdcCTP.h"
#include "TrigT1Interfaces/TrtCTP.h"
 
// new configuration data
#include "TrigConfData/L1Menu.h"
#include "TrigConfData/L1BunchGroupSet.h"
 
// internal
#include "./ItemMap.h"
#include "./ThresholdMap.h"
#include "./ResultBuilder.h"
 
#include "GaudiKernel/LockedHandle.h"
#include "AthenaKernel/RNGWrapper.h"
 
#include "TH1.h"
#include "TH2.h"
 
#include <map>
#include <string>
#include <mutex>
 
namespace LVL1 {
   class CPRoIDecoder;
   class JEPRoIDecoder;
}
 
namespace LVL1CTP {
 
   class CTPSimulation : public ::AthReentrantAlgorithm {
 
   public:
 
      CTPSimulation( const std::string& name, ISvcLocator* pSvcLocator );
      ~CTPSimulation();
 
      virtual StatusCode initialize() override;
 
      virtual StatusCode start() override;
 
      virtual StatusCode execute( const EventContext& context ) const override;
 
      virtual StatusCode stop() override;
 
 
   private:
      // histogramming related
      StatusCode bookHists();
      StatusCode setHistLabels(const TrigConf::L1Menu& l1menu);
      StatusCode createMultiplicityHist(const std::string & type, unsigned int maxMult = 10 );
      StatusCode setMultiplicityHistLabels(const TrigConf::L1Menu& l1menu, const std::string & type);
      StatusCode hbook(const std::string & path, std::unique_ptr<TH1> hist);
      StatusCode hbook(const std::string & path, std::unique_ptr<TH2> hist);
      StatusCode storeMetadata();
      LockedHandle<TH1> & get1DHist(const std::string & histName) const;
      LockedHandle<TH2> & get2DHist(const std::string & histName) const;
      std::string getBaseHistPath() const;
 
      // execution related
      StatusCode fillInputHistograms(const EventContext& context) const;
 
      StatusCode extractMultiplicities(std::map<std::string, unsigned int> & thrMultiMap, const EventContext& context) const;
 
      StatusCode simulateItems(const std::map<std::string, unsigned int> & thrMultiMap, const EventContext& context) const;
 
      unsigned int calculateMultiplicity    ( const TrigConf::L1Threshold & confThr, const TrigConf::L1Menu * l1menu, const EventContext& context ) const;
      unsigned int calculateJetMultiplicity ( const TrigConf::L1Threshold & confThr, const TrigConf::L1Menu * l1menu, const EventContext& context ) const;
      unsigned int calculateEMMultiplicity  ( const TrigConf::L1Threshold & confThr, const TrigConf::L1Menu * l1menu, const EventContext& context ) const;
      unsigned int calculateTauMultiplicity ( const TrigConf::L1Threshold & confThr, const TrigConf::L1Menu * l1menu, const EventContext& context ) const;
      unsigned int calculateMETMultiplicity ( const TrigConf::L1Threshold & confThr, const TrigConf::L1Menu * l1menu, const EventContext& context ) const;
      unsigned int calculateMuonMultiplicity( const TrigConf::L1Threshold & confThr, const TrigConf::L1Menu * l1menu, const EventContext& context ) const;
      unsigned int calculateTopoMultiplicity( const TrigConf::L1Threshold & confThr, const TrigConf::L1Menu * l1menu, const EventContext& context, bool UseLegacy ) const;
      unsigned int calculateTopoOptMultiplicity( const TrigConf::L1Threshold & confThr, const TrigConf::L1Menu * l1menu, const EventContext& context ) const;
 
      // Needed services and tools
      ServiceHandle<ITHistSvc> m_histSvc { this, "THistSvc", "THistSvc/THistSvc", "Histogramming svc" };
 
      ToolHandle<LVL1CTP::ResultBuilder> m_resultBuilder { this, "ResultBuilder", "LVL1CTP::ResultBuilder/ResultBuilder", "Builds the CTP result" };
 
      // random engine for calculating prescales
      ATHRNG::RNGWrapper m_RNGEngines;
 
      // thread safe histogram handlers
      std::map<std::string, LockedHandle<TH1>> m_hist1D;
      std::map<std::string, LockedHandle<TH2>> m_hist2D;
 
      // inputs
      // new L1Topo
      SG::ReadHandleKey<LVL1::FrontPanelCTP> m_iKeyTopo{ this, "TopoInput", LVL1::DEFAULT_L1TopoCTPLocation, "Input from topo" };
      // legacy L1Topo
      SG::ReadHandleKey<LVL1::FrontPanelCTP> m_iKeyLegacyTopo{ this, "LegacyTopoInput", LVL1::DEFAULT_L1TopoLegacyCTPLocation, "Input from legacy topo" };
      // MUCTPI
      SG::ReadHandleKey<LVL1::MuCTPICTP> m_iKeyMuctpi{ this, "MuctpiInput", LVL1MUCTPI::DEFAULT_MuonCTPLocation, "Input from Muctpi" };
      // CTPIN
      SG::ReadHandleKey<LVL1::EmTauCTP>  m_iKeyCtpinEM{  this, "CtpinEMInput",  LVL1::TrigT1CaloDefs::EmTauCTPLocation, "Input from CTPIN em and tau (legacy)" };
      SG::ReadHandleKey<LVL1::JetCTP>    m_iKeyCtpinJet{ this, "CtpinJetInput", LVL1::TrigT1CaloDefs::JetCTPLocation, "Input from CTPIN jet (legacy)" };
      SG::ReadHandleKey<LVL1::EnergyCTP> m_iKeyCtpinXE{  this, "CtpinXEInput",  LVL1::TrigT1CaloDefs::EnergyCTPLocation, "Input from CTPIN energy (te,xe,xs - legacy)" };
      // new FEX object collections (temporary until moved to L1Topo simulation)
      // jFEX
      SG::ReadHandleKey< xAOD::JetRoIContainer >  m_iKeyJFexJets {  this, "jFexJetInput",  "jRoundJets", "Input list of jFEX jets" };
      SG::ReadHandleKey< xAOD::JetRoIContainer >  m_iKeyJFexLJets{  this, "jFexLJetInput",  "jRoundLargeRJets", "Input list of jFEX large-R jets" };
      // gFEX
      SG::ReadHandleKey< xAOD::JetRoIContainer >  m_iKeyGFexJets    {  this, "gFexJetInput", "gL1Jets", "Input list of gFEX jets" };
      SG::ReadHandleKey< xAOD::EnergySumRoI >     m_iKeyGFexMETNC   {  this, "gFexMETNCInput", "gXENOISECUTPerf", "Input list of gFEX MET NC" };
      SG::ReadHandleKey< xAOD::EnergySumRoI >     m_iKeyGFexMETRho  {  this, "gFexMETRhoInput", "gXERHOPerf", "Input list of gFEX MET Rho" };
      SG::ReadHandleKey< xAOD::EnergySumRoI >     m_iKeyGFexMETJwoJ {  this, "gFexMETJwoJInput", "gXEJWOJPerf", "Input list of gFEX MET JwoJ" };
      // eFEX
      SG::ReadHandleKey< xAOD::TrigEMClusterContainer >  m_iKeyEFexCluster{  this, "eFexClusterInput", "SClusterCl", "Input list of eFEX cluster" };
      SG::ReadHandleKey< xAOD::EmTauRoIContainer >       m_iKeyEFexTau    {  this, "eFexTauInput", "SClusterTau", "Input list of eFEX tau" };
      // ZDC
      SG::ReadHandleKey<LVL1::ZdcCTP> m_iKeyZDC{this, "ZdcInput", LVL1::TrigT1CaloDefs::ZdcCTPLocation, "Input from Zdc"};
      // TRT
      SG::ReadHandleKey<LVL1::TrtCTP> m_iKeyTRT{this, "TrtInput", LVL1::DEFAULT_TrtCTPLocation, "Input from Trt"};
 
      // outputs
      SG::WriteHandleKey<CTP_RDO>  m_oKeyRDO  {this, "RDOOutput", LVL1CTP::DEFAULT_RDOOutputLocation, "Output of CTP RDO object (sim)"};
      SG::WriteHandleKey<xAOD::CTPResult>  m_oKeyCTPResult  {this, "CTPResultOutput", LVL1CTP::DEFAULT_CTPResultOutputLocation, "Output of CTPResult (sim)"};
      SG::WriteHandleKey<CTPSLink> m_oKeySLink{this, "ROIOutput", LVL1CTP::DEFAULT_CTPSLinkLocation, "Output of CTP SLink object (sim)"};
 
 
      // properties
      Gaudi::Property<bool> m_isData { this, "IsData", false, "emulate CTP as part of MC or rerun on data" };
      Gaudi::Property<std::string>  m_histPath { this, "HistPath",  "/EXPERT/L1", "Booking path for the histogram" };
      Gaudi::Property<bool> m_doZDC{this, "DoZDC", false, "emulate CTP with ZDC included"};
      Gaudi::Property<bool> m_doTRT{this, "DoTRT", false, "emulate CTP with TRT included"};
      Gaudi::Property<bool> m_forceBunchGroupPattern { this, "ForceBunchGroupPattern", true, "When true, ignore the bunchgroups and use the provided BunchGroupPattern" };
      Gaudi::Property<unsigned int> m_bunchGroupPattern { this, "BunchGroupPattern", 0x0003, "Bunchgroup pattern applied at every event, useful for simulation. Bit x corresponds to bunchgroup x" };
 
      Gaudi::Property<bool> m_doL1CaloLegacy { this, "DoL1CaloLegacy", false, "Use L1Calo legacy" };
      Gaudi::Property<bool> m_doL1Topo       { this, "DoL1Topo",       false, "Use L1Topo" };
      Gaudi::Property<bool> m_doL1TopoLegacy { this, "DoL1TopoLegacy", false, "Use L1Topo Legacy" };
      Gaudi::Property<bool> m_muonRun2Format { this, "MuonMultiplicityRun2Format", false, "Interpret muon multiplicity in Run 2 format (bit 0 unused)" };
     
      Gaudi::Property<bool> m_useEDMxAOD       { this, "UseEDMxAOD", false, "Use EDM based on xAOD class" };
 
      SG::ReadCondHandleKey<TrigConf::L1BunchGroupSet> m_bgKey{this, "L1BunchGroup", "L1BunchGroup", "L1BunchGroupSet key name"};
   };
 
}
 
#endif