EnhancedBiasWeighter.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
// EnhancedBiasWeighter includes
#include "EnhancedBiasWeighter/EnhancedBiasWeighter.h"
 
#include "PathResolver/PathResolver.h"
 
#include "TXMLEngine.h" 
#include "TObjString.h"
#include "TDOMParser.h"
#include "TXMLNode.h"
#include "TXMLDocument.h"
#include "TXMLAttr.h"
 
#include <memory>
#include <filesystem>
 
namespace {
  template <typename T>
    T stringToNum(const std::string& i) {
      T ret;
      std::istringstream( i ) >> ret;
      return ret;
    }
}
 
EnhancedBiasWeighter::EnhancedBiasWeighter( const std::string& name )
  : asg::AsgTool( name ),
  m_deadtime(1.),
  m_pairedBunches(0),
  m_mcModifiedCrossSection(0.)
{}
 
StatusCode EnhancedBiasWeighter::initialize() 
{
  ATH_MSG_DEBUG ("Initializing " << name() << "...");
  ATH_CHECK( m_bunchCrossingKey.initialize( m_useBunchCrossingData ) );
 
  if (m_isMC) {
 
    if (m_mcCrossSection == 0 || m_mcFilterEfficiency == 0) {
      ATH_MSG_FATAL("For MC rates, a cross section and filter efficiency must be supplied.");
      return StatusCode::FAILURE;
    }
    m_deadtime = 1.; // No deadtime for MC
    m_pairedBunches = FULL_RING; // Assume full-ring
    const double mcCrossSectionInSqCm = 1e-33 * m_mcCrossSection; // Convert nb -> cm^2 
    m_mcModifiedCrossSection = mcCrossSectionInSqCm * m_mcFilterEfficiency * m_mcKFactor;
    ATH_MSG_INFO ("Running over MC with xsec:" << m_mcCrossSection << " nb, filter efficiency:" << m_mcFilterEfficiency << ", k-factor:" << m_mcKFactor);
 
  } else { // isData
 
    if (m_runNumber == 0u) {
      ATH_MSG_FATAL("calculateWeightingData is TRUE, but the RunNumber property has not been set. This must be set such that we can read in the correct data.");
      return StatusCode::FAILURE;
    }
    ATH_MSG_INFO ("calculateWeightingData is TRUE. This job will read in EnhancedBias weighting data from CVMFS and COOL.");
    ATH_CHECK( loadWeights() );
    ATH_CHECK( loadLumi() );
 
  } // end isData
 
 
  return StatusCode::SUCCESS;
}
 
StatusCode EnhancedBiasWeighter::finalize() 
{
  ATH_MSG_DEBUG ("Finalizing " << name() << "...");
  return StatusCode::SUCCESS;
}
 
StatusCode EnhancedBiasWeighter::loadWeights()
{
  // Construct name
  std::stringstream fileName;
  const uint32_t runNumber = m_runNumber; // This is because Gaudi::Properties have special behaviour with the << operator
  fileName  << "EnhancedBiasWeights_" << runNumber << ".xml";
  std::string weightingFile = (!m_weightsDirectory.empty()) ? findLocalFile(fileName.str()) : PathResolverFindCalibFile("TrigCostRootAnalysis/" + fileName.str() );  // Check standard area
 
  ATH_MSG_DEBUG("Using weighting file " << weightingFile);
 
  if (weightingFile == "") {
    msg() << (m_errorOnMissingEBWeights ? MSG::ERROR : MSG::WARNING)  << "Could not retrieve " << fileName.str() << ", cannot perform enhanced bias weighting." << endmsg;
    return (m_errorOnMissingEBWeights ? StatusCode::FAILURE : StatusCode::SUCCESS);
  }
 
  std::unique_ptr<TXMLEngine> xml(new TXMLEngine() );
  XMLDocPointer_t xmlDoc = xml->ParseFile( weightingFile.c_str() );
 
  if (xmlDoc == nullptr) {
    ATH_MSG_WARNING ("Could not parse " << fileName.str() << ", cannot perform enhanced bias weighting.");
    return StatusCode::FAILURE;
  }
 
  // Navigate XML
  const XMLNodePointer_t mainNode = xml->DocGetRootElement(xmlDoc);
  if ( xml->GetNodeName(mainNode) != std::string("run") ) {
    ATH_MSG_ERROR ("Canot parse XML. Expected 'run' node, got " << xml->GetNodeName(mainNode));
    return StatusCode::FAILURE;
  }
  const XMLNodePointer_t weightsNode = xml->GetChild( mainNode );
  const XMLNodePointer_t eventsNode  = xml->GetNext( weightsNode );
 
  XMLNodePointer_t weightNode = xml->GetChild( weightsNode );
  XMLNodePointer_t eventNode  = xml->GetChild( eventsNode );
 
  while ( weightNode != 0 ) { // Loop over all weight elements
    if ( xml->GetNodeName(weightNode) != std::string("weight") ) {
      ATH_MSG_ERROR ("Canot parse XML. Expected 'weight' node, got " << xml->GetNodeName(weightNode));
      return StatusCode::FAILURE;
    }
 
    const int32_t id   = std::atoi(xml->GetAttr(weightNode, "id") );
    const double weight = std::atof(xml->GetAttr(weightNode, "value") );
    int32_t unbiased = 0;
    if ( xml->HasAttr(weightNode, "unbiased") == true ) {
      unbiased = std::atoi(xml->GetAttr(weightNode, "unbiased"));
    }
 
    m_idToWeightMap[id] = weight;
    m_idToUnbiasedMap[id] = unbiased;
 
    weightNode = xml->GetNext(weightNode);
  }
 
  while ( eventNode != 0 ) { // Loop over all event elements
    if ( xml->GetNodeName(eventNode) != std::string("e") ) {
      ATH_MSG_ERROR ("Canot parse XML. Expected 'e' (event) node, got " << xml->GetNodeName(eventNode));
      return StatusCode::FAILURE;
    }
    const uint64_t eventNumber  = std::strtoll(xml->GetAttr(eventNode, "n"), nullptr, 10); //Number
    const int32_t eventWeightID = std::stoi(xml->GetAttr(eventNode, "w") ); //Weight ID
 
    m_eventNumberToIdMap[eventNumber] = eventWeightID;
 
    eventNode = xml->GetNext(eventNode);
  }
 
  ATH_MSG_INFO ("Loaded " << m_eventNumberToIdMap.size() << " event weights for run " << runNumber);
  return StatusCode::SUCCESS;
}
 
StatusCode EnhancedBiasWeighter::loadLumi()
{
  // Fetch LB time from COOL for this run
  const uint32_t runNumber = m_runNumber;
  if (m_readLumiBlock.updateLumiBlocks(runNumber, msg()) == false) {
    ATH_MSG_FATAL("Unable to load this runs luminosity values from COOL.");
    return StatusCode::FAILURE;
  }
 
  // Read in number of events to expect 
  // Construct name
  std::stringstream fileName;
  fileName    << "enhanced_bias_run_" << runNumber << ".xml";
  std::string runFile = (!m_weightsDirectory.empty()) ? findLocalFile(fileName.str()) : PathResolverFindCalibFile("TrigCostRootAnalysis/" + fileName.str() );  // Check standard area
  
  ATH_MSG_DEBUG("Using run file " << runFile);
  if (runFile == "") {
    msg() << (m_errorOnMissingEBWeights ? MSG::ERROR : MSG::WARNING)  << "Could not retrieve " << fileName.str() << ", cannot perform enhanced bias weighting." << endmsg;
    return (m_errorOnMissingEBWeights ? StatusCode::FAILURE : StatusCode::SUCCESS);
  }
 
  std::unique_ptr<TXMLEngine> xml(new TXMLEngine());
  const XMLDocPointer_t xmlDoc = xml->ParseFile( runFile.c_str() );
 
  if (xmlDoc == nullptr) {
    ATH_MSG_FATAL ("Could not parse " << fileName.str() << ", cannot perform enhanced bias weighting.");
    return StatusCode::FAILURE;
  }
 
  const XMLNodePointer_t mainNode = xml->DocGetRootElement(xmlDoc);
  if ( xml->GetNodeName(mainNode) != std::string("trigger") ) {
    ATH_MSG_ERROR ("Canot parse XML. Expected 'trigger' node, got " << xml->GetNodeName(mainNode));
    return StatusCode::FAILURE;
  }
  XMLNodePointer_t listNode = xml->GetChild( mainNode );
 
  while ( listNode != 0 ) { // Loop over all menu elements
    const std::string listName = xml->GetNodeName(listNode);
 
    if (listName == "lb_list") {
      
      XMLNodePointer_t node = xml->GetChild( listNode );
      while( node != 0) {
        if ( xml->GetNodeName(node) != std::string("lb") ) {
          ATH_MSG_ERROR ("Canot parse XML. Expected 'lb' node, got " << xml->GetNodeName(node));
          return StatusCode::FAILURE;
        }
        const uint32_t lb      = std::atoi( xml->GetAttr(node, "id") );
        const double   lumi    = std::atof( xml->GetAttr(node, "lumi") );
        const uint32_t nEvents = std::atoi( xml->GetNodeContent(node) );
        const std::string flag = xml->HasAttr(node, "flag") ? xml->GetAttr(node, "flag") : "";  
 
        m_eventsPerLB[lb] = nEvents;
        m_goodLB[lb] = (flag == "bad" ? 0 : 1); 
        m_lumiPerLB[lb] = lumi < 1e10 ? 1e30 * lumi : lumi;
 
        if (xml->HasAttr(node, "deadtime")) {
          // Deadtime is a weight factor, the weight will be multiplied by deadtime + 1
          m_deadtimePerLB[lb] = 1. + std::atof( xml->GetAttr(node, "deadtime") );
        }
 
        node = xml->GetNext(node); 
      }
 
    } else if (listName == "lumivalues") {
 
      XMLNodePointer_t node = xml->GetChild( listNode );
      while( node != 0) { 
        if ( xml->GetNodeName(node) == std::string("deadtime") ) {
          m_deadtime = 1. + std::atof( xml->GetNodeContent(node) );
        }
        node = xml->GetNext(node);
      }
      
    } else if (listName == "bunchgroups") {
 
      XMLNodePointer_t node = xml->GetChild( listNode );
      while( node != 0) { 
        m_bunches.push_back( std::atoi( xml->GetNodeContent(node) ) );
        if ( xml->GetNodeName(node) == std::string("bunchgroup") && xml->HasAttr(node, "name") &&
            (std::string(xml->GetAttr(node, "name")) == "Paired" || std::string(xml->GetAttr(node, "name")) == "Filled")) {
          m_pairedBunches = std::atoi( xml->GetNodeContent(node) );
        }
        node = xml->GetNext(node);
      }
      
    } else if (listName == "filters") {
 
      ATH_MSG_DEBUG("Found filters section of enhanced bias XML. Unused by this application.");
 
    } else {
 
      ATH_MSG_INFO("Encountered unknown element in enhanced bias XML: " << listName << " ignoring it.");
 
    }
 
    listNode = xml->GetNext(listNode);
  }
 
  ATH_MSG_INFO ("Loaded " << m_eventsPerLB.size() << " EnhancedBias lumi block's info for run " << runNumber);
  return StatusCode::SUCCESS;
}
 
std::unordered_map<std::string, ChainDetail> EnhancedBiasWeighter::parsePrescaleXML(const std::string& prescaleXML) const {
  std::unordered_map<std::string, ChainDetail> result;
 
  std::string xmlFile = PathResolverFindDataFile( prescaleXML ); 
  if (xmlFile == "") {
    ATH_MSG_ERROR ("Could not retrieve " << prescaleXML << ", place it somewhere PathResolver can find it (such as the current directory).");
    return result;
  }
 
  std::unique_ptr<TXMLEngine> xml(new TXMLEngine());
  const XMLDocPointer_t xmlDoc = xml->ParseFile( xmlFile.c_str() );
 
  if (xmlDoc == nullptr) {
    ATH_MSG_WARNING ("Could not parse " << prescaleXML << ", please check that it is valid XML.");
    return result;
  }
 
  // Get access to main node
  XMLNodePointer_t mainNode = xml->DocGetRootElement(xmlDoc);
  if ( xml->GetNodeName(mainNode) != std::string("trigger") ) {
    ATH_MSG_ERROR ("Canot parse XML. Expected 'trigger' node, got " << xml->GetNodeName(mainNode));
    return result;
  }
  XMLNodePointer_t listNode = xml->GetChild( mainNode );
 
 
  while ( listNode != nullptr) { // Loop over all menu elements
    const std::string listName = xml->GetNodeName(listNode);
 
    // if (_listName == "PredictionLumi") {
    //   Float_t predictionLumi = stringToFloat( xml->GetNodeContent(listNode) );
    // }
    if (listName != "level") { // Find the "level" item
      listNode = xml->GetNext(listNode);
      continue;
    }
 
    XMLNodePointer_t sigNode = xml->GetChild( listNode );
    while( sigNode != nullptr) {
      if (xml->GetNodeName(sigNode) != std::string("signature")) { // Find the "signature" items
        sigNode = xml->GetNext(sigNode);
        continue;
      }
 
      XMLNodePointer_t sigDetailsNode = xml->GetChild( sigNode );
      std::string chainName;
      while( sigDetailsNode != nullptr) {
 
        if (xml->GetNodeContent(sigDetailsNode) == nullptr) {
          sigDetailsNode = xml->GetNext(sigDetailsNode);
          continue;
        }
 
        const std::string detail = xml->GetNodeName(sigDetailsNode);
        if (detail == "sig_name") {
          chainName = xml->GetNodeContent(sigDetailsNode);
          result[chainName] = ChainDetail();
        } else if (detail == "sig_counter") {
          result[chainName].m_counter = std::stoi( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "prescale" || detail == "chain_prescale") { // This is an alternate name
          result[chainName].m_prescale = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "lower_chain_name") {
          // Later processing here does not expect any spaces, so remove them now. Pure comma separated list
          std::string lower = xml->GetNodeContent(sigDetailsNode);
          while (lower.find(" ") != std::string::npos) lower.replace( lower.find(" "), 1, "");
          result[chainName].m_lowerName = std::move(lower);
        } else if (detail == "evts_passed") {
          result[chainName].m_eventsPassed = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "evts_passed_weighted") {
          result[chainName].m_eventsPassedWeighted = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "rate") {
          result[chainName].m_rate = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "rate_err") {
          result[chainName].m_rateErr = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "passthrough") {
          result[chainName].m_passthroughPrescale = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "rerun_prescale") {
          result[chainName].m_rerunPrescale = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "express_prescale") {
          result[chainName].m_expressPrescale = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "efficiency") {
          result[chainName].m_efficiency = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "efficiency_err") {
          result[chainName].m_efficiencyErr = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "prescaled_efficiency") {
          result[chainName].m_prescaledEfficiency = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "prescaled_efficiency_error") {
          result[chainName].m_prescaledEfficiencyErr = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "comment") {
          result[chainName].m_comment = xml->GetNodeContent(sigDetailsNode);
        } else {
          ATH_MSG_DEBUG("Input prescales XML contains additional data which cannot be parsed at present:" << detail);
        }
 
        sigDetailsNode = xml->GetNext(sigDetailsNode);
      }
      sigNode = xml->GetNext(sigNode);
    }
    listNode = xml->GetNext(listNode);
  }
 
  return result;
}
 
int32_t EnhancedBiasWeighter::getEventEBID(const xAOD::EventInfo* eventInfo) const
{
  const uint64_t eventNumber = eventInfo->eventNumber();
 
  const auto mapIterator = m_eventNumberToIdMap.find(eventNumber);
  if (mapIterator != m_eventNumberToIdMap.end()) {
    return mapIterator->second;
  }
  // Unfortunately, earlier weighting XMLs have 32 bit signed event number. Hence we also have to try this option
  const int32_t eventNumber32 = static_cast<int32_t>(eventNumber);
  const auto mapIterator32 = m_eventNumberToIdMap.find(eventNumber32);
  if (mapIterator32 != m_eventNumberToIdMap.end()) {
    return mapIterator32->second;
  } else {
    ATH_MSG_ERROR( "Couldn't find enhanced bias info for event " << eventNumber);
    return -1;
  } 
}
 
int32_t EnhancedBiasWeighter::getEventEBID(const EventContext& context) const
{
  const uint64_t eventNumber = context.eventID().event_number();
 
  const auto mapIterator = m_eventNumberToIdMap.find(eventNumber);
  if (mapIterator != m_eventNumberToIdMap.end()) {
    return mapIterator->second;
  }
  // Unfortunately, earlier weighting XMLs have 32 bit signed event number. Hence we also have to try this option
  const int32_t eventNumber32 = static_cast<int32_t>(eventNumber);
  const auto mapIterator32 = m_eventNumberToIdMap.find(eventNumber32);
  if (mapIterator32 != m_eventNumberToIdMap.end()) {
    return mapIterator32->second;
  } else {
    ATH_MSG_ERROR( "Couldn't find enhanced bias info for event " << eventNumber);
    return -1;
  } 
}
 
double EnhancedBiasWeighter::getEBWeight(const xAOD::EventInfo* eventInfo) const
{
  if (m_enforceEBGRL && !isGoodLB(eventInfo)) {
    return 0;
  }
 
  ATH_CHECK( trackAverages(eventInfo), 0 );
 
  if (m_isMC && m_doMultiSliceDiJet) {
    return static_cast<double>(eventInfo->mcEventWeight(0)) * m_mcModifiedCrossSection * m_targetLumi;
 
  } else if (m_isMC) {
 
    if (m_mcIgnoreGeneratorWeights) {
      return 1.;
    }
 
    const std::vector<float> weights = eventInfo->mcEventWeights();
    if (weights.size() > 0) {
      return weights[0];
    }
    return 1.;
 
  } else { // isData
 
    int32_t ebID = getEventEBID(eventInfo);
    const auto mapIterator = m_idToWeightMap.find(ebID);
    if (mapIterator == m_idToWeightMap.end() ) {
      ATH_MSG_ERROR( "Couldn't find enhanced bias weight for event with ID " << ebID);
      return 0;
    }
    return mapIterator->second;
 
  } // isData
}
 
 
double EnhancedBiasWeighter::getEBWeight(const EventContext& context) const
{
 
  if (m_enforceEBGRL && !isGoodLB(context)) {
    return 0;
  }
 
  ATH_CHECK( trackAverages(context), 0 );
 
  if (m_isMC) {
 
    ATH_MSG_ERROR( "Cannot use EventContext based getEBWeight with MC. Needs full EventInfo.");
    return 0.;
 
  } else { // isData
 
    int32_t ebID = getEventEBID(context);
    const auto mapIterator = m_idToWeightMap.find(ebID);
    if (mapIterator == m_idToWeightMap.end() ) {
      ATH_MSG_ERROR( "Couldn't find enhanced bias weight for event with ID " << ebID);
      return 0;
    }
    return mapIterator->second;
 
  } // isData
}
 
 
StatusCode EnhancedBiasWeighter::trackAverages(const EventContext& context) const 
{
  m_lumiAverage += getLBLumi(context);
  return StatusCode::SUCCESS;
}
 
 
StatusCode EnhancedBiasWeighter::trackAverages(const xAOD::EventInfo* eventInfo) const 
{
  m_muAverage += std::ceil( eventInfo->actualInteractionsPerCrossing() );
  m_lumiAverage += getLBLumi(eventInfo);
  return StatusCode::SUCCESS;
}
 
double EnhancedBiasWeighter::getBunchCrossingRate() const {
  return m_pairedBunches * LHC_FREQUENCY;
}
double EnhancedBiasWeighter::getEBLiveTime(const xAOD::EventInfo* eventInfo) const
{
    if (m_isMC) {
 
      // Probability that a single pp interaction yields this MC process (ratio of xsec)
      const double probOfProcess = m_mcModifiedCrossSection / m_inelasticCrossSection; 
      // Probability that a single bunch-crossing yeild this MC process. Binomial statistics (1 - Prob(exactly 0 interactions, given mu interactions)).
      const double probOfBunchCrossing = 1. - std::pow( 1. - probOfProcess, std::ceil(eventInfo->actualInteractionsPerCrossing()) );
      const double bunchCrossingRate = m_pairedBunches * LHC_FREQUENCY;
      // How much wall-time does this event represent? This is the reciprocal of the rate, which is the % per crossing scaled by the crossing rate.
      ATH_MSG_DEBUG("MC livetime debug: probOfProcess:" << probOfProcess << " probOfBunchCrossing:" << probOfBunchCrossing << " bunchCrossingRate:" << bunchCrossingRate << " time:" << (1. / (probOfBunchCrossing * bunchCrossingRate)));
      return 1. / (probOfBunchCrossing * bunchCrossingRate);
 
    } else {
 
      uint32_t lumiBlock = eventInfo->lumiBlock();
      std::lock_guard<std::mutex> scopeLock(m_mutex);
 
      // Check the cache
      const auto inCacheIterator = m_eventLivetime.find( lumiBlock );
      if (inCacheIterator != m_eventLivetime.end()) return inCacheIterator->second;
 
      // Else calculate
      const auto mapIterator = m_eventsPerLB.find(lumiBlock);
      if (mapIterator == m_eventsPerLB.end() ) {
        if (m_errorOnMissingEBWeights) {
          ATH_MSG_ERROR( "Couldn't find LB info for LB: " << lumiBlock );
        }
        return 0;
      } 
      const int32_t eventsInThisLB = mapIterator->second;
      const double lbLength = m_readLumiBlock.getLumiBlockLength(lumiBlock, msg());
      // This event is one in eventsInThisLB, so has an effective temporal contribution of:
      double eventLivetime = 0;
      if (eventsInThisLB > 0 && fabs(lbLength) > 1e-10) eventLivetime = (1. / static_cast<double>(eventsInThisLB)) * lbLength;
      // Cache this (mutable)
      m_eventLivetime[lumiBlock] = eventLivetime;
      return eventLivetime;
 
    } // isData
}
 
double EnhancedBiasWeighter::getEBLiveTime(const EventContext& context) const
{
    if (m_isMC) {
 
      ATH_MSG_ERROR( "Cannot use EventContext based getEBLiveTime with MC. Needs full EventInfo.");
      return 0.;
 
    } else {
 
      uint32_t lumiBlock = context.eventID().lumi_block();
      std::lock_guard<std::mutex> scopeLock(m_mutex);
 
      // Check the cache
      const auto inCacheIterator = m_eventLivetime.find( lumiBlock );
      if (inCacheIterator != m_eventLivetime.end()) return inCacheIterator->second;
 
      // Else calculate
      const auto mapIterator = m_eventsPerLB.find(lumiBlock);
      if (mapIterator == m_eventsPerLB.end() ) {
        if (m_errorOnMissingEBWeights) {
          ATH_MSG_ERROR( "Couldn't find LB info for LB: " << lumiBlock );
        }
        return 0.;
      } 
      const int32_t eventsInThisLB = mapIterator->second;
      const double lbLength = m_readLumiBlock.getLumiBlockLength(lumiBlock, msg());
      // This event is one in eventsInThisLB, so has an effective temporal contribution of:
      double eventLivetime = 0;
      if (eventsInThisLB > 0 && fabs(lbLength) > 1e-10) eventLivetime = (1. / static_cast<double>(eventsInThisLB)) * lbLength;
      // Cache this (mutable)
      m_eventLivetime[lumiBlock] = eventLivetime;
      return eventLivetime;
 
    } // isData
 
}
 
double EnhancedBiasWeighter::getLBLength(const xAOD::EventInfo* eventInfo) const {
  if (m_isMC) {
    ATH_MSG_ERROR( "getLBLength Does not work for MC.");
    return 0.;
  } else {
    uint32_t lumiBlock = eventInfo->lumiBlock();
    const double lbLength = m_readLumiBlock.getLumiBlockLength(lumiBlock, msg());
    return lbLength;
  } // isData
}
 
 
 
double EnhancedBiasWeighter::getLBLength(const EventContext& context) const {
  if (m_isMC) {
    ATH_MSG_ERROR( "getLBLength Does not work for MC.");
    return 0.;
  } else {
    uint32_t lumiBlock = context.eventID().lumi_block();
    const double lbLength = m_readLumiBlock.getLumiBlockLength(lumiBlock, msg());
    return lbLength;
  } // isData
}
 
 
bool EnhancedBiasWeighter::isUnbiasedEvent(const xAOD::EventInfo* eventInfo) const
{
  if (m_isMC) {
 
    return true;
 
  } else { //isData
 
    int32_t ebID = getEventEBID(eventInfo);
    const auto mapIterator = m_idToUnbiasedMap.find(ebID);
    if (mapIterator == m_idToUnbiasedMap.end() ) {
      ATH_MSG_ERROR("Couldn't find isUnbiased information for event with ID " << ebID);
      return false;
    }
    return mapIterator->second;
  
  } // isData
}
 
bool EnhancedBiasWeighter::isGoodLB(const xAOD::EventInfo* eventInfo) const
{
  if (m_isMC) {
    
    return true;
 
  } else { // isData
 
    uint32_t lumiBlock = eventInfo->lumiBlock();
 
    const auto mapIterator = m_goodLB.find(lumiBlock);
    if (mapIterator == m_goodLB.end() ) {
      ATH_MSG_ERROR( "Couldn't find LB good/bad info for LB: " << lumiBlock );
      return false;
    }
    return static_cast<bool>(mapIterator->second);
 
  } // isData
}
 
bool EnhancedBiasWeighter::isGoodLB(const EventContext& context) const
{
  if (m_isMC) {
    
    return true;
 
  } else { // isData
 
    uint32_t lumiBlock = context.eventID().lumi_block();
 
    const auto mapIterator = m_goodLB.find(lumiBlock);
    if (mapIterator == m_goodLB.end() ) {
      ATH_MSG_ERROR( "Couldn't find LB good/bad info for LB: " << lumiBlock );
      return false;
    }
    return static_cast<bool>(mapIterator->second);
 
  } // isData
}
 
bool EnhancedBiasWeighter::isMC() const {
  return m_isMC;
}
 
uint32_t EnhancedBiasWeighter::getRunNumber() const {
  return m_runNumber;
}
 
double EnhancedBiasWeighter::getLBLumi(const xAOD::EventInfo* eventInfo) const
{
  if (m_isMC) {
 
    const double mu = std::ceil( eventInfo->actualInteractionsPerCrossing() );
    return (mu * LHC_FREQUENCY * m_pairedBunches) / m_inelasticCrossSection;
 
  } else { // isData
 
    uint32_t lumiBlock = eventInfo->lumiBlock();
    const auto mapIterator = m_lumiPerLB.find(lumiBlock);
    if (mapIterator == m_lumiPerLB.end() ) {
      ATH_MSG_ERROR( "Couldn't find lumi info for LB: " << lumiBlock );
      return 0.;
    }
    return mapIterator->second;
 
  } // isData
}
 
double EnhancedBiasWeighter::getLBLumi(const EventContext& context) const
{
  if (m_isMC) {
 
    ATH_MSG_ERROR( "Cannot use EventContext based getLBLumi with MC. Needs full EventInfo.");
    return 0.;
 
  } else { // isData
 
    uint32_t lumiBlock = context.eventID().lumi_block();
    const auto mapIterator = m_lumiPerLB.find(lumiBlock);
    if (mapIterator == m_lumiPerLB.end() ) {
      ATH_MSG_ERROR( "Couldn't find lumi info for LB: " << lumiBlock );
      return 0.;
    }
    return mapIterator->second;
 
  } // isData
}
 
double EnhancedBiasWeighter::getDeadtime(const int lumiblock) const
{
  if (m_isMC) {
    return 1.;
  }
  else if (m_deadtimePerLB.count(lumiblock)) {
    return m_deadtimePerLB.at(lumiblock);
  }
  return m_deadtime;
}
 
uint32_t EnhancedBiasWeighter::getPairedBunches() const
{
  return m_pairedBunches;
}
 
StatusCode EnhancedBiasWeighter::getDistanceIntoTrain(const xAOD::EventInfo* eventInfo, uint32_t& distance) const
{
  if (!m_useBunchCrossingData) return StatusCode::SUCCESS;
 
  const EventContext& context = Gaudi::Hive::currentContext();
  SG::ReadCondHandle<BunchCrossingCondData> bunchCrossingTool (m_bunchCrossingKey, context);
  ATH_CHECK( bunchCrossingTool.isValid() );
  distance = bunchCrossingTool->distanceFromFront( eventInfo->bcid(), BunchCrossingCondData::BunchDistanceType::BunchCrossings );
 
  return StatusCode::SUCCESS;
}
 
double EnhancedBiasWeighter::getAverageLumi() const
{
  return m_lumiAverage.mean();
}
 
double EnhancedBiasWeighter::getAverageMu() const 
{
  return m_muAverage.mean();
}
 
 
StatusCode EnhancedBiasWeighter::addBranches() const
{
  // Set up the decorator
  SG::AuxElement::Decorator< double >   decoratorEBWeight("EnhancedBiasWeight"); 
  SG::AuxElement::Decorator< double >   decoratorEBLivetime("EnhancedBiasLivetime"); 
  SG::AuxElement::Decorator< double >   decoratorLBLumi("LBLumi"); 
  SG::AuxElement::Decorator< double >   decoratorDeadtime("Deadtime"); 
  SG::AuxElement::Decorator< uint32_t > decoratorBCIDDistanceFromFront("BCIDDistanceFromFront"); 
  SG::AuxElement::Decorator< char >     decoratorUnbiasedFlag("IsUnbiasedEventFlag");
  SG::AuxElement::Decorator< char >     decoratorGoodLBFlag("IsGoodLBFlag");  
 
  const xAOD::EventInfo* eventInfo(nullptr);
  uint32_t distance = 0;
  ATH_CHECK( evtStore()->retrieve(eventInfo, "EventInfo") );
  ATH_CHECK( getDistanceIntoTrain(eventInfo, distance) );
 
  decoratorEBWeight(*eventInfo) = getEBWeight(eventInfo);
  decoratorEBLivetime(*eventInfo) = getEBLiveTime(eventInfo);
  decoratorLBLumi(*eventInfo) = getLBLumi(eventInfo);
  decoratorUnbiasedFlag(*eventInfo) = isUnbiasedEvent(eventInfo);
  decoratorGoodLBFlag(*eventInfo) = isGoodLB(eventInfo);
  decoratorDeadtime(*eventInfo) = getDeadtime(eventInfo->lumiBlock());
  decoratorBCIDDistanceFromFront(*eventInfo) = distance;
 
  return StatusCode::SUCCESS;
}
 
 
std::string EnhancedBiasWeighter::findLocalFile (const std::string& fileName) const {
 
  if (m_weightsDirectory.empty()) {
    ATH_MSG_ERROR("Local directory for EB xml not set!");
    return "";
  }
 
  std::string fullName = m_weightsDirectory+ "/" + fileName;
 
  if (!std::filesystem::exists(fullName)) {
    ATH_MSG_ERROR("File " << fullName << " not found!");
    return "";
  }
 
  return fullName;
}