d4/d34/RatesAnalysisAlg_8h_source.html

/*

  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration

*/


#ifndef RATESANALYSIS_RATESANALYSISALG_H

#define RATESANALYSIS_RATESANALYSISALG_H 1


#include "AthAnalysisBaseComps/AthAnalysisAlgorithm.h"

#include "AthAnalysisBaseComps/AthAnalysisHelper.h"


#include "EnhancedBiasWeighter/EnhancedBiasWeighter.h"


#include "TrigDecisionTool/TrigDecisionTool.h"


#include "Gaudi/Parsers/Factory.h" // Gaudi::Property<std::map<std::string, std::map<std::string, double>>>


#include "RatesTrigger.h"

#include "RatesScanTrigger.h"

#include "RatesGroup.h"


#include "TTree.h"


#include <unordered_set>


namespace TrigConf {

   class ITrigConfigSvc;

}


class RatesAnalysisAlg: public ::AthAnalysisAlgorithm {

 public:

  enum Method_t{

    kMANUAL,

    kAUTO,

    kEXISTING

  };


  RatesAnalysisAlg( const std::string& name, ISvcLocator* pSvcLocator );

  virtual ~RatesAnalysisAlg();

  virtual StatusCode ratesInitialize() = 0;

  virtual StatusCode ratesExecute() = 0;

  virtual StatusCode ratesFinalize() = 0;


  StatusCode newTrigger(const std::string& name,

    const double prescale = 1.,

    const double expressPrescale = -1.,

    const std::string& seedName = "",

    const double seedPrecale = 1.,

    const std::string& groups = "",

    const Method_t method = kMANUAL,

    const ExtrapStrat_t extrapolation = kLINEAR);


  StatusCode newTrigger(const std::string& name,

    const double prescale = 1.,

    const double expressPrescale = -1.,

    const std::string& seedName = "",

    const double seedPrecale = 1.,

    const std::set<std::string>& groups = std::set<std::string>(),

    const Method_t method = kMANUAL,

    const ExtrapStrat_t extrapolation = kLINEAR);


  StatusCode newScanTrigger(const std::string& name,

    const double thresholdMin,

    const double thresholdMax,

    const uint32_t thresholdBins = 100,

    const RatesScanTrigger::TriggerBehaviour_t behaviour = RatesScanTrigger::TriggerBehaviour_t::kTriggerBelowThreshold,

    const double prescale = 1.,

    const std::string& seedName = "",

    const double seedPrecale = 1.,

    const Method_t method = kMANUAL,

    const ExtrapStrat_t extrapolation = kLINEAR);


  StatusCode newScanTrigger(const std::string& name,

    const std::vector<double>& thresholdBinEdges,

    const RatesScanTrigger::TriggerBehaviour_t behaviour = RatesScanTrigger::TriggerBehaviour_t::kTriggerAboveThreshold,

    const double prescale = 1.,

    const std::string& seedName = "",

    const double seedPrecale = 1.,

    const Method_t method = kMANUAL,

    const ExtrapStrat_t extrapolation = kLINEAR);


  StatusCode addAllExisting();


  StatusCode addExisting(const std::string& pattern);


  StatusCode setTriggerDesicison(const std::string& name, const bool triggerIsPassed = true, const bool triggerIsActive = true);


  StatusCode setTriggerDesicison(const std::string& name, const double threshold);


  void setTargetLumiMu(const double lumi, const double mu);


  void setTargetLumiBunches(const double lumi, const int32_t bunches);


  void setTargetMuBunches(const double mu, const int32_t bunches);


  void setTargetLumi(const double lumi) { setTargetLumiBunches(lumi, EnhancedBiasWeighter::FULL_RING); }


  void setTargetMu(const double mu) { setTargetMuBunches(mu, EnhancedBiasWeighter::FULL_RING); }


  void setExponentialMuScalingFactor(const double f) { m_expoScalingFactor = f; }


 protected:

  virtual StatusCode initialize();

  double m_linearLumiFactor;

  WeightingValuesSummary_t m_weightingValues;

  double m_ratesDenominator;

  Gaudi::Property<bool> m_doHistograms{this, "DoHistograms", true, "Switch on histogram output of rate vs. mu and position in train."};


 private:


  virtual StatusCode execute();

  virtual StatusCode finalize();


  StatusCode populateTriggers();

  StatusCode executeTrigDecisionToolTriggers();

  StatusCode executeTriggerEmulation();


  StatusCode checkExistingTrigger(const std::string& name, const std::string& seedName);

  StatusCode checkGotTDT();


  void printInputSummary() const;


  void printStatistics() const;

  void printTarget() const;

  void writeMetadata();


  bool isCPS(const std::string& group) const;


  bool isRandomSeed(const std::string& me, const std::string& seed) const;


  uint32_t getLevel(const std::string& name) const;


  bool isZero(double v) const { return fabs(v) < 1e-10; }


  std::unordered_map<std::string, std::unique_ptr<RatesTrigger>> m_triggers;

  std::unordered_map<std::string, std::unique_ptr<RatesScanTrigger>> m_scanTriggers;

  std::unordered_map<std::string, std::unique_ptr<RatesGroup>> m_groups;

  std::unordered_map<std::string, std::unique_ptr<RatesGroup>> m_globalGroups;

  std::unordered_map<std::string, std::unique_ptr<RatesGroup>> m_uniqueGroups;


  std::unordered_set<RatesTrigger*> m_activatedTriggers;

  std::unordered_set<RatesTrigger*> m_expressTriggers;

  std::unordered_set<RatesGroup*> m_activeGroups;

  std::unordered_map<size_t, double> m_lowestPrescale;

  std::vector<std::string> m_autoTriggers;


  std::unordered_map<std::string, const Trig::ChainGroup*> m_existingTriggers;

  std::unordered_map<std::string, std::string> m_lowerTrigger;


  std::vector<std::vector<std::string>> m_hltChainIDGroup;

  std::vector<std::vector<std::string>> m_l1ItemID;


  const std::string m_l1GroupName = "L1";

  const std::string m_l2GroupName = "HLT";

  const std::string m_expressGroupName = "Express";


  ToolHandle<IEnhancedBiasWeighter> m_enhancedBiasRatesTool{this, "EnhancedBiasRatesTool", "EnhancedBiasWeighter/EnhancedBiasRatesTool"};

  ToolHandle<Trig::TrigDecisionTool> m_tdt{this, "TrigDecisionTool", "Trig::TrigDecisionTool/TrigDecisionTool"};

  ServiceHandle<TrigConf::ITrigConfigSvc> m_configSvc{this, "TrigConfigSvc", "TrigConf::xAODConfigSvc"};


  Gaudi::Property<double> m_expoScalingFactor{this, "ExpoScalingFactor", 0.1, "Optional. Exponential factor if using exponential-mu rates scaling."};

  Gaudi::Property<double> m_inelasticCrossSection{this, "InelasticCrossSection", 8e-26, "Inelastic cross section in units cm^2. Default 80 mb at 13 TeV."};

  Gaudi::Property<bool> m_doUniqueRates{this, "DoUniqueRates", false, "Calculate unique rates for all chains (slow). Requires DoGlobalGroups=True too."};

  Gaudi::Property<bool> m_doGlobalGroups{this, "DoGlobalGroups", false, "Calculate total rates for each trigger level."};

  Gaudi::Property<bool> m_doTriggerGroups{this, "DoTriggerGroups", false, "Calculate total rates for each group of triggers."};

  Gaudi::Property<bool> m_doExpressRates{this, "DoExpressRates", false, "Calculate total rates for the express stream."};

  Gaudi::Property<bool> m_useBunchCrossingData{this, "UseBunchCrossingData", true, "BunchCrossing data requires CONDBR2 access. Can be disabled here if this is a problem."};

  Gaudi::Property<bool> m_currentEventIsUnbiased;

  Gaudi::Property<bool> m_enableLumiExtrapolation{this, "EnableLumiExtrapolation", true, "If false then no extrapolation in L, N_bunch or <mu> will be performed.."};

  Gaudi::Property<uint32_t> m_vetoStartOfTrain{this, "VetoStartOfTrain", 0, "How many BCID to veto at the start of a bunch train."};

  Gaudi::Property<std::map<std::string, std::map<std::string, double>>> m_prescalesJSON{this, "PrescalesJSON", {},  "Optional JSON of prescales from the TrigMenuRuleBook to apply."};


  double m_targetMu;

  double m_targetBunches;

  double m_targetLumi;

  uint32_t m_runNumber;

  uint32_t m_eventCounter;

  double m_weightedEventCounter;


  TH1D* m_scalingHist;

  TH1D* m_bcidHist;


  TTree* m_metadataTree;


};


#endif //> !RATESANALYSIS_RATESANALYSISALG_H