BTaggingEfficiencyJsonTool Class Reference

#include <BTaggingEfficiencyJsonTool.h>

Inheritance diagram for BTaggingEfficiencyJsonTool:

Classes
class	BoundsHandler
class	MCMCHandler
struct	sysData

Public Member Functions
	BTaggingEfficiencyJsonTool (const std::string &name)
virtual	~BTaggingEfficiencyJsonTool ()
StatusCode	initialize () override
	Dummy implementation of the initialisation function.
virtual CP::CorrectionCode	getScaleFactor (const xAOD::Jet &jet, float &scalefactor, const CP::SystematicSet &sys) const override
virtual CP::SystematicSet	affectingSystematics () const override
	the list of all systematics this tool can be affected by
virtual CP::SystematicSet	recommendedSystematics () const override
	the list of all systematics this tool recommends to use
virtual void	print () const
	Print the state of the tool.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
enum class	varType {   unknown , pT , mass , eta ,   abseta }
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	calcSystematicVariation (const CP::SystematicSet &systConfig, sysData &mySys) const
float	getSFSys (const std::string &label, size_t bin_index) const
CP::CorrectionCode	getMCToMCCorr (const xAOD::Jet &jet, float &corr) const
float	getJetPtInGeV (const xAOD::Jet &jet) const
float	getJetMassInGeV (const xAOD::Jet &jet) const
float	getJetQuantity (const xAOD::Jet &jet, const varType vType) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Static Private Member Functions
static std::string	getVariableName (const varType vType)
static varType	getVariableType (const std::string &varName)

Private Attributes
bool	m_initialised = false
Gaudi::Property< std::string >	m_outputName {this, "OutputName", "", "Output name of the tagger"}
Gaudi::Property< std::string >	m_OP {this, "OperatingPoint", "", "Operating point"}
Gaudi::Property< std::string >	m_jetAuthor {this, "JetAuthor", "", "Jet collection"}
Gaudi::Property< std::string >	m_json_config_path {this, "JsonConfigFile", "", "Path to JSON config file"}
Gaudi::Property< std::string >	m_mcGenerator {this, "MCGenerator", "", "Name of the MC generator of the sample being processed (required for MC-MC scale factor)"}
Gaudi::Property< float >	m_minPt {this, "MinPt", -1 , "Minimum jet pT cut (in MeV)"}
Gaudi::Property< float >	m_maxEta {this, "MaxEta", 2.5, "Maximum jet eta cut"}
json	m_json_config
std::map< int, std::string >	m_labelMap
std::map< int, std::string >	m_labelMapMCMC
std::map< std::string, std::vector< float > >	m_sfMap
std::map< std::string, std::vector< float > >	m_sfPtMap
std::map< std::string, std::map< std::string, std::vector< float > > >	m_sfSysMap
std::map< std::string, std::string >	m_mcReference
std::map< std::string, std::vector< MCMCHandler > >	m_mcmcHandlers
std::unique_ptr< SG::ConstAccessor< int > >	m_truthLabelAcc
std::unique_ptr< SG::ConstAccessor< float > >	m_massAcc
std::unique_ptr< SG::ConstAccessor< float > >	m_ptAcc
CP::SystematicsCache< sysData >	m_sysCache {this}
const sysData *	m_currentSys {nullptr}
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default).
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default).
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Friends
std::ostream &	operator<< (std::ostream &os, const BoundsHandler &handler)
std::ostream &	operator<< (std::ostream &os, const MCMCHandler &handler)

Detailed Description

Definition at line 17 of file BTaggingEfficiencyJsonTool.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 376 of file AthCommonDataStore.h.

Member Enumeration Documentation

varType

enum class BTaggingEfficiencyJsonTool::varType

strongprivate

Enumerator
unknown
pT
mass
eta
abseta

Definition at line 52 of file BTaggingEfficiencyJsonTool.h.

                     {
    unknown,
    pT,
    mass,  
    eta,
    abseta
  };

Constructor & Destructor Documentation

BTaggingEfficiencyJsonTool()

BTaggingEfficiencyJsonTool::BTaggingEfficiencyJsonTool

(

const std::string &

name

)

Definition at line 10 of file BTaggingEfficiencyJsonTool.cxx.

                                                                               :
  asg::AsgTool ( name )
{
  m_initialised = false;
}

~BTaggingEfficiencyJsonTool()

BTaggingEfficiencyJsonTool::~BTaggingEfficiencyJsonTool ( )

virtual

Definition at line 16 of file BTaggingEfficiencyJsonTool.cxx.

                                                        {
}

Member Function Documentation

affectingSystematics()

CP::SystematicSet BTaggingEfficiencyJsonTool::affectingSystematics ( ) const

overridevirtual

the list of all systematics this tool can be affected by

Implements CP::IReentrantSystematicsTool.

Definition at line 617 of file BTaggingEfficiencyJsonTool.cxx.

{
  CP::SystematicSet affectingSystematics;
  affectingSystematics.insert(CP::SystematicVariation("BTagging_Xbb_SYST", 1));
  affectingSystematics.insert(CP::SystematicVariation("BTagging_Xbb_SYST", -1));
  
  return affectingSystematics;
}

calcSystematicVariation()

StatusCode BTaggingEfficiencyJsonTool::calcSystematicVariation ( const CP::SystematicSet & systConfig, sysData & mySys ) const

private

Definition at line 609 of file BTaggingEfficiencyJsonTool.cxx.

{
  CP::SystematicVariation syst = systConfig.getSystematicByBaseName("BTagging_Xbb_SYST");
  sys.xbb_syst = syst.parameter();
 
  return StatusCode::SUCCESS;
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

getJetMassInGeV()

float BTaggingEfficiencyJsonTool::getJetMassInGeV ( const xAOD::Jet & jet ) const

private

Definition at line 357 of file BTaggingEfficiencyJsonTool.cxx.

{   
    // Convert mass from MeV to GeV 
    if (!m_massAcc) {
      return jet.m() * BTaggingToolUtil::MeVToGeV;
    }
    if (!m_massAcc->isAvailable(jet)) {
        ATH_MSG_ERROR("Decorated mass '" << SG::AuxTypeRegistry::instance().getName( m_massAcc->auxid() ) << "' not available on jet. Cannot proceed.");
        throw std::runtime_error("Decorated mass not available on jet.");
    }
    return (*m_massAcc)(jet) * BTaggingToolUtil::MeVToGeV;
}

getJetPtInGeV()

float BTaggingEfficiencyJsonTool::getJetPtInGeV ( const xAOD::Jet & jet ) const

private

Definition at line 370 of file BTaggingEfficiencyJsonTool.cxx.

{ 
  // Convert pT from MeV to GeV 
  if (!m_ptAcc) {
    return jet.pt() * BTaggingToolUtil::MeVToGeV;
  }
 
  if (!m_ptAcc->isAvailable(jet)) {
    ATH_MSG_ERROR("Decorated pT '" << SG::AuxTypeRegistry::instance().getName( m_ptAcc->auxid() ) << "' not available on jet. Cannot proceed.");
    throw std::runtime_error("Decorated pT not available on jet.");
  }
 
  return (*m_ptAcc)(jet) * BTaggingToolUtil::MeVToGeV;
}

getJetQuantity()

float BTaggingEfficiencyJsonTool::getJetQuantity ( const xAOD::Jet & jet, const varType vType ) const

private

Definition at line 385 of file BTaggingEfficiencyJsonTool.cxx.

                                                                                        {
  if (vType == varType::pT) { 
    return getJetPtInGeV(jet); 
  } else if (vType == varType::mass) {
    return getJetMassInGeV(jet);
  }  else if (vType == varType::eta) {
    return jet.eta();
  } else if (vType == varType::abseta) {
    return std::abs(jet.eta());
  } else { 
    ATH_MSG_ERROR("Unsupported jet variable quantity requested: '" << getVariableName(vType) << "'");
    throw std::runtime_error("BTaggingEfficiencyJsonTool::getJetQuantity unsupported jet variable: '" + getVariableName(vType) + "'");
  }
}

getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::Event both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                    {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::Event, we have a direct function call
      // for this.
      return evtStore()->event()->getKey( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      return ( proxy == nullptr ? 0 : proxy->sgkey() );
#endif // XAOD_STANDALONE
   }

getMCToMCCorr()

CP::CorrectionCode BTaggingEfficiencyJsonTool::getMCToMCCorr ( const xAOD::Jet & jet, float & corr ) const

private

Definition at line 293 of file BTaggingEfficiencyJsonTool.cxx.

{
  if (! m_initialised) {
    throw std::runtime_error("BTaggingEfficiencyJsonTool has not been initialised.");
  }
 
  corr = 1.0;
 
  // If MC-MC handlers map is empty it means the JSON file does not contain MC-MC scale factors
  // Hence exiting directly from the function
  if (m_mcmcHandlers.empty()) { 
   return CP::CorrectionCode::Ok;
  }
 
  // Retrieve jet truth labelling
  // and check if a string label is associated to it
  // e.g. truthLabel integer is associated to fully-contained top->qqb and the corresponding string label could be "Top" for instance
  int truthLabel = (*m_truthLabelAcc)(jet);
  auto labelIt = m_labelMapMCMC.find(truthLabel);
  if (labelIt == m_labelMapMCMC.end()) {
    ATH_MSG_WARNING("No mc-to-mc correction on jet with truthLabel: " << truthLabel << ". Returning scale factor of 1.");
    return CP::CorrectionCode::OutOfValidityRange;  // this process has no mc-to-mc correction
  }
 
  const std::string& label = labelIt->second;
  auto handlerIt = m_mcmcHandlers.find(label);
  if (handlerIt == m_mcmcHandlers.end()) {
    // If the generator of the sample processed is the same as the generator of the reference sample for the given label
    // then the map of MC-MC handler is not filled for that label (check happening in the initialize function) 
    // Thus exiting here as the generator of the sample being processed is the same generator as the one used for the calibration
    return CP::CorrectionCode::Ok; 
  }
 
  // Loop over all MC-MC handlers and find the one where the jet if falling into
  for (const auto& handler : handlerIt->second) {
    if (handler.isJetWithinBounds(jet, *this)) {
      // // Useful for debugging
      // // Print jet truth label pT mass and eta and the corresponding handler
      // std::cout << "jet(label=" << label 
      //   << ", pT=" << getJetQuantity(jet, "pT") 
      //   << ", mass=" << getJetQuantity(jet, "mass") 
      //   << ", abseta=" << getJetQuantity(jet, "abseta") << "): "
      //   << handler << std::endl;
      
      corr = handler.getScaleFactor();
      return CP::CorrectionCode::Ok;
    }
  }
 
  ATH_MSG_WARNING("Jet outside mc-to-mc binning for label " << label << ". Returning correction of 1.");
  return CP::CorrectionCode::OutOfValidityRange;
}

getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::Event both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                            {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::Event, we have a direct function call
      // for this.
      return evtStore()->event()->getName( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      static const std::string dummy = "";
      return ( proxy == nullptr ? dummy : proxy->name() );
#endif // XAOD_STANDALONE
   }

getProperty()

template<class T>

const T * asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

getScaleFactor()

CP::CorrectionCode BTaggingEfficiencyJsonTool::getScaleFactor ( const xAOD::Jet & jet, float & scalefactor, const CP::SystematicSet & sys ) const

overridevirtual

Implements IBTaggingEfficiencyJsonTool.

Definition at line 236 of file BTaggingEfficiencyJsonTool.cxx.

{
  if (! m_initialised) {
    throw std::runtime_error("BTaggingEfficiencyJsonTool has not been initialised.");
  }
 
  sf = 1.0;
 
  int truthLabel = (*m_truthLabelAcc)(jet);
  std::string labelString;
  auto it = m_labelMap.find(truthLabel);
  if (it != m_labelMap.end()) {
    labelString = it->second;
  } else {
    ATH_MSG_WARNING("No calibration on jet with truthLabel: " << truthLabel << ". Returning scale factor of 1.");
    return CP::CorrectionCode::OutOfValidityRange;
  }
 
  if (!m_sfPtMap.contains(labelString)) {
    ATH_MSG_WARNING("No calibration on jet with truthLabel: " << truthLabel << ". Returning scale factor of 1.");
    return CP::CorrectionCode::OutOfValidityRange;
  }
  const auto& pts = m_sfPtMap.at(labelString);
  size_t bin_index = pts.size();
  if (getJetPtInGeV(jet) < pts[0]) {
    ATH_MSG_WARNING("No calibration for jet with pt: " << getJetPtInGeV(jet) << ". Returning scale factor of 1.");
    return CP::CorrectionCode::OutOfValidityRange;  
  }
  for (size_t i = 1; i < pts.size(); i++) {
    if (getJetPtInGeV(jet) < pts[i]) {
      bin_index = i-1;
      break;
    }
  }
 
  const auto& SFs = m_sfMap.at(labelString);
  if (bin_index >= SFs.size()) {
    ATH_MSG_WARNING("No calibration for jet with pt: " << getJetPtInGeV(jet) << ". Returning scale factor of 1.");
    return CP::CorrectionCode::OutOfValidityRange;
  }
 
  sf = SFs[bin_index];
  
  float corr = 1.;
  CP::CorrectionCode worstCorrectionCode = CP::CorrectionCode::Ok;
  CP::CorrectionCode ccMCMC = getMCToMCCorr(jet, corr);
  worstCorrectionCode = std::min(worstCorrectionCode, ccMCMC);
  sf *= corr;
  
  sysData tempSys;
  if (calcSystematicVariation(sys, tempSys) == StatusCode::SUCCESS && tempSys.xbb_syst != 0) {
    sf += tempSys.xbb_syst * getSFSys(labelString, bin_index);
  }
 
  return worstCorrectionCode;
}

getSFSys()

float BTaggingEfficiencyJsonTool::getSFSys ( const std::string & label, size_t bin_index ) const

private

Definition at line 346 of file BTaggingEfficiencyJsonTool.cxx.

{
  float result = 0.0;
  const auto& systematics = m_sfSysMap.at(labelString);
  for (auto& [systematicName, values] : systematics){
    float sys_value = values.at(bin_index);
    result += sys_value*sys_value;
  }
  return std::sqrt(result);
}

getVariableName()

std::string BTaggingEfficiencyJsonTool::getVariableName ( const varType vType )

staticprivate

Definition at line 520 of file BTaggingEfficiencyJsonTool.cxx.

{
  if (vType == varType::pT) {
    return "pT";
  } else if (vType == varType::mass) {
    return "mass";
  } else if (vType == varType::eta) {
    return "eta";
  } else if (vType == varType::abseta) {
    return "abseta";
  } else {
    throw std::runtime_error("Variable type " + std::to_string(static_cast<int>(vType)) + " not defined in BTaggingEfficiencyJsonTool.");
    return "unknown";
  }
}

getVariableType()

BTaggingEfficiencyJsonTool::varType BTaggingEfficiencyJsonTool::getVariableType ( const std::string & varName )

staticprivate

Definition at line 504 of file BTaggingEfficiencyJsonTool.cxx.

{
  if (varName == "pT") {
    return varType::pT;
  } else if (varName == "mass") {
    return varType::mass;
  } else if (varName == "eta") {
    return varType::eta;
  } else if (varName == "abseta") {
    return varType::abseta;
  } else {
    throw std::runtime_error("Variable '" + varName + "' not defined in BTaggingEfficiencyJsonTool.");
    return varType::unknown;
  }
}

initialize()

StatusCode BTaggingEfficiencyJsonTool::initialize ( void )

overridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 19 of file BTaggingEfficiencyJsonTool.cxx.

{
  ATH_MSG_INFO("Initialize BTagging Efficiency Json Tool from: " + m_json_config_path);
 
  if (m_minPt > 0.){ 
    // Convert MeV cut to GeV as in the JSON files numbers are in GeV 
    m_minPt = m_minPt * BTaggingToolUtil::MeVToGeV; 
  }
 
  std::string pathToJsonConfigFile = PathResolverFindCalibFile(m_json_config_path);
  std::ifstream jsonFile(pathToJsonConfigFile);
 
  if (!jsonFile.is_open()) {
    ATH_MSG_ERROR( "JSON file " + m_json_config_path + " does not exist. Please put the correct path of the file." );
    return StatusCode::FAILURE;
  }
  m_json_config = json::parse(jsonFile);
  jsonFile.close();
 
  if (m_outputName.empty() || !m_json_config.contains(m_outputName)){
    ATH_MSG_ERROR( "The output name " + m_outputName + " not found in JSON file: " + m_json_config_path );
    return StatusCode::FAILURE;
  }
 
  if (m_jetAuthor.empty() || !m_json_config[m_outputName].contains(m_jetAuthor)){
    ATH_MSG_ERROR( "Tagger: " +m_outputName+ " and Jet Collection: " +m_jetAuthor+ " not found in JSON file: " +m_json_config_path );
    return StatusCode::FAILURE;
  }
 
  if (m_OP.empty() || !m_json_config[m_outputName][m_jetAuthor].contains(m_OP)){
    ATH_MSG_ERROR( "OP " +m_OP+ " not available for " +m_outputName+ " tagger.");
    return StatusCode::FAILURE;
  }
 
  const auto& meta = m_json_config[m_outputName][m_jetAuthor]["meta"];
  const std::string truthLabel = meta["TruthLabel"];
  m_truthLabelAcc = std::make_unique<SG::ConstAccessor<int>>(truthLabel);
 
  // map truth labels to categories for scale factors
  // NB: MC-MC scale factors have a dedicated truth label to categories mapping
  if (meta.contains("labelMapping")) {
    for (auto& el : meta["labelMapping"].items()) {
      std::string label = el.key();
      for (const auto& num : el.value()) {
        int key = num; 
        m_labelMap[key] = label;
      }
    }
  } else {
    ATH_MSG_WARNING("No 'labelMapping' defined in JSON.");
  }
 
  // map truth labels to categories for MC-MC scale factors
  if (meta.contains("labelMappingMCMC")) {
    for (auto& el : meta["labelMappingMCMC"].items()) {
      std::string label = el.key();
      for (const auto& num : el.value()) {
        int key = num; 
        m_labelMapMCMC[key] = label;
      }
    }
  } else {
    ATH_MSG_WARNING("No 'labelMappingMCMC' defined in JSON.");
  }
 
  // Get mass decorator if specified
  if (meta.contains("Mass")) {
    std::string massDecoratorName = meta["Mass"].get<std::string>();
    if (massDecoratorName != "default") {
      m_massAcc = std::make_unique<SG::ConstAccessor<float>>(massDecoratorName);
      ATH_MSG_INFO("Using decorated mass '" << massDecoratorName << "' for Efficiency SF.");
    }
  }
 
  if (meta.contains("PT")) {
    std::string ptDecoratorName = meta["PT"].get<std::string>();
    if (ptDecoratorName != "default") {
      m_ptAcc = std::make_unique<SG::ConstAccessor<float>>(ptDecoratorName);
      ATH_MSG_INFO("Using decorated pT '" << ptDecoratorName << "' for Efficiency SF.");
    }
  }
  // preload pt bins, systematics and SFs for each category
  const auto& json_config_OP = m_json_config[m_outputName][m_jetAuthor][m_OP];
  if (json_config_OP.contains("data_mc")) {
    if (!meta.contains("labelMapping")) {
      ATH_MSG_ERROR("JSON contains data-mc scale factors but no 'labelMapping'.");
      return StatusCode::FAILURE;
    }
    for (const auto& label : meta["labelMapping"].items()) {
      std::string labelString = label.key();
      if (json_config_OP["data_mc"].contains(labelString)) {
        for (const auto& pt : json_config_OP["data_mc"][labelString]["pt"]) {
          m_sfPtMap[labelString].push_back(BTaggingToolUtil::getExtendedFloat(pt));
        }
 
        m_sfMap[labelString] = json_config_OP["data_mc"][labelString]["nominal"].get<std::vector<float>>();
        for (auto& [systematicName, values] : json_config_OP["data_mc"][labelString]["systematics"].items()){
          m_sfSysMap[labelString][systematicName] = values.get<std::vector<float>>();
        }
      }
    }
  } else {
    ATH_MSG_WARNING("No calibration data-mc scale factors present in json.");
  }
 
  if (meta.contains("labelMappingMCMC") && !json_config_OP.contains("mc_mc")) {
    ATH_MSG_ERROR("JSON contains labelMappingMCMC but no mc-mc entry found for the WP used.");
    return StatusCode::FAILURE;
  }
 
  if (json_config_OP.contains("mc_mc")) {
    // Get the MC-MC json configuration related config
    const auto &json_config_OPMCMC = json_config_OP["mc_mc"];
 
    if (!meta.contains("labelMappingMCMC")) {
      ATH_MSG_ERROR("JSON contains mc-to-mc corrections but no 'labelMappingMCMC'.");
      return StatusCode::FAILURE;
    }
    if (!json_config_OPMCMC.contains("binsVariables")) {
      ATH_MSG_ERROR("No binning variables defined for mc-to-mc corrections in JSON.");
      return StatusCode::FAILURE;
    }
    if (!json_config_OPMCMC.contains("corrections")){
      ATH_MSG_ERROR("No mc-to-mc corrections in JSON.");
      return StatusCode::FAILURE;
    }
 
    const auto &varNames = json_config_OPMCMC["binsVariables"].get<std::vector<std::string>>();
    std::vector<varType> vTypes;
    vTypes.reserve(varNames.size());
    for (const auto& name : varNames) {
      const varType vType = getVariableType(name);
      vTypes.push_back(vType);
    }
    if (!m_mcGenerator.value().empty()) {
      // JSON file contains mc-to-mc corrections and user provided the mc generator
      // Hence retrieving relevant MC-MC information from the JSON file
      for (const auto& label : meta["labelMappingMCMC"].items()) {
        std::string labelStringMCMC = label.key();
 
        if (!json_config_OPMCMC["corrections"].contains(labelStringMCMC)) {
          ATH_MSG_ERROR("JSON file contains labelStringMCMC=" << labelStringMCMC <<  " but no corresponding MC-MC SF found in the file");
          return StatusCode::FAILURE;
        }
        // Retrieve the corrections associted to the label string 
        const auto& mcmcAtLabel = json_config_OPMCMC["corrections"][labelStringMCMC];
        if (mcmcAtLabel.contains("reference")) {
          // Retrieve the reference generator used for the calibration 
          m_mcReference[labelStringMCMC] = mcmcAtLabel["reference"];
 
          // If the MC generator of the sample being processed is the same as the reference MC generator
          // Then there is no MC-MC scale factor to be applied as processing the same MC generator as used for the calibration
          // Hence skipping the rest 
          if (m_mcGenerator.value() == m_mcReference.at(labelStringMCMC)) continue;
 
          // Make sure the generator associated to the sample being processed is provided 
          if (!mcmcAtLabel.contains(m_mcGenerator.value())) {
            ATH_MSG_ERROR("No mc-to-mc corrections for generator '" << m_mcGenerator.value() << "' and label " << labelStringMCMC);
            return StatusCode::FAILURE;
          }
          
          for (const auto& entry : mcmcAtLabel[m_mcGenerator.value()]) {
            try {
              m_mcmcHandlers[labelStringMCMC].push_back(MCMCHandler(entry, vTypes));
              // // Useful for debugging
              // // Get the latest handler that was just added 
              // const MCMCHandler &handler = m_mcmcHandlers[labelStringMCMC][ m_mcmcHandlers[labelStringMCMC].size() -1 ];
              // // Then print its content 
              // std::cout << "labelStringMCMC=" << labelStringMCMC << ": " << handler.to_string() << std::endl;
            } catch (const std::exception& e) {
              ATH_MSG_ERROR("Malformed mc-to-mc correction for label " << labelStringMCMC
                            << " and generator '" << m_mcGenerator.value() << "': " << e.what());
              return StatusCode::FAILURE;
            }
          }
        } else {
          ATH_MSG_ERROR("mc-to-mc corrections incomplete for jet with truthLabel: " << labelStringMCMC << ".");
          return StatusCode::FAILURE;
        }
      }
    } else {
        // The JSON file contains MC-MC scale factors but the user did not provide the MC Generator of the sample processed
        ATH_MSG_ERROR("No mc generator passed to the tool. Please provide the mc generator for the mc-to-mc corrections.");
        return StatusCode::FAILURE;
    }
  } else {
    // No mc-to-mc corrections present in the given json file.
    ATH_MSG_WARNING("No mc-to-mc corrections present in json.");
  }
 
  // Now check there is no overlapping bins for MCMChandlers  
  for (const auto& [labelStringMCMC, handlers] : m_mcmcHandlers) {
    for (size_t i = 0; i < handlers.size(); ++i) {
      for (size_t j = i + 1; j < handlers.size(); ++j) {
        if (handlers[i].overlaps(handlers[j])) {
          ATH_MSG_ERROR("Overlapping mc-to-mc bins for label " << labelStringMCMC
                        << " and generator '" << m_mcGenerator.value() << "': "
                        << handlers[i] << " and " << handlers[j] );
          return StatusCode::FAILURE;
        }
      }
    }
  }
  
  m_currentSys = nullptr;
  m_sysCache.initialize(affectingSystematics(),
                   [this](const CP::SystematicSet& systConfig, sysData& sys)
                   {return calcSystematicVariation(systConfig, sys);});
  if (m_sysCache.get(CP::SystematicSet(), m_currentSys) != StatusCode::SUCCESS) {
    ATH_MSG_ERROR("Failed to initialize systematic cache");
    return StatusCode::FAILURE;
  }
 
  m_initialised = true;
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns

The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                  {
 
      return MSG::name( msg().level() );
   }

msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, and KtDeltaRTool.

Definition at line 131 of file AsgTool.cxx.

                             {
 
      ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
      return;
   }

recommendedSystematics()

CP::SystematicSet BTaggingEfficiencyJsonTool::recommendedSystematics ( ) const

overridevirtual

the list of all systematics this tool recommends to use

Implements CP::IReentrantSystematicsTool.

Definition at line 626 of file BTaggingEfficiencyJsonTool.cxx.

{
    return affectingSystematics();
}

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 368 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 352 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, and AthCheckedComponent<::AthAlgTool >.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 298 of file AthCommonDataStore.h.

                                               {
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Friends And Related Symbol Documentation

operator<< [1/2]

std::ostream & operator<< ( std::ostream & os, const BoundsHandler & handler )

friend

Definition at line 536 of file BTaggingEfficiencyJsonTool.cxx.

                                                                                              {
  // Add the list of variables with lower and upper bounds
  // e.g. "pT: [250, 500], mass: [50, 100]"
  // The separator ", " is only added between entries, not after the last one
  bool first = true;
  for (const auto& [vType, bounds] : handler.m_varBinBounds) {
    if (!first) os << ", ";
    first = false;
    os << BTaggingEfficiencyJsonTool::getVariableName(vType) << ": [" << bounds.lowerBound << ", " << bounds.upperBound << "]";
  }
  return os;
}

operator<< [2/2]

std::ostream & operator<< ( std::ostream & os, const MCMCHandler & handler )

friend

Definition at line 549 of file BTaggingEfficiencyJsonTool.cxx.

                                                                                            {
  // Return
  // MCMCHandler(var1: [minVar1, maxVar1], var2: [minVar2, maxVar2], ... , SF: sfValue)
  // e.g. MCMCHandler(pT: [250, 500], abseta[0., 2.0], SF: 0.9)
  os << "MCMCHandler(";
  // Add the list of variables with lower and upper bounds
  os << dynamic_cast<const BTaggingEfficiencyJsonTool::BoundsHandler&>(handler);
  // Finally add the MC-MC SF value
  os << ", SF: " << handler.m_MCMCSF << ")";
  return os;
}

Member Data Documentation

m_currentSys

const sysData* BTaggingEfficiencyJsonTool::m_currentSys {nullptr}

private

Definition at line 188 of file BTaggingEfficiencyJsonTool.h.

{nullptr};

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 381 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 378 of file AthCommonDataStore.h.

m_initialised

bool BTaggingEfficiencyJsonTool::m_initialised = false

private

Definition at line 35 of file BTaggingEfficiencyJsonTool.h.

m_jetAuthor

Gaudi::Property<std::string> BTaggingEfficiencyJsonTool::m_jetAuthor {this, "JetAuthor", "", "Jet collection"}

private

Definition at line 39 of file BTaggingEfficiencyJsonTool.h.

{this, "JetAuthor", "", "Jet collection"};

m_json_config

json BTaggingEfficiencyJsonTool::m_json_config

private

Definition at line 47 of file BTaggingEfficiencyJsonTool.h.

m_json_config_path

Gaudi::Property<std::string> BTaggingEfficiencyJsonTool::m_json_config_path {this, "JsonConfigFile", "", "Path to JSON config file"}

private

Definition at line 40 of file BTaggingEfficiencyJsonTool.h.

{this, "JsonConfigFile", "", "Path to JSON config file"};

m_labelMap

std::map<int, std::string> BTaggingEfficiencyJsonTool::m_labelMap

private

Definition at line 48 of file BTaggingEfficiencyJsonTool.h.

m_labelMapMCMC

std::map<int, std::string> BTaggingEfficiencyJsonTool::m_labelMapMCMC

private

Definition at line 49 of file BTaggingEfficiencyJsonTool.h.

m_massAcc

std::unique_ptr<SG::ConstAccessor<float> > BTaggingEfficiencyJsonTool::m_massAcc

private

Definition at line 181 of file BTaggingEfficiencyJsonTool.h.

m_maxEta

Gaudi::Property<float> BTaggingEfficiencyJsonTool::m_maxEta {this, "MaxEta", 2.5, "Maximum jet eta cut"}

private

Definition at line 45 of file BTaggingEfficiencyJsonTool.h.

{this, "MaxEta", 2.5, "Maximum jet eta cut"};

m_mcGenerator

Gaudi::Property<std::string> BTaggingEfficiencyJsonTool::m_mcGenerator {this, "MCGenerator", "", "Name of the MC generator of the sample being processed (required for MC-MC scale factor)"}

private

Definition at line 41 of file BTaggingEfficiencyJsonTool.h.

{this, "MCGenerator", "", "Name of the MC generator of the sample being processed (required for MC-MC scale factor)"};

m_mcmcHandlers

std::map<std::string, std::vector<MCMCHandler> > BTaggingEfficiencyJsonTool::m_mcmcHandlers

private

Definition at line 178 of file BTaggingEfficiencyJsonTool.h.

m_mcReference

std::map<std::string, std::string> BTaggingEfficiencyJsonTool::m_mcReference

private

Definition at line 177 of file BTaggingEfficiencyJsonTool.h.

m_minPt

Gaudi::Property<float> BTaggingEfficiencyJsonTool::m_minPt {this, "MinPt", -1 , "Minimum jet pT cut (in MeV)"}

private

Definition at line 44 of file BTaggingEfficiencyJsonTool.h.

{this, "MinPt", -1 /*MeV*/, "Minimum jet pT cut (in MeV)"};

m_OP

Gaudi::Property<std::string> BTaggingEfficiencyJsonTool::m_OP {this, "OperatingPoint", "", "Operating point"}

private

Definition at line 38 of file BTaggingEfficiencyJsonTool.h.

{this, "OperatingPoint", "", "Operating point"};

m_outputName

Gaudi::Property<std::string> BTaggingEfficiencyJsonTool::m_outputName {this, "OutputName", "", "Output name of the tagger"}

private

Definition at line 37 of file BTaggingEfficiencyJsonTool.h.

{this, "OutputName", "", "Output name of the tagger"};

m_ptAcc

std::unique_ptr<SG::ConstAccessor<float> > BTaggingEfficiencyJsonTool::m_ptAcc

private

Definition at line 182 of file BTaggingEfficiencyJsonTool.h.

m_sfMap

std::map<std::string, std::vector<float> > BTaggingEfficiencyJsonTool::m_sfMap

private

Definition at line 172 of file BTaggingEfficiencyJsonTool.h.

m_sfPtMap

std::map<std::string, std::vector<float> > BTaggingEfficiencyJsonTool::m_sfPtMap

private

Definition at line 173 of file BTaggingEfficiencyJsonTool.h.

m_sfSysMap

std::map<std::string, std::map<std::string, std::vector<float> > > BTaggingEfficiencyJsonTool::m_sfSysMap

private

Definition at line 174 of file BTaggingEfficiencyJsonTool.h.

m_sysCache

CP::SystematicsCache<sysData> BTaggingEfficiencyJsonTool::m_sysCache {this}

private

Definition at line 187 of file BTaggingEfficiencyJsonTool.h.

{this};

m_truthLabelAcc

std::unique_ptr<SG::ConstAccessor<int> > BTaggingEfficiencyJsonTool::m_truthLabelAcc

private

Definition at line 180 of file BTaggingEfficiencyJsonTool.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 387 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 386 of file AthCommonDataStore.h.

---

The documentation for this class was generated from the following files:

• BTaggingEfficiencyJsonTool.h
• BTaggingEfficiencyJsonTool.cxx