TrigSignatureMoni.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
#ifndef TRIGSTEERMONITOR_TRIGSIGNATUREMONI_H
#define TRIGSTEERMONITOR_TRIGSIGNATUREMONI_H 1
 
#include <string>
#include <mutex>
#include <memory>
#include <vector>
#include <map>
#include <unordered_map>
 
#include <TH2.h>
 
#include "DecisionCollectorTool.h"
#include "TimeDivider.h"
 
#include "AthenaBaseComps/AthReentrantAlgorithm.h"
#include "GaudiKernel/IIncidentListener.h"
#include "GaudiKernel/ITHistSvc.h"
#include "GaudiKernel/LockedHandle.h"
#include "Gaudi/Utils/PeriodicAction.h"
#include "TrigCompositeUtils/TrigCompositeUtils.h"
#include "TrigConfData/HLTMenu.h"
#include "TrigConfData/L1Menu.h"
 
#include "CxxUtils/checker_macros.h"
 
// Forward declarations
class IIncidentSvc;

class TrigSignatureMoni : public extends<AthReentrantAlgorithm, IIncidentListener>
{ 
 public: 
  using base_class::base_class;
 
  virtual StatusCode  initialize() override;
  virtual StatusCode  start() override;
  virtual StatusCode  execute( const EventContext& context ) const override;
  virtual StatusCode  stop() override;
  virtual void handle( const Incident& incident ) override;
 
 private:
  // Class representing asynchronously published histograms
  class RateHistogram {
   public:
    RateHistogram() = default;
    ~RateHistogram();
 
    // Initialize rate histogram and create buffer
    StatusCode init( const std::string& histoName, const std::string& histoTitle,
      const int x, const int y, const std::string& registerPath, const ServiceHandle<ITHistSvc>& histSvc );
 
    // Get the histogram
    LockedHandle<TH2>& getHistogram ATLAS_NOT_CONST_THREAD_SAFE () const;
 
    // Get the histogram buffer
    LockedHandle<TH2>& getBuffer ATLAS_NOT_CONST_THREAD_SAFE () const;
 
    // Get rate histogram timer pointer
    std::unique_ptr<Gaudi::Utils::PeriodicAction>& getTimer();
 
    // Start the histogram timer with given duration and intervals
    void startTimer(unsigned int duration, unsigned int intervals);
 
    // Stop the histogram timer
    void stopTimer();
 
    // Fill the histogram with given bins x, y
    void fill(const double x, const double y) const;
 
   private:
    // Update the histogram with values from the buffer
    void updatePublished(unsigned int duration) const;
 
    // Callback to check if interval's duration passed and histogram should be published
    void callback();
 
    mutable LockedHandle<TH2> m_bufferHistogram ATLAS_THREAD_SAFE;
    mutable LockedHandle<TH2> m_histogram ATLAS_THREAD_SAFE;
    std::mutex m_mutex;
    std::unique_ptr<Gaudi::Utils::PeriodicAction> m_timer;
    std::unique_ptr<TimeDivider> m_timeDivider;
    unsigned int m_duration{0};
  };
 
  SG::ReadHandleKey<TrigCompositeUtils::DecisionContainer> m_l1DecisionsKey{ this, "L1Decisions", "HLTSeedingSummary", "Chains activated after the L1" };
  SG::ReadHandleKey<TrigCompositeUtils::DecisionContainer> m_finalDecisionKey{ this, "FinalDecisionKey", "HLTNav_Summary", "Final stage of all decisions" };
  SG::ReadHandleKey<TrigConf::HLTMenu> m_HLTMenuKey{ this, "HLTTriggerMenu", "DetectorStore+HLTTriggerMenu", "HLT Menu" };
  SG::ReadHandleKey<TrigConf::L1Menu> m_L1MenuKey{ this, "L1TriggerMenu", "DetectorStore+L1TriggerMenu", "L1 Menu" };
  
  ServiceHandle<IIncidentSvc> m_incidentSvc{ this, "IncidentSvc", "IncidentSvc", "Incident service"};
  ServiceHandle<ITHistSvc> m_histSvc{ this, "THistSvc", "THistSvc/THistSvc", "Histogramming svc" };
  Gaudi::Property<std::string> m_bookingPath{ this, "HistPath", "/EXPERT/HLTFramework", "Booking path for the histogram"};
 
  // Necessary for asynchronous calling callback function
  Gaudi::Property<unsigned int> m_duration {this, "RateIntegrationDuration", 10, "Integration time for the rate histogram in seconds"};
  Gaudi::Property<unsigned int> m_intervals {this, "RateIntegrationIntervals", 6, "Number of the rate histogram publications"};
 
  ToolHandleArray<DecisionCollectorTool> m_decisionCollectorTools{ this, "DecisionCollectorTools", {}, "Tools that collect decisions (yes/no) for steps" };
  ToolHandleArray<DecisionCollectorTool> m_featureCollectorTools{ this, "FeatureCollectorTools", {}, "Tools that collect decision counts for specific features for steps" };
 
  // Histograms
  mutable LockedHandle<TH2> m_passHistogram ATLAS_THREAD_SAFE;
  mutable LockedHandle<TH2> m_countHistogram ATLAS_THREAD_SAFE;
  RateHistogram m_rateHistogram;
  RateHistogram m_sequenceHistogram;
 
  // Unordered maps for fast lookup
  std::unordered_map<unsigned int, int> m_chainIDToBinMap; 
  std::unordered_map<std::string, int> m_nameToBinMap; 
  std::unordered_map<std::string, int> m_sequenceToBinMap; 
 
  // Regular maps for ordered iteration
  std::map<std::string, TrigCompositeUtils::DecisionIDContainer> m_groupToChainMap; 
  std::map<std::string, TrigCompositeUtils::DecisionIDContainer> m_streamToChainMap; 
  std::map<std::string, TrigCompositeUtils::DecisionIDContainer> m_expressChainMap; 
 
  // Returns number of chains + groups + sequencers based on the menu handle
  int nBinsX(SG::ReadHandle<TrigConf::HLTMenu>& ) const;
 
  // Returns number of chains + groups + sequencers based of size of m_chainIDToBinMap
  int nBinsX() const;
 
  // Returns number of chains based on the menu handle
  int nChains(SG::ReadHandle<TrigConf::HLTMenu>& ) const;
 
  // Returns number of steps
  int nSteps() const;
 
  // Init different types of histograms
  StatusCode initHist(LockedHandle<TH2>&, SG::ReadHandle<TrigConf::HLTMenu>&, bool = true);
  StatusCode initSeqHist(LockedHandle<TH2>&, std::set<std::string>&);
  
  // Fill different types of histograms
  StatusCode fillDecisionCount(const std::vector<TrigCompositeUtils::DecisionID>& , int) const;
  StatusCode fillPassEvents(const TrigCompositeUtils::DecisionIDContainer&, int) const;
  StatusCode fillRate(const TrigCompositeUtils::DecisionIDContainer&, int) const;
  StatusCode fillHistogram(const TrigCompositeUtils::DecisionIDContainer&, int, LockedHandle<TH2>&) const;
  StatusCode fillSequences(const std::set<std::string>&) const;
  StatusCode fillStreamsAndGroups(const std::map<std::string, TrigCompositeUtils::DecisionIDContainer>&, const TrigCompositeUtils::DecisionIDContainer&, int) const;
};
 
#endif //> !TRIGSTEERMONITOR_TRIGSIGNATUREMONI_H