RatesHistoBase.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef RATESANALYSIS_RATESHISTOBASE_H
#define RATESANALYSIS_RATESHISTOBASE_H 1
 
#include "TH1.h"
#include "TString.h"
 
#include "GaudiKernel/ServiceHandle.h"
 
#include "AthenaBaseComps/AthMessaging.h"
 
#include <string>
#include <unordered_map>
#include <set>
#include <sstream>
#include <cmath>
#include <iostream>
#include <iomanip>
#include <memory>
#include <limits>
 
class ITHistSvc; // Forward

enum ExtrapStrat_t{
  kLINEAR, 
  kEXPO_MU, 
  kBUNCH_SCALING, 
  kMU_SCALING, 
  kNONE 
};

enum RatesBinIdentifier_t{
  kACTIVE_RAW_BIN, 
  kACTIVE_WEIGHTED_BIN, 
  kPASS_RAW_BIN, 
  kPASS_WEIGHTED_OR_BIN, 
  kPASS_WEIGHTED_AND_BIN, 
  kEXPRESS_BIN, 
  kUNIQUE_BIN, 
  kNRATES_BINS 
};

struct WeightingValuesSummary_t {
  // Event property weights
  double   m_enhancedBiasWeight{}; 
  double   m_eventMu{}; 
  double   m_eventLumi{}; 
  bool     m_isUnbiased{}; 
  uint32_t m_distanceInTrain{}; 
  double   m_eventLiveTime{}; 
  // Lumi weights
  double   m_bunchFactor{}; 
  double   m_muFactor{}; 
  double   m_linearLumiFactor{}; 
  double   m_expoMuFactor{}; 
  const double m_noScaling = 1.; 
  const std::string print() {
    std::stringstream ss;
    ss << "WeightSummary: wEB:" << m_enhancedBiasWeight << " mu:" << m_eventMu << " lumi:" << m_eventLumi;
    ss << " isUnbiased:" << m_isUnbiased << " distanceInTrain:" << m_distanceInTrain;
    ss << " liveTime:" << m_eventLiveTime;
    ss << " lwBunch:" << m_bunchFactor << " lwMu:" << m_muFactor;
    ss << " lwExpoMu:" << m_expoMuFactor << " lwLin:" << m_linearLumiFactor;
    return ss.str();
  } 
};

class RatesHistoBase : public AthMessaging {
 public:
 
  RatesHistoBase(const std::string& name, IMessageSvc* msgSvc, const bool doHistograms = true);
  virtual ~RatesHistoBase();
 
  RatesHistoBase(const RatesHistoBase&) = delete;
 
  RatesHistoBase& operator=(const RatesHistoBase&) = delete;
 
  StatusCode giveMuHist(const ServiceHandle<ITHistSvc>& svc, const std::string& name); 
  StatusCode giveTrainHist(const ServiceHandle<ITHistSvc>& svc, const std::string& name); 
  StatusCode giveDataHist(const ServiceHandle<ITHistSvc>& svc, const std::string& name); 
  void clearTrainHist(); 
  TH1* getDataHist(); 
  bool doHistograms() const { return m_doHistograms; } 
  const std::string& getExtrapolationFactorString(ExtrapStrat_t strat) const;
  double getExtrapolationFactor(const WeightingValuesSummary_t& weights, const ExtrapStrat_t strat) const;
 
  static bool isZero(double v) { return std::abs(v) < std::numeric_limits<double>::min(); } //<! Helper fn
  static bool isNotPositive(double v) { return v < std::numeric_limits<double>::min(); } //<! Helper fn to check if the value is non positive = trigger is disabled
  void setDataName(const std::string& newName);
  void setRateVsMuName(const std::string& newName);
  void setRateVsTrainName(const std::string& newName);
 
 protected:
 
  std::string m_name; 
  bool m_doHistograms; 
  std::unique_ptr<TH1> m_rateVsMu; 
  std::unique_ptr<TH1> m_rateVsTrain; 
  std::unique_ptr<TH1> m_data;  
  TH1* m_rateVsMuCachedPtr{}; 
  TH1* m_rateVsTrainCachedPtr{};  
  TH1* m_dataCachedPtr{}; 
};
 
#endif //> !RATESANALYSIS_RATESHISTOBASE_H