BookkeeperTool Class Reference

#include <BookkeeperTool.h>

Inheritance diagram for BookkeeperTool:

Collaboration diagram for BookkeeperTool:

Public Member Functions
	BookkeeperTool (const std::string &name="BookkeeperTool")
	Declare the correct constructor for Athena. More...
virtual	~BookkeeperTool ()=default
	Destructor. More...
virtual StatusCode	initialize () override
	Standard reimplemented functions. More...
virtual StatusCode	metaDataStop () override
	Function called when the tool should prepare to write its metadata. More...
virtual StatusCode	beginInputFile () override
	Function called when a new input file is opened. More...
virtual StatusCode	endInputFile () override
	Function called when the currently open input file got completely processed. More...
virtual StatusCode	beginInputFile (const SG::SourceID &source) override
	Function called when a new input file is opened. More...
virtual StatusCode	endInputFile (const SG::SourceID &source) override
	Function called when the currently open input file got completely processed. 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
	DeclareInterfaceID (IMetaDataTool, 1, 0)

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	copyInputContainersToOutput (CutBookkeepersLocalCache &target, const SG::SourceID &source="")
	Copy input containers to the output. More...
StatusCode	copyCutflowFromService ()
	Fill Cutflow information from the service. More...
StatusCode	loadXAODMetaData ()
	Initialisation helpers. More...
StatusCode	loadPOOLMetaData ()
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
ServiceHandle< ICutFlowSvc >	m_cutFlowSvc { this, "CutFlowSvc", "CutFlowSvc/CutFlowSvc", "Pointer to the CutFlowSvc"}
	Pointer to the public CutFlowSvc interface. More...
CutFlowSvc *	m_cutFlowSvcPrivate {}
	Direct pointer to the CutFlowSvc for "private" methods access. More...
Gaudi::Property< std::string >	m_inputCollName
	The name of the input CutBookkeeperContainer. More...
Gaudi::Property< std::string >	m_outputCollName
	The name of the output CutBookkeeperContainer. More...
size_t	m_numberOfWeightVariations {}
	Number of event weight variations. More...
std::unordered_map< SG::SourceID, CutBookkeepersLocalCache >	m_inputContainers
	Input CutBookkeeperContainers. More...
CutBookkeepersLocalCache	m_completeContainers
	Local CutBookkeeperContainers. More...
CutBookkeepersLocalCache	m_incompleteContainers
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	beginEvent ()
	Function called when a new events is loaded. More...

Detailed Description

Definition at line 42 of file BookkeeperTool.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

BookkeeperTool()

BookkeeperTool::BookkeeperTool

(

const std::string &

name = "BookkeeperTool"

)

Declare the correct constructor for Athena.

Standard Service Constructor

Definition at line 25 of file BookkeeperTool.cxx.

  : asg::AsgMetadataTool(name)
{
#ifndef XAOD_STANDALONE
  declareInterface< ::IMetaDataTool >( this );
#endif // XAOD_STANDALONE
}

~BookkeeperTool()

virtual BookkeeperTool::~BookkeeperTool ( )

virtualdefault

Destructor.

Member Function Documentation

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() [1/2]

virtual StatusCode BookkeeperTool::beginInputFile ( )

inlineoverridevirtual

Function called when a new input file is opened.

Dummy implementation that can be overridden by the derived tool.

Reimplemented from asg::AsgMetadataTool.

Definition at line 66 of file BookkeeperTool.h.

{return StatusCode::SUCCESS;}

beginInputFile() [2/2]

StatusCode BookkeeperTool::beginInputFile ( const SG::SourceID &  sid )

overridevirtual

Function called when a new input file is opened.

Implements IMetaDataTool.

Definition at line 54 of file BookkeeperTool.cxx.

{
  // OPENING NEW INPUT FILE
  // Things to do:
  // 1) Load CutBookkeepers from input file
  //    a) if incomplete from input, directly propagate to output
  //    b) if complete from input, wait for EndInputFile to decide what to do in output
 
  // Get number of event weight variations if needed
  if (m_numberOfWeightVariations == 0) {
    ATH_MSG_DEBUG("Determining number of weight variations");
#ifndef GENERATIONBASE
    if (inputMetaStore()->contains<xAOD::TruthMetaDataContainer>("TruthMetaData")) {
      StatusCode status = loadXAODMetaData();
      if (!status.isSuccess()) {
        if (status.isRecoverable()) {
          ATH_CHECK(loadPOOLMetaData());
        } else {
          return StatusCode::FAILURE;
        }
      }
    } else {
      ATH_CHECK(loadPOOLMetaData());
    }
#else
    ATH_CHECK(loadPOOLMetaData());
#endif
 
    if (m_numberOfWeightVariations == 0) {
      ATH_MSG_ERROR("Could not determine the number of weight variations");
      return StatusCode::FAILURE;
    }
 
    ATH_MSG_INFO("Using number of event weight variations " << m_numberOfWeightVariations);
 
#ifndef XAOD_STANDALONE
    ATH_CHECK(m_cutFlowSvcPrivate->setNumberOfWeightVariations(m_numberOfWeightVariations));
#endif
  }
 
#ifdef XAOD_STANDALONE
  SG::SourceID source{"file"};
#endif
 
  // Prepare local cache
  ATH_MSG_INFO("Preparing local cache for source '" << source << "' with " << m_numberOfWeightVariations << " variations");
  CutBookkeepersLocalCache::prepareContainers(m_completeContainers, m_numberOfWeightVariations);
  CutBookkeepersLocalCache::prepareContainers(m_incompleteContainers, m_numberOfWeightVariations);
 
  // Check if a local container is there. IT SHOULD NOT BE
  auto sit = m_inputContainers.find(source);
  if (sit != m_inputContainers.end()) {
    ATH_MSG_ERROR("Undefined behaviour: this file has already been processed");
    return StatusCode::FAILURE;
  }
 
  const xAOD::CutBookkeeperContainer *inputCollection{};
  // Get the incomplete bookkeeper collections of the input metadata store
  std::string incompleteCollName = "Incomplete" + m_inputCollName;
  if (inputMetaStore()->contains<xAOD::CutBookkeeperContainer>(incompleteCollName)) {
    for (size_t i{}; i < m_numberOfWeightVariations; ++i) {
      std::string name = incompleteCollName;
      if (i != 0) {
        name.append("_weight_");
        name.append(std::to_string(i));
      }
      if (inputMetaStore()->contains<xAOD::CutBookkeeperContainer>(name)
        && inputMetaStore()->retrieve(inputCollection, name).isSuccess()) {
        xAOD::CutFlowHelpers::updateContainer(m_incompleteContainers.at(i), inputCollection);
      }
    }
    ATH_MSG_DEBUG("Successfully merged input incomplete bookkeepers with output");
  } else {
    ATH_MSG_INFO("No incomplete bookkeepers with name '" << incompleteCollName << "' in this file");
  }
 
  // Get the complete bookkeeper collections of the input metadata store
  if (inputMetaStore()->contains<xAOD::CutBookkeeperContainer>(m_inputCollName)) {
    // Create the temporary container
    auto [it, status] = m_inputContainers.emplace(source, CutBookkeepersLocalCache());
    CutBookkeepersLocalCache::prepareContainers(it->second, m_numberOfWeightVariations);
    
    for (size_t i{}; i < m_numberOfWeightVariations; ++i) {
      std::string name = m_inputCollName;
      if (i != 0) {
        name.append("_weight_");
        name.append(std::to_string(i));
      }
      if (inputMetaStore()->contains<xAOD::CutBookkeeperContainer>(name)
        && inputMetaStore()->retrieve(inputCollection, name).isSuccess()) {
        xAOD::CutFlowHelpers::updateContainer(it->second.at(i), inputCollection);
      }
    }
    ATH_MSG_DEBUG("Successfully copied complete bookkeepers to temp container");
  } else {
    ATH_MSG_INFO("No complete bookkeepers with name '" << m_inputCollName.value() << "' in this file");
  }
 
  return StatusCode::SUCCESS;
}

copyCutflowFromService()

StatusCode BookkeeperTool::copyCutflowFromService ( )

private

Fill Cutflow information from the service.

Definition at line 269 of file BookkeeperTool.cxx.

{
#ifndef XAOD_STANDALONE
  ATH_MSG_DEBUG("Copying cutflow from CutFlowSvc");
 
  // Get the bookkeeper from the current processing
  const CutBookkeepersLocalCache &cache = m_cutFlowSvcPrivate->getCutBookkeepers();
  if (!cache.empty()) {
    ATH_MSG_DEBUG("Cache size: " << cache.size());
 
    // sync the size
    CutBookkeepersLocalCache::prepareContainers(m_completeContainers, std::max(cache.size(), m_numberOfWeightVariations));
    CutBookkeepersLocalCache::prepareContainers(m_incompleteContainers, std::max(cache.size(), m_numberOfWeightVariations));
 
    for (std::size_t i = 0; i < cache.size(); ++i) {
      xAOD::CutFlowHelpers::updateContainer(m_completeContainers.at(i), cache.at(i));
    }
  } else {
    ATH_MSG_ERROR("No cutflow container in the CutFlowSvc");
    return StatusCode::FAILURE;
  }
#endif
 
  return StatusCode::SUCCESS;
}

copyInputContainersToOutput()

StatusCode BookkeeperTool::copyInputContainersToOutput ( CutBookkeepersLocalCache &  target, const SG::SourceID &  source = ""  )

private

Copy input containers to the output.

Definition at line 232 of file BookkeeperTool.cxx.

{
  CutBookkeepersLocalCache::prepareContainers(target, m_numberOfWeightVariations);
 
  if (msgLvl(MSG::DEBUG)) {
    ATH_MSG_DEBUG("Available sources:");
    for (const auto &[sourceID, list] : m_inputContainers) {
      ATH_MSG_DEBUG("  " << sourceID);
    }
  }
 
  if (!source.empty()) {
    auto it = m_inputContainers.find(source);
    if (it == m_inputContainers.end()) {
      ATH_MSG_DEBUG("No input containers for this file");
      return StatusCode::SUCCESS;
    }
 
    for (std::size_t i = 0; i < it->second.size(); ++i) {
      xAOD::CutFlowHelpers::updateContainer(target.at(i), it->second.at(i));
    }
    m_inputContainers.erase(it);
 
    return StatusCode::SUCCESS;
  }
 
  for (auto &[s, list] : m_inputContainers) {
    for (std::size_t i = 0; i < list.size(); ++i) {
      xAOD::CutFlowHelpers::updateContainer(target.at(i), list.at(i));
    }
  }
  m_inputContainers.clear();
 
  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);
  }

DeclareInterfaceID()

IMetaDataTool::DeclareInterfaceID ( IMetaDataTool  , 1  , 0    )

inherited

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.

{ return m_detStore; }

endInputFile() [1/2]

virtual StatusCode BookkeeperTool::endInputFile ( )

inlineoverridevirtual

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

Dummy implementation that can be overridden by the derived tool.

Reimplemented from asg::AsgMetadataTool.

Definition at line 67 of file BookkeeperTool.h.

{return StatusCode::SUCCESS;}

endInputFile() [2/2]

StatusCode BookkeeperTool::endInputFile ( const SG::SourceID &  sid )

overridevirtual

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

Implements IMetaDataTool.

Definition at line 159 of file BookkeeperTool.cxx.

{
#ifdef XAOD_STANDALONE
  SG::SourceID source{"file"};
#endif
  ATH_MSG_INFO("Copying input containers for source '" << source << "'");
  ATH_CHECK(copyInputContainersToOutput(m_completeContainers, source));
 
  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.

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

{ 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

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.

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 BookkeeperTool::initialize ( )

overridevirtual

Standard reimplemented functions.

Reimplemented from asg::AsgTool.

Definition at line 34 of file BookkeeperTool.cxx.

{
  ATH_MSG_DEBUG("Initializing " << name());
 
  ATH_MSG_DEBUG("InputCollName = " << m_inputCollName);
  ATH_MSG_DEBUG("OutputCollName = " << m_outputCollName);
 
#ifndef XAOD_STANDALONE
  ATH_CHECK(m_cutFlowSvc.retrieve());
  // Access "private" CutFlowSvc methods
  m_cutFlowSvcPrivate = dynamic_cast<CutFlowSvc *>(&*(m_cutFlowSvc));
#endif
 
  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
   }

loadPOOLMetaData()

StatusCode BookkeeperTool::loadPOOLMetaData ( )

private

Definition at line 363 of file BookkeeperTool.cxx.

{
  // AnalysisBase can only use the xAOD::TruthMetaDataContainer, so skip this
#ifdef XAOD_STANDALONE
  return StatusCode::SUCCESS;
#else
 
  const IOVMetaDataContainer *container
    = inputMetaStore()->tryConstRetrieve<IOVMetaDataContainer>("/Generation/Parameters");
  if (container == nullptr) {
    // set variations to 1 and exit quietly...
    m_numberOfWeightVariations = 1;
    return StatusCode::SUCCESS;
  }
  // payload is a collection of CondAttrListCollections
  // only look a the first one, assuming it exists, and within that only look at the first channel;
  if (!(container->payloadContainer()->size() > 0
        && container->payloadContainer()->at(0)->size() > 0)) {
    return StatusCode::FAILURE;
  }
 
  // we take the first collection of weights
  // TODO: improve this
  CondAttrListCollection::ChanNum chanNum{container->payloadContainer()->at(0)->chanNum(0)};
  const coral::Attribute& attr
    = container->payloadContainer()->at(0)->attributeList(chanNum)["HepMCWeightNames"];
 
  ATH_MSG_DEBUG("Attempting to load weight meta data from /Generation/Parameters");
  std::map<std::string, int> truthWeightMap;
  ATH_CHECK(Gaudi::Parsers::parse(truthWeightMap, attr.data<std::string>()));
 
  m_numberOfWeightVariations = truthWeightMap.size();
 
  return StatusCode::SUCCESS;
#endif // XAOD_STANDALONE
}

loadXAODMetaData()

StatusCode BookkeeperTool::loadXAODMetaData ( )

private

Initialisation helpers.

Definition at line 296 of file BookkeeperTool.cxx.

{
#ifdef GENERATIONBASE
  return StatusCode::RECOVERABLE;
#else
 
  // Try to load MC channel number from file metadata
  ATH_MSG_DEBUG("Attempting to retrieve MC channel number...");
  const xAOD::FileMetaData *fileMetaData{};
  uint32_t mcChannelNumber{uint32_t(-1)};
  if (inputMetaStore()->contains<xAOD::FileMetaData>("FileMetaData")) {
    ATH_CHECK(inputMetaStore()->retrieve(fileMetaData, "FileMetaData"));
    float fltChannelNumber{-1};
    if (fileMetaData->value(xAOD::FileMetaData::mcProcID, fltChannelNumber)) {
      mcChannelNumber = static_cast<uint32_t>(fltChannelNumber);
    }
  }
  if (mcChannelNumber == uint32_t(-1)) {
    ATH_MSG_WARNING("... MC channel number could not be loaded from FileMetaData");
#ifdef XAOD_STANDALONE
    mcChannelNumber = 0;
#else
    return StatusCode::RECOVERABLE;
#endif
  }
 
  // Find the correct truth meta data object
  ATH_MSG_DEBUG("Attempting to load weight meta data from xAOD TruthMetaData for channel " << mcChannelNumber);
  const xAOD::TruthMetaDataContainer *metaDataContainer{};
  ATH_CHECK(inputMetaStore()->retrieve(metaDataContainer, "TruthMetaData"));
 
  // If we only have one metadata item take MC channel from there if needed
  if (mcChannelNumber == 0 && metaDataContainer->size() == 1) {
    mcChannelNumber = metaDataContainer->at(0)->mcChannelNumber();
    ATH_MSG_WARNING("... MC channel number taken from the metadata as " << mcChannelNumber);
  }
 
  auto itTruthMetaDataPtr = std::find_if(metaDataContainer->begin(), metaDataContainer->end(),
    [mcChannelNumber] (const auto& it) { return it->mcChannelNumber() == mcChannelNumber; }
  );
 
  // If no such object is found then return
  if (itTruthMetaDataPtr == metaDataContainer->end()) {
#ifdef XAOD_STANDALONE
    m_numberOfWeightVariations = 1;
    ATH_MSG_DEBUG("Could not load weight meta data! Assuming 1 variation.");
    return StatusCode::SUCCESS;
#else
    ATH_MSG_DEBUG("Could not load weight meta data from TruthMetaData!");
    return StatusCode::RECOVERABLE;
#endif
  }
 
  // Update cached weight data
  const std::vector<std::string> &truthWeightNames = (*itTruthMetaDataPtr)->weightNames();
 
  m_numberOfWeightVariations = truthWeightNames.size();
  if (m_numberOfWeightVariations == 0) {
    ATH_MSG_DEBUG("No variations present, setting to 1.");
    m_numberOfWeightVariations = 1;
  }
 
  return StatusCode::SUCCESS;
#endif
}

metaDataStop()

StatusCode BookkeeperTool::metaDataStop ( )

overridevirtual

Function called when the tool should prepare to write its metadata.

Implements IMetaDataTool.

Definition at line 171 of file BookkeeperTool.cxx.

{
  // TERMINATING THE JOB (EndRun)
  // Things to do:
  // 1) Create new incomplete CutBookkeepers if relevant
  // 2) Copy cutflow from the service
  // 3) Copy containers to output
 
  // All files that have not been fully processed are incomplete
  ATH_CHECK(copyInputContainersToOutput(m_incompleteContainers));
 
  // Copy cutflow from the service
  ATH_CHECK(copyCutflowFromService());
 
  // Write out the containers
  for (std::size_t i = 0; i < m_completeContainers.size(); ++i) {
    std::string name = m_outputCollName;
    if (i != 0) {
      name.append("_weight_");
      name.append(std::to_string(i));
    }
    std::string incompleteName = "Incomplete" + name;
 
    // In MP we might already have them written out
    if (outputMetaStore()->contains<xAOD::CutBookkeeperContainer>(name)) {
      xAOD::CutBookkeeperContainer *complete{};
      if (!outputMetaStore()->retrieve(complete, name).isSuccess()) {
        ATH_MSG_ERROR("Could not get " << name << " CutBookkeepers from output MetaDataStore");
        return StatusCode::FAILURE;
      }
      xAOD::CutFlowHelpers::updateContainer(complete, m_completeContainers.at(i));
    } else {
      ATH_CHECK(outputMetaStore()->record(std::move(m_completeContainers.cont[i]), name));
      ATH_CHECK(outputMetaStore()->record(std::move(m_completeContainers.aux[i]), name + "Aux."));
    }
 
    if (outputMetaStore()->contains<xAOD::CutBookkeeperContainer>(incompleteName)) {    
      xAOD::CutBookkeeperContainer *incomplete{};
      if (!outputMetaStore()->retrieve(incomplete, incompleteName).isSuccess()) {
        ATH_MSG_ERROR("Could not get " << incompleteName << " CutBookkeepers from output MetaDataStore");
        return StatusCode::FAILURE;
      }
      xAOD::CutFlowHelpers::updateContainer(incomplete, m_incompleteContainers.at(i));
    } else {
      // Only write non-empty incomplete containers for variations
      if (i == 0 || !m_incompleteContainers.at(i)->empty()) {
        ATH_CHECK(outputMetaStore()->record(std::move(m_incompleteContainers.cont[i]), incompleteName));
        ATH_CHECK(outputMetaStore()->record(std::move(m_incompleteContainers.aux[i]), incompleteName + "Aux."));
      }
    }
  }
 
  m_incompleteContainers.clear();
  m_completeContainers.clear();
 
  ATH_MSG_INFO("Successfully copied CutBookkeepers to the output MetaDataStore");
 
  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()

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

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

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_completeContainers

CutBookkeepersLocalCache BookkeeperTool::m_completeContainers

private

Local CutBookkeeperContainers.

Definition at line 106 of file BookkeeperTool.h.

m_cutFlowSvc

ServiceHandle<ICutFlowSvc> BookkeeperTool::m_cutFlowSvc { this, "CutFlowSvc", "CutFlowSvc/CutFlowSvc", "Pointer to the CutFlowSvc"}

private

Pointer to the public CutFlowSvc interface.

Definition at line 86 of file BookkeeperTool.h.

m_cutFlowSvcPrivate

CutFlowSvc* BookkeeperTool::m_cutFlowSvcPrivate {}

private

Direct pointer to the CutFlowSvc for "private" methods access.

Definition at line 88 of file BookkeeperTool.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_incompleteContainers

CutBookkeepersLocalCache BookkeeperTool::m_incompleteContainers

private

Definition at line 107 of file BookkeeperTool.h.

m_inputCollName

Gaudi::Property<std::string> BookkeeperTool::m_inputCollName

private

Initial value:

{this, "InputCollName", "CutBookkeepers",
    "The default name of the xAOD::CutBookkeeperContainer for input files"}

The name of the input CutBookkeeperContainer.

Definition at line 92 of file BookkeeperTool.h.

m_inputContainers

std::unordered_map<SG::SourceID, CutBookkeepersLocalCache> BookkeeperTool::m_inputContainers

private

Input CutBookkeeperContainers.

Definition at line 103 of file BookkeeperTool.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_numberOfWeightVariations

size_t BookkeeperTool::m_numberOfWeightVariations {}

private

Number of event weight variations.

Definition at line 100 of file BookkeeperTool.h.

m_outputCollName

Gaudi::Property<std::string> BookkeeperTool::m_outputCollName

private

Initial value:

{this, "OutputCollName", "CutBookkeepers",
    "The default name of the xAOD::CutBookkeeperContainer for output files"}

The name of the output CutBookkeeperContainer.

Definition at line 96 of file BookkeeperTool.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_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:

• BookkeeperTool.h
• BookkeeperTool.cxx