Implementation for xAOD Truth Weight Tool which retrieves the charm / bottom hadron content of an event and derives an event weight based on the HF production fractions. More...

#include <PMGHFProductionFractionTool.h>

Inheritance diagram for PMGTools::PMGHFProductionFractionTool:

Collaboration diagram for PMGTools::PMGHFProductionFractionTool:

Classes
struct	ParameterSet
	Struct for the production fractions. More...

Public Member Functions
	PMGHFProductionFractionTool (const std::string &name)
	Create a proper constructor for Athena. More...

virtual void	print () const =0
	Print the state of the tool. More...

virtual StatusCode	sysInitialize ()
	Function initialising the tool in the correct way in Athena. More...

virtual void	print () const
	Print the state of the tool. More...

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

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

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Function(s) implementing the asg::IAsgTool interface
virtual StatusCode	initialize () override
	Function initialising the tool. More...

Function(s) implementing the ISysTruthWeightTool interface
virtual float	getSysWeight (const xAOD::TruthParticleContainer *truthParticles, const CP::SystematicSet &sys) const override
	Implements interface from ISysTruthWeightTool. More...

virtual CP::SystematicSet	affectingSystematics () const override
	Which systematics have an effect on the tool's behaviour? More...

virtual CP::SystematicSet	recommendedSystematics () const override
	Copied from SystematicsTool.cxx. More...

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

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. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	setupProductionFractions ()
	Setup weights. More...

StatusCode	readProductionFractionsFile (const std::string &, std::map< CP::SystematicVariation, std::map< unsigned int, float >> &)
	Read production fractions from input file. More...

bool	fromBdecay (const xAOD::TruthParticle *particle) const
	Checks if a particle originates from a bottom decay. More...

const xAOD::TruthParticle *	getInitialParticle (const xAOD::TruthParticle *tp) const
	Loops back the decay chain through particles with the same pdgId (e.g. photon emission) More...

void	printCurrentProdFractions () const
	Print the current production fractions. More...

float	getWeight (const xAOD::TruthParticleContainer *truthParticles, const ParameterSet &prod_fracs) const

StatusCode	setSystematicVariation (const CP::SystematicSet &systConfig, ParameterSet &param) const
	calculate the parameter set for the given systematic More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
std::string	m_calibrationAreaPath
	Path to calibration area. More...

std::map< std::string, std::string >	m_showerGeneratorMap
	MC Shower generator map. More...

std::string	m_showerGeneratorMapFile
	MC Shower generator map file name. More...

std::string	m_showerGenerator
	MC Shower generator software (valid options: Pythia8) More...

std::string	m_charmFilename
	Input file with charm production fractions. More...

std::string	m_bottomFilename
	Input file with bottom production fractions. More...

float	m_fiducialPtCut
	The fiducial charm/bottom pT cut (in GeV) More...

float	m_fiducialEtaCut
	The fiducial charm/bottom eta cut. More...

std::map< CP::SystematicVariation, std::map< unsigned int, float > >	m_charmProdFractionWeights
	Charm production fraction weights. More...

std::map< CP::SystematicVariation, std::map< unsigned int, float > >	m_bottomProdFractionWeights
	Bottom production fraction weights. More...

CP::SystematicsCache< ParameterSet >	m_Parameters {this}
	The SystematicsCache object. More...

MetaStore_t	m_inputMetaStore
	Object accessing the input metadata store. More...

MetaStore_t	m_outputMetaStore
	Object accessing the output metadata store. More...

bool	m_beginInputFileCalled
	Flag helping to discover when the tool misses the opening of the first input file. More...

bool	m_useIncidents

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Callback functions helping in metadata reading/writing
void	setUseIncidents (const bool flag)

virtual void	handle (const Incident &inc)
	Function receiving incidents from IncidentSvc/TEvent. More...

virtual StatusCode	beginInputFile ()
	Function called when a new input file is opened. More...

virtual StatusCode	endInputFile ()
	Function called when the currently open input file got completely processed. More...

virtual StatusCode	beginEvent ()
	Function called when a new events is loaded. More...

virtual StatusCode	metaDataStop ()
	Function called when the tool should write out its metadata. More...

Detailed Description

Implementation for xAOD Truth Weight Tool which retrieves the charm / bottom hadron content of an event and derives an event weight based on the HF production fractions.

Author: Miha Muskinja

Definition at line 25 of file PMGHFProductionFractionTool.h.

Member Typedef Documentation

◆ MetaStore_t

typedef ServiceHandle< StoreGateSvc > asg::AsgMetadataTool::MetaStore_t

inherited

Type of the metadata store object in Athena.

Definition at line 66 of file AsgMetadataTool.h.

◆ MetaStorePtr_t

typedef const ServiceHandle< StoreGateSvc >& asg::AsgMetadataTool::MetaStorePtr_t

inherited

Type of the metadata store pointer in standalone mode.

Definition at line 68 of file AsgMetadataTool.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ PMGHFProductionFractionTool()

PMGTools::PMGHFProductionFractionTool::PMGHFProductionFractionTool ( const std::string & name )

Create a proper constructor for Athena.

Create a constructor for standalone usage

Definition at line 25 of file PMGHFProductionFractionTool.cxx.

                                                                              :
     asg::AsgMetadataTool(name),
     m_calibrationAreaPath(""),
     m_showerGeneratorMap({}),
     m_showerGeneratorMapFile(""),
     m_showerGenerator(""),
     m_charmFilename(""),
     m_bottomFilename(""),
     m_charmProdFractionWeights({}),
     m_bottomProdFractionWeights({})
 {
     // Calibration area path
     declareProperty("CalibrationAreaPath", m_calibrationAreaPath = "xAODBTaggingEfficiency/13TeV/HFReweighting-2022-04-19_v1",
                     "Path to the calibration area");
  
     // MC Shower generator map
     declareProperty("ShowerGeneratorMapFile", m_showerGeneratorMapFile = "HFProductionFractionsMap.txt",
                     "Input file name for the MC shower generator map");
  
     // MC Shower generator software
     declareProperty("ShowerGenerator", m_showerGenerator = "",
                     "MC Shower generator software");
  
     // The fiducial charm/bottom pT cut (in MeV)
     declareProperty("FiducialPtCut", m_fiducialPtCut = 5000,
                     "The fiducial charm/bottom pT cut. The recommended value is 5000 (MeV).");
  
     // The fiducial charm/bottom eta cut
     declareProperty("FiducialEtaCut", m_fiducialEtaCut = 2.5,
                     "The fiducial charm/bottom eta cut. The recommended value is 2.5.");
 }

Member Function Documentation

◆ affectingSystematics()

CP::SystematicSet PMGTools::PMGHFProductionFractionTool::affectingSystematics ( ) const

overridevirtual

Which systematics have an effect on the tool's behaviour?

Systematics set of the weight systematics

Implements CP::IReentrantSystematicsTool.

Definition at line 448 of file PMGHFProductionFractionTool.cxx.

 {
   if (m_charmProdFractionWeights.empty() || m_bottomProdFractionWeights.empty()) {
     ATH_MSG_ERROR("The production fraction weights were not properly initialized!");
     throw std::runtime_error("Charm or bottom production fraction weight map is empty!");
   }
   CP::SystematicSet result;
   for (const auto &kv : m_charmProdFractionWeights) {
     if(!kv.first.empty())
       result.insert(kv.first);
   }
   for (const auto &kv : m_bottomProdFractionWeights) {
     if(!kv.first.empty())
       result.insert(kv.first);
   }
  
   return result;
 }

◆ beginEvent()

StatusCode asg::AsgMetadataTool::beginEvent ( )

protectedvirtualinherited

Function called when a new events is loaded.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in AsgElectronEfficiencyCorrectionTool, TrigConf::xAODConfigTool, TauAnalysisTools::TauSelectionTool, TauAnalysisTools::DiTauSelectionTool, TauAnalysisTools::CommonSmearingTool, TauAnalysisTools::DiTauEfficiencyCorrectionsTool, Trig::TrigDecisionTool, TauAnalysisTools::TauEfficiencyCorrectionsTool, Trig::TrigConfBunchCrossingTool, xAODMaker::TriggerMenuMetaDataTool, and Trig::xAODBunchCrossingTool.

Definition at line 201 of file AsgMetadataTool.cxx.

                                           {
  
       // Return gracefully:
       return StatusCode::SUCCESS;
    }

◆ beginInputFile()

StatusCode asg::AsgMetadataTool::beginInputFile ( )

protectedvirtualinherited

Function called when a new input file is opened.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in AsgElectronEfficiencyCorrectionTool, TrigConf::xAODConfigTool, PMGTools::PMGTruthWeightTool, BookkeeperTool, BookkeeperDumperTool, Trig::TrigDecisionTool, xAODMaker::TriggerMenuMetaDataTool, xAODMaker::TruthMetaDataTool, Trig::xAODBunchCrossingTool, TauAnalysisTools::TauEfficiencyCorrectionsTool, and TauAnalysisTools::TauSmearingTool.

Definition at line 185 of file AsgMetadataTool.cxx.

                                               {
  
       // Return gracefully:
       return StatusCode::SUCCESS;
    }

◆ declareGaudiProperty() [1/4]

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

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [2/4]

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());
  
   }

◆ declareGaudiProperty() [3/4]

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

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [4/4]

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

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

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.

95 { return m_detStore; }

◆ endInputFile()

StatusCode asg::AsgMetadataTool::endInputFile ( )

protectedvirtualinherited

Function called when the currently open input file got completely processed.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in BookkeeperTool, BookkeeperDumperTool, xAODMaker::TriggerMenuMetaDataTool, and xAODMaker::TruthMetaDataTool.

Definition at line 193 of file AsgMetadataTool.cxx.

                                             {
  
       // Return gracefully:
       return StatusCode::SUCCESS;
    }

◆ evtStore() [1/2]

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.

85 { return m_evtStore; }

◆ evtStore() [2/2]

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

inlineinherited

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

Definition at line 90 of file AthCommonDataStore.h.

90 { 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

◆ fromBdecay()

bool PMGTools::PMGHFProductionFractionTool::fromBdecay ( const xAOD::TruthParticle * particle ) const

private

Checks if a particle originates from a bottom decay.

Definition at line 283 of file PMGHFProductionFractionTool.cxx.

                                                                                     {
   for (unsigned int i = 0; i < particle->nParents(); i++) {
     if (particle->parent(i)->isHeavyHadron()) {
       if (particle->parent(i)->isBottomHadron()) {
         return true;
       } else {
         return fromBdecay(particle->parent(i));
       }
     }
   }
   return false;
 }

◆ getInitialParticle()

const xAOD::TruthParticle * PMGTools::PMGHFProductionFractionTool::getInitialParticle ( const xAOD::TruthParticle * tp ) const

private

Loops back the decay chain through particles with the same pdgId (e.g. photon emission)

Definition at line 296 of file PMGHFProductionFractionTool.cxx.

                                                                                                           {
   if (tp->nParents() < 1) {
     return tp;
   }
  
   const xAOD::TruthParticle *out = nullptr;
   for (unsigned int i = 0; i < tp->nParents(); i++) {
     if (tp->parent(i) && (tp->parent(i)->absPdgId() == tp->absPdgId())) {
       const xAOD::TruthParticle *initialParticle = getInitialParticle(tp->parent(i));
       if (initialParticle && out && (initialParticle != out)) {
         // this should never happen, but if it does crash the program
         throw std::runtime_error("Contradictory information in the truth decay chain!");
       }
       out = initialParticle;
     }
   }
  
   if (out) {
     return out;
   }
   return tp;
 }

◆ 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::TEvent 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::TEvent, 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
    }

◆ 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::TEvent 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::TEvent, 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.

◆ getSysWeight()

float PMGTools::PMGHFProductionFractionTool::getSysWeight	(	const xAOD::TruthParticleContainer *	truthParticles,
		const CP::SystematicSet &	sys
	)		const

overridevirtual

Implements interface from ISysTruthWeightTool.

Implements PMGTools::ISysTruthWeightTool.

Definition at line 379 of file PMGHFProductionFractionTool.cxx.

                                                                                                                                   {
   if (m_showerGenerator == "000000") { return 1.0; }
   const ParameterSet *prod_fracs = nullptr;
   ANA_CHECK_THROW (m_Parameters.get(sys, prod_fracs));
   return getWeight(truthParticles, *prod_fracs);
 }

◆ getWeight()

float PMGTools::PMGHFProductionFractionTool::getWeight	(	const xAOD::TruthParticleContainer *	truthParticles,
		const ParameterSet &	prod_fracs
	)		const

private

Definition at line 319 of file PMGHFProductionFractionTool.cxx.

                                                                                                                                    {
   // Clear vectors
   std::set<const xAOD::TruthParticle *> bottomHadrons;
   std::set<const xAOD::TruthParticle *> charmHadrons;
  
   // Find truth particles hadrons
   for (const xAOD::TruthParticle *tp : *truthParticles) {
     // if (!(tp->status() == 2 || tp->status() == 1)) {
     //   continue;
     // }
     if (tp->isBottomHadron())
     {
       if (tp->pt() >= m_fiducialPtCut && std::abs(tp->eta()) < m_fiducialEtaCut) {
         bottomHadrons.insert(getInitialParticle(tp));
       }
     }
     if (tp->isCharmHadron()) {
       if (!fromBdecay(getInitialParticle(tp)) && tp->pt() >= m_fiducialPtCut && std::abs(tp->eta()) < m_fiducialEtaCut) {
         charmHadrons.insert(getInitialParticle(tp));
       }
     }
   }
  
   // The weight
   float weight = 1.0;
  
   // Calculate the charm weight
   for (auto *tp : charmHadrons) {
     int pdgId = tp->absPdgId();
     float w = 1.0;
     if (tp->isCharmMeson() && prod_fracs.charmWeights.find(pdgId) != prod_fracs.charmWeights.end()) {
       w = prod_fracs.charmWeights.at(pdgId);
     } else if (pdgId == 4122 || // Lambda_c+
                pdgId == 4232 || // Xi_c+
                pdgId == 4132 || // Xi_c0
                pdgId == 4332) { // Omega_c0
       w = prod_fracs.charmWeights.at(4000);
     }
     ATH_MSG_DEBUG("Charm weight for pdgId " << pdgId << ", pT " << tp->pt() << ", eta " << tp->eta() << ": " << w);
     weight *= w;
   }
  
   // Calculate the bottom weight
   for (auto *tp : bottomHadrons) {
     int pdgId = tp->absPdgId();
     float w = 1.0;
     if (tp->isBottomMeson() && prod_fracs.bottomWeights.find(pdgId) != prod_fracs.bottomWeights.end()) {
       w = prod_fracs.bottomWeights.at(pdgId);
     } else if (pdgId == 5122 || // Lambda_b0
                pdgId == 5132 || // Xi_b-
                pdgId == 5232 || // Xi_b0
                pdgId == 5332) { // Omega_b-
       w = prod_fracs.bottomWeights.at(5000);
     }
     ATH_MSG_DEBUG("Bottom weight for pdgId " << pdgId << ", pT " << tp->pt() << ", eta " << tp->eta() << ": " << w);
     weight *= w;
   }
   return weight;
 }

◆ handle()

void asg::AsgMetadataTool::handle ( const Incident & inc )

protectedvirtualinherited

Function receiving incidents from IncidentSvc/TEvent.

Reimplemented in Trig::TrigDecisionTool.

Definition at line 135 of file AsgMetadataTool.cxx.

                                                      {
  
       // Tell the user what's happening:
       ATH_MSG_VERBOSE( "Callback received with incident: " << inc.type() );
  
       // Call the appropriate member function:
       if( inc.type() == IncidentType::BeginInputFile ) {
         m_beginInputFileCalled = true;
         if( beginInputFile().isFailure() ) {
           ATH_MSG_FATAL( "Failed to call beginInputFile()" );
           throw std::runtime_error( "Couldn't call beginInputFile()" );
          }
       } else if( inc.type() == IncidentType::EndInputFile ) {
         if( endInputFile().isFailure() ) {
           ATH_MSG_FATAL( "Failed to call endInputFile()" );
           throw std::runtime_error( "Couldn't call endInputFile()" );
          }
       } else if( inc.type() == IncidentType::BeginEvent ) {
          // If the tool didn't catch the begin input file incident for the
          // first input file of the job, then call the appropriate function
          // now.
          if( ! m_beginInputFileCalled ) {
             m_beginInputFileCalled = true;
             if( beginInputFile().isFailure() ) {
                ATH_MSG_FATAL( "Failed to call beginInputFile()" );
                throw std::runtime_error( "Couldn't call beginInputFile()" );
             }
          }
          if( beginEvent().isFailure() ) {
             ATH_MSG_FATAL( "Failed to call beginEvent()" );
             throw std::runtime_error( "Couldn't call beginEvent()" );
          }
  
      #ifdef XAOD_STANDALONE
       } else if( inc.type() == IncidentType::MetaDataStop ) {
          if( metaDataStop().isFailure() ) {
             ATH_MSG_FATAL( "Failed to call metaDataStop()" );
             throw std::runtime_error( "Couldn't call metaDataStop()" );
          }
          
      #endif // XAOD_STANDALONE
       } else {
          ATH_MSG_WARNING( "Unknown incident type received in AsgMetaDataTool: " << inc.type() );
       }
  
       return;
    }

◆ initialize()

StatusCode PMGTools::PMGHFProductionFractionTool::initialize ( )

overridevirtual

Function initialising the tool.

Reimplemented from asg::AsgTool.

Definition at line 57 of file PMGHFProductionFractionTool.cxx.

                                                    {
   // Tell the user what's happening:
   ATH_MSG_INFO("Initializing " << name() << "...");
  
   // Check for correct settings
   if (m_showerGenerator.empty())
   {
       ATH_MSG_WARNING("The property `ShowerGenerator' was not set!");
       return StatusCode::FAILURE;
   }
  
   // read input files and calculate weights
   // populates m_charmProdFractionWeights and m_bottomProdFractionWeights
   if (m_showerGenerator != "000000") {
     ANA_CHECK(setupProductionFractions());
  
     // setup the SystematicsCache object
     m_Parameters.initialize(affectingSystematics(), 
       [this](const CP::SystematicSet &sys, ParameterSet &prod_fracs) {
         return setSystematicVariation(sys, prod_fracs);
       }
     );
  
     // Register systematics with the registry
     CP::SystematicRegistry &registry = CP::SystematicRegistry::getInstance();
     if (registry.registerSystematics(*this) != StatusCode::SUCCESS) {
       ATH_MSG_ERROR("Unknown systematic list");
       return StatusCode::FAILURE;
     }
  
     // print
     printCurrentProdFractions();
  
   } else {
     ATH_MSG_WARNING("The property `ShowerGenerator' was set to 000000, which means that the tool will return dummy weights of 1.0");
   }
  
   // Return gracefully
   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.

◆ inputMetaStore()

AsgMetadataTool::MetaStorePtr_t asg::AsgMetadataTool::inputMetaStore ( ) const

inherited

Accessor for the input metadata store.

Definition at line 93 of file AsgMetadataTool.cxx.

                                                                        {
  
 #ifdef XAOD_STANDALONE
       return &m_inputMetaStore;
 #else // XAOD_STANDALONE
       return m_inputMetaStore;
 #endif // XAOD_STANDALONE
    }

◆ metaDataStop()

StatusCode asg::AsgMetadataTool::metaDataStop ( )

protectedvirtualinherited

Function called when the tool should write out its metadata.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in BookkeeperTool, BookkeeperDumperTool, xAODMaker::TriggerMenuMetaDataTool, and xAODMaker::TruthMetaDataTool.

Definition at line 209 of file AsgMetadataTool.cxx.

                                             {
  
       // Return gracefully:
       return StatusCode::SUCCESS;
    }

◆ msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ 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.

◆ outputMetaStore()

AsgMetadataTool::MetaStorePtr_t asg::AsgMetadataTool::outputMetaStore ( ) const

inherited

Accessor for the output metadata store.

Definition at line 102 of file AsgMetadataTool.cxx.

                                                                         {
  
 #ifdef XAOD_STANDALONE
       return &m_outputMetaStore;
 #else // XAOD_STANDALONE
       return m_outputMetaStore;
 #endif // XAOD_STANDALONE
    }

◆ print() [1/2]

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

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

Definition at line 131 of file AsgTool.cxx.

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

◆ print() [2/2]

virtual void asg::IAsgTool::print ( ) const

pure virtualinherited

Print the state of the tool.

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

◆ printCurrentProdFractions()

void PMGTools::PMGHFProductionFractionTool::printCurrentProdFractions ( ) const

private

Print the current production fractions.

Definition at line 386 of file PMGHFProductionFractionTool.cxx.

                                                                   {
   // MC Shower
   ATH_MSG_INFO("The tool is currently configured to give weights for " << m_showerGenerator);
  
   // Charm production fraction weights
   ATH_MSG_INFO("Currently set weights for charm production fractions:");
   for (auto const &generator : m_charmProdFractionWeights) {
     ATH_MSG_INFO("sys: " << generator.first.name());
     for (auto const &kv : generator.second) {
       ATH_MSG_INFO(" - " << kv.first << " " << kv.second);
     }
   }
  
   // Bottom production fraction weights
   ATH_MSG_INFO("Currently set weights for bottom production fractions:");
   for (auto const &generator : m_bottomProdFractionWeights) {
     ATH_MSG_INFO("sys: " << generator.first.name());
     for (auto const &kv : generator.second) {
       ATH_MSG_INFO(" - " << kv.first << " " << kv.second);
     }
   }
 }

◆ readProductionFractionsFile()

StatusCode PMGTools::PMGHFProductionFractionTool::readProductionFractionsFile	(	const std::string &	filename,
		std::map< CP::SystematicVariation, std::map< unsigned int, float >> &	weights
	)

private

Read production fractions from input file.

Definition at line 98 of file PMGHFProductionFractionTool.cxx.

                                                                                                                                                                     {
   /* Example file structure:
       # Charm production fraction from literature (Eur. Phys. J. C (2016) 76:397)
       411 421 431 4000
       NOSYS 0.2404 0.6086 0.0802 0.0623
       PROD_FRAC_CHARM_EIG_1 0.2405 0.6087 0.0770 0.0650
       PROD_FRAC_CHARM_EIG_2 0.2439 0.6108 0.0779 0.0593
       PROD_FRAC_CHARM_EIG_3 0.2461 0.6013 0.0808 0.0632
   */
   std::ifstream infile(filename);
   std::string line;
   int pdg1 = -1, pdg2 = -1, pdg3 = -1, pdg4 = -1;
   while (std::getline(infile, line)) {
     std::istringstream iss(line);
     if (line.rfind("#", 0) == 0 || line.empty()) {
       continue;
     }
     if (pdg1 < 0) {
       if (!(iss >> pdg1 >> pdg2 >> pdg3 >> pdg4)) {
         ATH_MSG_ERROR("Invalid formatting: " << line);
         return StatusCode::FAILURE;
       }
     } else {
       std::string sys;
       float f1, f2, f3, f4;
       if (!(iss >> sys >> f1 >> f2 >> f3 >> f4)) {
         ATH_MSG_ERROR("Invalid formatting: " << line);
         return StatusCode::FAILURE;
       }
       if (sys == "NOSYS") {
         sys = "";
       }
       weights.insert({CP::SystematicVariation(sys), {{pdg1, f1}, {pdg2, f2}, {pdg3, f3}, {pdg4, f4}}});
     }
   }
  
   // Close file
   infile.close();
  
   // return
   return StatusCode::SUCCESS;
 }

◆ recommendedSystematics()

virtual CP::SystematicSet PMGTools::PMGHFProductionFractionTool::recommendedSystematics ( ) const

inlineoverridevirtual

Copied from SystematicsTool.cxx.

Implements CP::IReentrantSystematicsTool.

Definition at line 52 of file PMGHFProductionFractionTool.h.

52 { 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 380 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 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ setSystematicVariation()

StatusCode PMGTools::PMGHFProductionFractionTool::setSystematicVariation	(	const CP::SystematicSet &	systConfig,
		ParameterSet &	param
	)		const

private

calculate the parameter set for the given systematic

Definition at line 409 of file PMGHFProductionFractionTool.cxx.

                                                                                                                            {
   if (systConfig.size() > 1) {
     ATH_MSG_ERROR("Multiple systematic variations in one SystematicsSet are not supported");
     return StatusCode::FAILURE;
   }
  
   // set charm and bottom weights to nominal by default
   if (m_charmProdFractionWeights.find(CP::SystematicVariation("")) == m_charmProdFractionWeights.end()) {
     ATH_MSG_ERROR("Nominal charm weights not found");
     return StatusCode::FAILURE;
   }
  
   if (m_bottomProdFractionWeights.find(CP::SystematicVariation("")) == m_bottomProdFractionWeights.end()) {
     ATH_MSG_ERROR("Nominal bottom weights not found");
     return StatusCode::FAILURE;
   }
  
   auto charmWeights = m_charmProdFractionWeights.at(CP::SystematicVariation(""));
   auto bottomWeights = m_bottomProdFractionWeights.at(CP::SystematicVariation(""));
  
   // if a sys variation is passed that affects the weights, choose the appropriate weight set
   if (systConfig.size() == 1) {
     const CP::SystematicVariation &current_variation = *(systConfig.begin());
     if (m_charmProdFractionWeights.find(current_variation) != m_charmProdFractionWeights.end()) {
       charmWeights = m_charmProdFractionWeights.at(current_variation);
     }
  
     if (m_bottomProdFractionWeights.find(current_variation) != m_bottomProdFractionWeights.end()) {
       bottomWeights = m_bottomProdFractionWeights.at(current_variation);
     }
   }
  
   // set the ParameterSet (weights set) for use in weight calculation
   param.charmWeights = std::move(charmWeights);
   param.bottomWeights = std::move(bottomWeights);
  
   return StatusCode::SUCCESS;
 }

◆ setupProductionFractions()

StatusCode PMGTools::PMGHFProductionFractionTool::setupProductionFractions ( )

private

Setup weights.

Definition at line 141 of file PMGHFProductionFractionTool.cxx.

                                                                  {
   // Step 0: find available files
   // ________________________________________________________________
  
   // Charm production fractions data file
   std::string mapFilename = PathResolverFindCalibFile((fs::path(m_calibrationAreaPath) / fs::path(m_showerGeneratorMapFile)).string());
   if (mapFilename.empty()) {
     ATH_MSG_ERROR("Input file not found " << m_showerGeneratorMapFile);
     return StatusCode::FAILURE;
   }
   ATH_MSG_INFO("Found input file " << mapFilename);
  
   // Find all available MC generators
   std::ifstream infile(mapFilename);
   std::string line;
   while (std::getline(infile, line)) {
     std::istringstream iss(line);
     if (line.rfind("#", 0) == 0 || line.empty()) {
       continue;
     }
  
     std::string id, name;
     if (!(iss >> id >> name)) {
       ATH_MSG_ERROR("Invalid formatting: " << line);
       return StatusCode::FAILURE;
     } if (id == "4") {
       m_charmFilename = std::move(name);
     } else if (id == "5") {
       m_bottomFilename = std::move(name);
     } else {
       m_showerGeneratorMap[id] = std::move(name);
     }
   }
  
   // Close file
   infile.close();
  
   // Check if the requested MC shower version is available
   if (m_showerGeneratorMap.find(m_showerGenerator) == m_showerGeneratorMap.end()) {
     ATH_MSG_ERROR("MC shower generator " << m_showerGenerator << " not found!");
     ATH_MSG_INFO("Available generators are:");
     for (auto &gen : m_showerGeneratorMap) {
       ATH_MSG_INFO(gen.first);
     }
     return StatusCode::FAILURE;
   }
  
   // Step 1: read HF production fractions from literature
   // ________________________________________________________________
  
   // Charm production fractions data file
   std::string charmFilename = PathResolverFindCalibFile((fs::path(m_calibrationAreaPath) / fs::path(m_charmFilename)).string());
   if (charmFilename.empty()) {
     ATH_MSG_ERROR("Input file not found " << m_charmFilename);
     return StatusCode::FAILURE;
   }
   ATH_MSG_INFO("Found input file " << charmFilename);
  
   // Bottom production fractions data file
   std::string bottomFilename = PathResolverFindCalibFile((fs::path(m_calibrationAreaPath) / fs::path(m_bottomFilename)).string());
   if (bottomFilename.empty()) {
     ATH_MSG_ERROR("Input file not found " << m_bottomFilename);
     return StatusCode::FAILURE;
   }
   ATH_MSG_INFO("Found input file " << bottomFilename);
  
   // Configure the production fractions from files
   ATH_CHECK(readProductionFractionsFile(charmFilename, m_charmProdFractionWeights));
   ATH_CHECK(readProductionFractionsFile(bottomFilename, m_bottomProdFractionWeights));
  
   // Step 2: read HF production fractions for a given MC shower
   // ________________________________________________________________
  
   // Read the config files from cvmfs
   std::string filename = PathResolverFindCalibFile((fs::path(m_calibrationAreaPath) / fs::path(m_showerGeneratorMap[m_showerGenerator])).string());
   if (filename.empty()) {
     ATH_MSG_ERROR("Input file not found " << m_showerGeneratorMap[m_showerGenerator]);
     return StatusCode::FAILURE;
   }
   ATH_MSG_INFO("Found input file " << filename);
  
   // Configure the weights from the file
   /* Example file structure:
       #Sherpa(v2.2.1) (DSID 410250)
       #PDG ID | Production Fraction
       511 0.27243
       521 0.273029
       531 0.0893853
       5000 0.365034
       411 0.142884
       421 0.379585
       431 0.113005
       4000 0.364526
   */
   infile = std::ifstream(filename);
   std::map<unsigned int, float> charm;
   std::map<unsigned int, float> bottom;
   while (std::getline(infile, line)) {
     std::istringstream iss(line);
     if (line.rfind("#", 0) == 0 || line.empty()) {
       continue;
     }
  
     int pdgId;
     float fraction;
     if (!(iss >> pdgId >> fraction)) {
       ATH_MSG_ERROR("Invalid formatting: " << line);
       return StatusCode::FAILURE;
     }
     if (pdgId == 4000 || pdgId < 500) {
       ATH_MSG_DEBUG("Charm meson " << pdgId << " has a fraction of " << fraction);
       charm[pdgId] = fraction;
     } else {
       ATH_MSG_DEBUG("Bottom meson " << pdgId << " has a fraction of " << fraction);
       bottom[pdgId] = fraction;
     }
   }
  
   // Close file
   infile.close();
  
   // Step 3: calculate the weight as `w = f(literature) / f(MC)'
   // ________________________________________________________________
  
   // charm weights
   for (auto &sys : m_charmProdFractionWeights) {
     for (auto &kv : charm) {
       m_charmProdFractionWeights[sys.first][kv.first] /= kv.second;
     }
   }
  
   // bottom weights
   for (auto &sys : m_bottomProdFractionWeights) {
     for (auto &kv : bottom) {
       m_bottomProdFractionWeights[sys.first][kv.first] /= kv.second;
     }
   }
  
   // Return gracefully
   return StatusCode::SUCCESS;
 }

◆ setUseIncidents()

void asg::AsgMetadataTool::setUseIncidents ( const bool flag )

inlineprotectedinherited

Definition at line 132 of file AsgMetadataTool.h.

    {
       m_useIncidents = flag;
    }

◆ sysInitialize()

StatusCode asg::AsgMetadataTool::sysInitialize ( )

virtualinherited

Function initialising the tool in the correct way in Athena.

This function is used to set up the callbacks from IncidentSvc in Athena at the right time during initialisation, without the user having to do anything special in his/her code.

Reimplemented from AthCommonDataStore< AthCommonMsg< AlgTool > >.

Definition at line 115 of file AsgMetadataTool.cxx.

                                              {
  
 #ifndef XAOD_STANDALONE
       if (m_useIncidents) {
          // Connect to the IncidentSvc:
          ServiceHandle< IIncidentSvc > incSvc( "IncidentSvc", name() );
          ATH_CHECK( incSvc.retrieve() );
  
          // Set up the right callbacks: don't rethrow exceptions, any failure and we should end
          incSvc->addListener( this, IncidentType::BeginEvent, 0, false );
       }
       // Let the base class do its thing:
       ATH_CHECK( AlgTool::sysInitialize() );
  
 #endif // not XAOD_STANDALONE
  
       // Return gracefully:
       return StatusCode::SUCCESS;
    }

◆ 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 308 of file AthCommonDataStore.h.

                                                {
     // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
     //         << "  size: " << m_vhka.size() << endmsg;
     for (auto &a : m_vhka) {
       std::vector<SG::VarHandleKey*> keys = a->keys();
       for (auto k : keys) {
         k->setOwner(this);
       }
     }
   }

Member Data Documentation

◆ m_beginInputFileCalled

bool asg::AsgMetadataTool::m_beginInputFileCalled

privateinherited

Flag helping to discover when the tool misses the opening of the first input file.

Definition at line 126 of file AsgMetadataTool.h.

◆ m_bottomFilename

std::string PMGTools::PMGHFProductionFractionTool::m_bottomFilename

private

Input file with bottom production fractions.

Definition at line 96 of file PMGHFProductionFractionTool.h.

◆ m_bottomProdFractionWeights

std::map<CP::SystematicVariation, std::map<unsigned int, float> > PMGTools::PMGHFProductionFractionTool::m_bottomProdFractionWeights

private

Bottom production fraction weights.

Definition at line 108 of file PMGHFProductionFractionTool.h.

◆ m_calibrationAreaPath

std::string PMGTools::PMGHFProductionFractionTool::m_calibrationAreaPath

private

Path to calibration area.

Definition at line 81 of file PMGHFProductionFractionTool.h.

◆ m_charmFilename

std::string PMGTools::PMGHFProductionFractionTool::m_charmFilename

private

Input file with charm production fractions.

Definition at line 93 of file PMGHFProductionFractionTool.h.

◆ m_charmProdFractionWeights

std::map<CP::SystematicVariation, std::map<unsigned int, float> > PMGTools::PMGHFProductionFractionTool::m_charmProdFractionWeights

private

Charm production fraction weights.

Definition at line 105 of file PMGHFProductionFractionTool.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_fiducialEtaCut

float PMGTools::PMGHFProductionFractionTool::m_fiducialEtaCut

private

The fiducial charm/bottom eta cut.

Definition at line 102 of file PMGHFProductionFractionTool.h.

◆ m_fiducialPtCut

float PMGTools::PMGHFProductionFractionTool::m_fiducialPtCut

private

The fiducial charm/bottom pT cut (in GeV)

Definition at line 99 of file PMGHFProductionFractionTool.h.

◆ m_inputMetaStore

MetaStore_t asg::AsgMetadataTool::m_inputMetaStore

privateinherited

Object accessing the input metadata store.

Definition at line 119 of file AsgMetadataTool.h.

◆ m_outputMetaStore

MetaStore_t asg::AsgMetadataTool::m_outputMetaStore

privateinherited

Object accessing the output metadata store.

Definition at line 121 of file AsgMetadataTool.h.

◆ m_Parameters

CP::SystematicsCache<ParameterSet> PMGTools::PMGHFProductionFractionTool::m_Parameters {this}

private

The SystematicsCache object.

Definition at line 114 of file PMGHFProductionFractionTool.h.

◆ m_showerGenerator

std::string PMGTools::PMGHFProductionFractionTool::m_showerGenerator

private

MC Shower generator software (valid options: Pythia8)

Definition at line 90 of file PMGHFProductionFractionTool.h.

◆ m_showerGeneratorMap

std::map<std::string, std::string> PMGTools::PMGHFProductionFractionTool::m_showerGeneratorMap

private

MC Shower generator map.

Definition at line 84 of file PMGHFProductionFractionTool.h.

◆ m_showerGeneratorMapFile

std::string PMGTools::PMGHFProductionFractionTool::m_showerGeneratorMapFile

private

MC Shower generator map file name.

Definition at line 87 of file PMGHFProductionFractionTool.h.

◆ m_useIncidents

bool asg::AsgMetadataTool::m_useIncidents

privateinherited

Definition at line 128 of file AsgMetadataTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Classes

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Callback functions helping in metadata reading/writing

Detailed Description

Member Typedef Documentation

◆ MetaStore_t

◆ MetaStorePtr_t

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ PMGHFProductionFractionTool()

Member Function Documentation

◆ affectingSystematics()

◆ beginEvent()

◆ beginInputFile()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ endInputFile()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ fromBdecay()

◆ getInitialParticle()

◆ getKey()

◆ getName()

◆ getProperty()

◆ getSysWeight()

◆ getWeight()

◆ handle()

◆ initialize()

◆ inputHandles()

◆ inputMetaStore()

◆ metaDataStop()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ outputMetaStore()

◆ print() [1/2]

◆ print() [2/2]

◆ printCurrentProdFractions()

◆ readProductionFractionsFile()

◆ recommendedSystematics()

◆ renounce()

◆ renounceArray()

◆ setSystematicVariation()

◆ setupProductionFractions()

◆ setUseIncidents()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_beginInputFileCalled

◆ m_bottomFilename

◆ m_bottomProdFractionWeights

◆ m_calibrationAreaPath

◆ m_charmFilename

◆ m_charmProdFractionWeights

◆ m_detStore

◆ m_evtStore

◆ m_fiducialEtaCut

◆ m_fiducialPtCut

◆ m_inputMetaStore

◆ m_outputMetaStore

◆ m_Parameters

◆ m_showerGenerator

◆ m_showerGeneratorMap