RatesHistoBase.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
#include "RatesAnalysis/RatesHistoBase.h"
 
#include "GaudiKernel/ITHistSvc.h"
#include "AthenaBaseComps/AthCheckMacros.h"
 
RatesHistoBase::RatesHistoBase(const std::string& name, IMessageSvc* msgSvc, const bool doHistograms) :
  AthMessaging(msgSvc, name),
  m_name(name),
  m_doHistograms(doHistograms)
{
  if (doHistograms) {
    m_rateVsMu = std::make_unique<TH1D>("",TString(name + ";#mu;Rate / Unit #mu [Hz]"),226,-.5,225.5);
    m_rateVsMu->Sumw2(true);
    m_rateVsMu->SetName("rateVsMu");
    m_rateVsMuCachedPtr = m_rateVsMu.get();
 
    m_rateVsTrain = std::make_unique<TH1D>("",TString(name + ";Distance Into Train;Rate / BCID [Hz]"),100,-0.5,99.5);
    m_rateVsTrain->Sumw2(true);
    m_rateVsTrain->SetName("rateVsTrain");
    m_rateVsTrainCachedPtr = m_rateVsTrain.get();
 
    m_data =  std::make_unique<TH1D>("",TString(";Variable;Raw Data"), RatesBinIdentifier_t::kNRATES_BINS, -.5, RatesBinIdentifier_t::kNRATES_BINS - .5);
    m_data->Sumw2(true);
    m_data->SetName("data");
    // Set bin labels based on RatesBinIdentifier_t
    m_data->GetXaxis()->SetBinLabel(1, "Actve Raw");
    m_data->GetXaxis()->SetBinLabel(2, "Active Weighted");
    m_data->GetXaxis()->SetBinLabel(3, "Pass Raw");
    m_data->GetXaxis()->SetBinLabel(4, "Pass Weighted OR");
    m_data->GetXaxis()->SetBinLabel(5, "Pass Weighted AND");
    m_data->GetXaxis()->SetBinLabel(6, "Express");
    m_data->GetXaxis()->SetBinLabel(7, "Unique");
    m_dataCachedPtr = m_data.get();
 
  }
}
 
 
RatesHistoBase::~RatesHistoBase() {
}
 
StatusCode RatesHistoBase::giveMuHist(const ServiceHandle<ITHistSvc>& svc, const std::string& name) { 
  if (!m_rateVsMu.get()) { 
    ATH_MSG_ERROR("RatesHistoBase::giveMuHist Warning requested histograms when histograming is OFF here.");
    return StatusCode::FAILURE;
  }
  ATH_CHECK( svc->regHist(name, std::move(m_rateVsMu)) );
  return StatusCode::SUCCESS;
}
 
 
StatusCode RatesHistoBase::giveTrainHist(const ServiceHandle<ITHistSvc>& svc, const std::string& name) { 
  if (!m_rateVsTrain.get()) {
    ATH_MSG_ERROR("RatesHistoBase::giveTrainHist Warning requested histograms when histograming is OFF here.");
    return StatusCode::FAILURE;
  }
  ATH_CHECK( svc->regHist(name, std::move(m_rateVsTrain)) );
  return StatusCode::SUCCESS;
}
 
 
StatusCode RatesHistoBase::giveDataHist(const ServiceHandle<ITHistSvc>& svc, const std::string& name) { 
  if (!m_data.get()) {
    ATH_MSG_ERROR("RatesHistoBase::giveDataHist Warning requested histograms when histograming is OFF here.");
    return StatusCode::FAILURE;
  }
  ATH_CHECK( svc->regHist(name, std::move(m_data)) );
  return StatusCode::SUCCESS;
}
 
 
void RatesHistoBase::clearTrainHist() {
  m_rateVsTrain.reset();
  m_rateVsTrainCachedPtr = nullptr;
}
 
 
TH1* RatesHistoBase::getDataHist() {
  return m_dataCachedPtr; // Caller must be able to deal with nullptr (e.g unique rates groups calling on their trigger)
}
 
 
const std::string& RatesHistoBase::getExtrapolationFactorString(ExtrapStrat_t strat) const {
  static const std::vector<std::string> values{"LINEAR_L","LINEAR_BUNCH_EXPO_MU","LINEAR_BUNCHES","LINEAR_MU","NONE"};
  return values.at(static_cast<size_t>(strat)); 
}
 
  void RatesHistoBase::setDataName(const std::string& newName){if (m_data) m_data->SetName(newName.c_str());}
  void RatesHistoBase::setRateVsMuName(const std::string& newName){if (m_rateVsMu) m_rateVsMu->SetName(newName.c_str());}
  void RatesHistoBase::setRateVsTrainName(const std::string& newName){if (m_rateVsTrain) m_rateVsTrain->SetName(newName.c_str());}
 
double RatesHistoBase::getExtrapolationFactor(const WeightingValuesSummary_t& weights, const ExtrapStrat_t strat) const {
  switch (strat) {
    case kLINEAR: return weights.m_linearLumiFactor;
    case kEXPO_MU: return weights.m_expoMuFactor;
    case kBUNCH_SCALING: return weights.m_bunchFactor;
    case kMU_SCALING: return weights.m_muFactor;
    case kNONE: return weights.m_noScaling;
    default: ATH_MSG_ERROR("Error in getExtrapolationFactor. Unknown ExtrapStrat_t ENUM supplied " << strat);
  }
  return 0.;
}