CP::AsgCutBookkeeperAlg Class Reference

an algorithm for dumping the CutBookkeeper metadata into a histogram More...

#include <AsgCutBookkeeperAlg.h>

Inheritance diagram for CP::AsgCutBookkeeperAlg:

Collaboration diagram for CP::AsgCutBookkeeperAlg:

Classes
struct	WeightsGroup
	weights helper struct More...

Public Types
typedef ServiceHandle< StoreGateSvc > &	MetaStorePtr_t
	Type of the metadata store pointer in standalone mode.
typedef const ServiceHandle< StoreGateSvc > &	ConstMetaStorePtr_t
typedef ServiceHandle< StoreGateSvc >	MetaStore_t
	Type of the metadata store variable in Athena.

Public Member Functions
StatusCode	initialize () override
	initialize
StatusCode	fileExecute () override
	run once on each file
StatusCode	finalize () override
	finalize
	AnaAlgorithm (const std::string &name, ISvcLocator *pSvcLocator)
	the standard constructor
::StatusCode	requestFileExecute ()
	register this algorithm to have an implementation of fileexecute
::StatusCode	requestBeginInputFile ()
	register this algorithm to have an implementation of beginInputFile
::StatusCode	requestEndInputFile ()
	register this algorithm to have an implementation of endInputFile
void	handle (const Incident &inc)
	receive the given incident
virtual StatusCode	sysInitialize ()
	Initialization method invoked by the framework.
const ServiceHandle< ITHistSvc > &	histSvc () const
	The standard THistSvc (for writing histograms and TTrees and more to a root file) Returns (kind of) a pointer to the THistSvc.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
ConstMetaStorePtr_t	inputMetaStore () const
MetaStorePtr_t	inputMetaStore ()
ConstMetaStorePtr_t	outputMetaStore () const
MetaStorePtr_t	outputMetaStore ()

Protected Member Functions
virtual::StatusCode	execute ()
	execute this algorithm
virtual void	print () const
	print the state of the algorithm
virtual::StatusCode	beginInputFile ()
	perform the action for the beginning of an input file
virtual::StatusCode	endInputFile ()
	perform the action for the end of an input file
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.
StatusCode	configAthHistogramming (const ServiceHandle< ITHistSvc > &histSvc, const std::string &prefix, const std::string &rootDir, const std::string &histNamePrefix, const std::string &histNamePostfix, const std::string &histTitlePrefix, const std::string &histTitlePostfix)
	To be called by the derived classes to fill the internal configuration.
TH1 *	bookGetPointer (const TH1 &hist, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
TH1 *	bookGetPointer (TH1 *hist, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
TH1 *	bookGetPointer (TH1 &histRef, std::string tDir="", std::string stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
TTree *	bookGetPointer (const TTree &treeRef, std::string tDir="", std::string stream="")
	Simplify the booking and registering (into THistSvc) of TTrees.
TGraph *	bookGetPointer (const TGraph &graphRef, std::string tDir="", std::string stream="")
	Simplify the booking and registering (into THistSvc) of TGraphs.
TEfficiency *	bookGetPointer (const TEfficiency &eff, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
TEfficiency *	bookGetPointer (TEfficiency *eff, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
TEfficiency *	bookGetPointer (TEfficiency &effRef, std::string tDir="", std::string stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
StatusCode	book (const TH1 &hist, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
StatusCode	book (TH1 *hist, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
StatusCode	book (TH1 &histRef, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
StatusCode	book (const TTree &treeRef, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of TTrees.
StatusCode	book (const TGraph &graphRef, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of TGraphs.
StatusCode	book (const TEfficiency &eff, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
StatusCode	book (TEfficiency *eff, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
StatusCode	book (TEfficiency &effRef, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
TH1 *	hist (const std::string &histName, const std::string &tDir="", const std::string &stream="")
	Simplify the retrieval of registered histograms of any type.
TH2 *	hist2d (const std::string &histName, const std::string &tDir="", const std::string &stream="")
	Simplify the retrieval of registered 2-d histograms.
TH3 *	hist3d (const std::string &histName, const std::string &tDir="", const std::string &stream="")
	Simplify the retrieval of registered 3-d histograms.
TTree *	tree (const std::string &treeName, const std::string &tDir="", const std::string &stream="")
	Simplify the retrieval of registered TTrees.
TGraph *	graph (const std::string &graphName, const std::string &tDir="", const std::string &stream="")
	Simplify the retrieval of registered TGraphs.
TEfficiency *	efficiency (const std::string &effName, const std::string &tDir="", const std::string &stream="")
	Simplify the retrieval of registered TEfficiency.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t
typedef uint32_t	hash_t
	typedef for the internal hash
typedef std::map< const hash_t, TH1 * >	HistMap_t
	Typedef for convenience.
typedef std::map< const hash_t, TEfficiency * >	EffMap_t
	Typedef for convenience.
typedef std::map< const hash_t, TTree * >	TreeMap_t
	Typedef for convenience.
typedef std::map< const hash_t, TGraph * >	GraphMap_t
	Typedef for convenience.

Private Member Functions
void	processCutBookkeeper (const xAOD::CutBookkeeper *cbk, size_t index)
	process a CutBookkeeper
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>
void	buildBookingString (std::string &bookingString, std::string &histName, std::string &tDir, std::string &stream, bool usePrefixPostfix=false)
	Method to build individual booking string.
void	myReplace (std::string &str, const std::string &oldStr, const std::string &newStr)
	Helper method to replace sub-string.
hash_t	hash (const std::string &histName) const
	Method to calculate a 32-bit hash from a string.

Private Attributes
Gaudi::Property< bool >	m_enableSystematics {this, "enableSystematics", false, "enable systematics"}
	flag to enable systematics
ToolHandle< PMGTools::IPMGTruthWeightTool >	m_truthWeightTool {this, "truthWeightTool", "PMGTools::PMGTruthWeightTool", "the truth weight tool"}
	the truth weight tool
ServiceHandle< ISystematicsSvc >	m_systematics {this, "systematics", "SystematicsSvc", "systematics service"}
	the systematics service
Gaudi::Property< uint32_t >	m_runNumber {this, "runNumber", 0, "the run number we are processing"}
	run number we are processing
uint32_t	m_mcChannelNumber {}
	MC channel number we are processing.
std::vector< std::string >	m_allowed_streams {"StreamAOD", "StreamEVGEN", "StreamEVNT"}
	input streams that we can run the CutBookkeepers against
std::unordered_map< size_t, WeightsGroup >	m_weights
	weights map
Gaudi::Property< std::string >	m_histPattern {this, "histPattern", "CutBookkeeper_%DSID%_%RUN%_%SYS%", "the pattern for histogram names"}
	the pattern for histogram names
MetaStore_t	m_inputMetaStore
	Object accessing the input metadata store.
MetaStore_t	m_outputMetaStore
	Object accessing the output metadata store.
bool	m_hasFileExecute {false}
	the value of hasFileExecute
bool	m_hasBeginInputFile {false}
	the value of hasBeginInputFile
bool	m_hasEndInputFile {false}
	the value of hasEndInputFile
ServiceHandle< ITHistSvc >	m_histSvc
	Default constructor: AthHistogramAlgorithm();.
std::string	m_prefix
	Name of the ROOT output stream (file)
std::string	m_rootDir
	Name of the ROOT directory.
std::string	m_histNamePrefix
	The prefix for the histogram THx name.
std::string	m_histNamePostfix
	The postfix for the histogram THx name.
std::string	m_histTitlePrefix
	The prefix for the histogram THx title.
std::string	m_histTitlePostfix
	The postfix for the histogram THx title.
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared
HistMap_t	m_histMap
	The map of histogram names to their pointers.
EffMap_t	m_effMap
	The map of histogram names to their pointers.
TreeMap_t	m_treeMap
	The map of TTree names to their pointers.
GraphMap_t	m_graphMap
	The map of TGraph names to their pointers.
std::string	m_streamName
	Name of the ROOT output stream (file)
std::string	m_name
	Instance name.
MsgStream	m_msg
	Cached Message Stream.

Detailed Description

an algorithm for dumping the CutBookkeeper metadata into a histogram

Definition at line 24 of file AsgCutBookkeeperAlg.h.

Member Typedef Documentation

ConstMetaStorePtr_t

typedef const ServiceHandle< StoreGateSvc >& EL::AnaAlgorithm::ConstMetaStorePtr_t

inherited

Definition at line 111 of file AnaAlgorithm.h.

EffMap_t

typedef std::map< const hash_t, TEfficiency* > AthHistogramming::EffMap_t

privateinherited

Typedef for convenience.

Definition at line 205 of file AthHistogramming.h.

GraphMap_t

typedef std::map< const hash_t, TGraph* > AthHistogramming::GraphMap_t

privateinherited

Typedef for convenience.

Definition at line 219 of file AthHistogramming.h.

hash_t

typedef uint32_t AthHistogramming::hash_t

privateinherited

typedef for the internal hash

Definition at line 169 of file AthHistogramming.h.

HistMap_t

typedef std::map< const hash_t, TH1* > AthHistogramming::HistMap_t

privateinherited

Typedef for convenience.

Definition at line 198 of file AthHistogramming.h.

MetaStore_t

typedef ServiceHandle< StoreGateSvc > EL::AnaAlgorithm::MetaStore_t

inherited

Type of the metadata store variable in Athena.

Definition at line 546 of file AnaAlgorithm.h.

MetaStorePtr_t

typedef ServiceHandle< StoreGateSvc >& EL::AnaAlgorithm::MetaStorePtr_t

inherited

Type of the metadata store pointer in standalone mode.

Definition at line 110 of file AnaAlgorithm.h.

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

TreeMap_t

typedef std::map< const hash_t, TTree* > AthHistogramming::TreeMap_t

privateinherited

Typedef for convenience.

Definition at line 212 of file AthHistogramming.h.

Member Function Documentation

AnaAlgorithm()

EL::AnaAlgorithm::AnaAlgorithm	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

the standard constructor

Definition at line 89 of file AnaAlgorithm.cxx.

    : AsgComponent (name)
    , m_inputMetaStore  (asg::SgTEventMeta::InputStore, nullptr)
    , m_outputMetaStore (asg::SgTEventMeta::OutputStore, nullptr)
#else
    : AthHistogramAlgorithm (name, pSvcLocator)
    , m_inputMetaStore  ("StoreGateSvc/InputMetaDataStore", name)
    , m_outputMetaStore ("StoreGateSvc/MetaDataStore", name)
#endif
  {
#ifdef XAOD_STANDALONE
    declareProperty ("RootStreamName", m_treeStreamName = "ANALYSIS",
                     "Name of the stream to put trees into");
#endif
 
    ANA_MSG_DEBUG ("AnaAlgorithm: " << name);
  }

beginInputFile()

StatusCode EL::AnaAlgorithm::beginInputFile ( )

protectedinherited

perform the action for the beginning of an input file

Ideally you don't use this, but instead rely on meta-data tools instead. However, there are enough people asking for it that I decided to implement it anyways.

\warn To use this you have to call requestBeginInputFile to use this.

\warn If a file is split across multiple jobs this will be called more than once. This only happens for specific batch drivers and/or if it is explicitly configured by the user. With PROOF it could even happen multiple times within the same job, and while PROOF is no longer supported that behavior may come back if support for a similar framework is added in the future. As such, this method should not be used for accounting that relies to be called exactly once per file, take a look at fileExecute if you want something that is guaranteed to be executed exactly once per input file.

\warn The execution order of beginInputFile and fileExecute is currently unspecified.

Definition at line 350 of file AnaAlgorithm.cxx.

  {
    return StatusCode::SUCCESS;
  }

book() [1/8]

StatusCode AthHistogramming::book ( const TEfficiency & eff, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 335 of file AthHistogramming.h.

{
  // We need to create a non-const clone
  TEfficiency* effClone = dynamic_cast< TEfficiency* >( eff.Clone() );
  if ( !effClone ) {
    m_msg << MSG::ERROR << "Couldn't create a TEfficiency clone" << endmsg;
    return StatusCode::FAILURE;
  }
  return this->book( *effClone, tDir, stream );
}

book() [2/8]

StatusCode AthHistogramming::book ( const TGraph & graphRef, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TGraphs.

book() [3/8]

StatusCode AthHistogramming::book ( const TH1 & hist, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 303 of file AthHistogramming.h.

{
  // We need to create a non-const clone
  TH1* histClone = dynamic_cast< TH1* >( hist.Clone() );
  if ( !histClone ) {
    m_msg << MSG::ERROR << "Couldn't create a TH1 clone" << endmsg;
    return StatusCode::FAILURE;
  }
  return this->book( *histClone, tDir, stream );
}

book() [4/8]

StatusCode AthHistogramming::book ( const TTree & treeRef, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TTrees.

Definition at line 403 of file AthHistogramming.h.

{
  // Call the other Book method and see if it returns a valid pointer
  TTree* treePointer = this->bookGetPointer( treeRef, tDir, stream );
  if ( treePointer )
    {
      return StatusCode::SUCCESS;
    }
  else
    {
      return StatusCode::FAILURE;
    }
}

book() [5/8]

StatusCode AthHistogramming::book ( TEfficiency & effRef, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 356 of file AthHistogramming.h.

{
  // Call the other Book method and see if it returns a valid pointer
  TEfficiency* effPointer = this->bookGetPointer( effRef, tDir, stream );
  if ( !effPointer ) {
    m_msg << MSG::ERROR << "Couldn't book a TEfficiency" << endmsg;
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

book() [6/8]

StatusCode AthHistogramming::book ( TEfficiency * eff, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 346 of file AthHistogramming.h.

{
  if ( !eff ) {
    m_msg << MSG::ERROR << "Got a zero pointer to a TEfficiency" << endmsg;
    return StatusCode::FAILURE;
  }
  return this->book( *eff, tDir, stream );
}

book() [7/8]

StatusCode AthHistogramming::book ( TH1 & histRef, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 324 of file AthHistogramming.h.

{
  // Call the other Book method and see if it returns a valid pointer
  TH1* histPointer = this->bookGetPointer( histRef, tDir, stream );
  if ( !histPointer ) {
    m_msg << MSG::ERROR << "Couldn't book a TH1" << endmsg;
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

book() [8/8]

StatusCode AthHistogramming::book ( TH1 * hist, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 314 of file AthHistogramming.h.

{
  if ( !hist ) {
    m_msg << MSG::ERROR << "Got a zero pointer to a TH1" << endmsg;
    return StatusCode::FAILURE;
  }
  return this->book( *hist, tDir, stream );
}

bookGetPointer() [1/8]

TEfficiency * AthHistogramming::bookGetPointer ( const TEfficiency & eff, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 281 of file AthHistogramming.h.

{
  // We need to create a non-const clone
  TEfficiency* histClone = dynamic_cast< TEfficiency* >( hist.Clone() );
  if ( !histClone ) {
    m_msg << MSG::ERROR << "Couldn't create a TEfficiency clone in bookGetPointer" << endmsg;
    return 0;
  }
  return this->bookGetPointer( *histClone, tDir, stream );
 
}

bookGetPointer() [2/8]

TGraph * AthHistogramming::bookGetPointer ( const TGraph & graphRef, std::string tDir = "", std::string stream = "" )

protectedinherited

Simplify the booking and registering (into THistSvc) of TGraphs.

Definition at line 427 of file AthHistogramming.cxx.

{
  // Get a pointer
  const TGraph* graphPointer = &graphRef;
 
  // Check that we got a valid pointer
  if ( !graphPointer )
    {
      m_msg << MSG::WARNING
            << "We got an invalid TGraph pointer in the BookGetPointer(TGraph*) method of the class" << m_name
            << "!" << endmsg;
      return NULL;
    }
 
  // Modify the name and title according to the prefixes of this classes instance
  std::string graphName  = graphPointer->GetName();
  const std::string graphTitle = graphPointer->GetTitle();
 
  // Check if the hash for this graphName already exists, i.e., if we have a hash collision
  const hash_t graphHash = this->hash(graphName);
  GraphMap_t::const_iterator it = m_graphMap.find( graphHash );
  if ( it != m_graphMap.end() ) // It does exist!
    {
      m_msg << MSG::WARNING
            << "Detected a hash collision. The hash for the TGraph with name=" << graphName
            << " already exists and points to a TGraph with name=" << it->second->GetName()
            << " NOT going to book the new histogram and returning a NULL pointer!" << endmsg;
      return NULL;
    }
 
  // Create a clone that has the new name
  TGraph* graphClone = dynamic_cast< TGraph* >( graphPointer->Clone((m_histNamePrefix+graphName+m_histNamePostfix).c_str()) );
  if( !graphClone )
    {
      m_msg << MSG::WARNING
            << "We couldn't clone the TGraph in the BookGetPointer(TGraph&) method of the class" << m_name
            << "!" << endmsg;
      return NULL;
    }
  graphClone->SetTitle ((m_histTitlePrefix+graphTitle+m_histTitlePostfix).c_str());
 
  // Massage the final string to book things
  std::string bookingString("");
  this->buildBookingString( bookingString, graphName, tDir, stream );
 
  // Register the TGraph into the THistSvc
  if ( !((histSvc()->regGraph(bookingString, graphClone)).isSuccess()) )
    {
      m_msg << MSG::WARNING
            << "Problem registering TGraph with name " << graphName
            << ", title " << graphTitle
            << " in " << m_name << "!" << endmsg;
      return NULL;
    }
 
  // Also register it in the local map of string to pointer
  m_graphMap.insert( m_graphMap.end(), std::pair< const hash_t, TGraph* >( graphHash, graphClone ) );
 
  return graphClone;
}

bookGetPointer() [3/8]

TH1 * AthHistogramming::bookGetPointer ( const TH1 & hist, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 260 of file AthHistogramming.h.

{
  // We need to create a non-const clone
  TH1* histClone = dynamic_cast< TH1* >( hist.Clone() );
  if ( !histClone ) {
    m_msg << MSG::ERROR << "Couldn't create a TH1 clone in bookGetPointer" << endmsg;
    return 0;
  }
  return this->bookGetPointer( *histClone, tDir, stream );
 
}

bookGetPointer() [4/8]

TTree * AthHistogramming::bookGetPointer ( const TTree & treeRef, std::string tDir = "", std::string stream = "" )

protectedinherited

Simplify the booking and registering (into THistSvc) of TTrees.

Definition at line 312 of file AthHistogramming.cxx.

{
  // Get a pointer
  const TTree* treePointer = &treeRef;
 
  // Check that we got a valid pointer
  if ( !treePointer )
    {
      m_msg << MSG::WARNING
            << "We got an invalid TTree pointer in the BookGetPointer(TTree*) method of the class" << m_name
            << "!" << endmsg;
      return NULL;
    }
 
  // Modify the name and title according to the prefixes of this classes instance
  std::string treeName  = treePointer->GetName();
  const std::string treeTitle = treePointer->GetTitle();
 
  // Check if the hash for this treeName already exists, i.e., if we have a hash collision
  const hash_t treeHash = this->hash(treeName);
  TreeMap_t::const_iterator it = m_treeMap.find( treeHash );
  if ( it != m_treeMap.end() ) // It does exist!
    {
      m_msg << MSG::WARNING
            << "Detected a hash collision. The hash for the TTree with name=" << treeName
            << " already exists and points to a TTree with name=" << it->second->GetName()
            << " NOT going to book the new histogram and returning a NULL pointer!" << endmsg;
      return NULL;
    }
 
  // Create a clone that has the new name
  TTree* treeClone = dynamic_cast< TTree* >( treePointer->Clone(treeName.c_str()) );
  if( !treeClone )
    {
      m_msg << MSG::WARNING
            << "We couldn't clone the TTree in the BookGetPointer(TTree&) method of the class" << m_name
            << "!" << endmsg;
      return NULL;
    }
  treeClone->SetTitle (treeTitle.c_str());
 
  // Massage the final string to book things
  std::string bookingString("");
  this->buildBookingString( bookingString, treeName, tDir, stream );
 
  // Register the TTree into the THistSvc
  if ( !((histSvc()->regTree(bookingString, treeClone)).isSuccess()) )
    {
      m_msg << MSG::WARNING
            << "Problem registering TTree with name " << treeName
            << ", title " << treeTitle
            << " in " << m_name << "!" << endmsg;
      return NULL;
    }
 
  // Also register it in the local map of string to pointer
  m_treeMap.insert( m_treeMap.end(), std::pair< const hash_t, TTree* >( treeHash, treeClone ) );
 
  return treeClone;
}

bookGetPointer() [5/8]

TEfficiency * AthHistogramming::bookGetPointer ( TEfficiency & effRef, std::string tDir = "", std::string stream = "" )

protectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 146 of file AthHistogramming.cxx.

{
  // Modify the name and title according to the prefixes of this classes instance
  std::string effName(effRef.GetName());
  const std::string effTitle(effRef.GetTitle());
  std::string bookingString("");
 
  this->buildBookingString( bookingString, effName, tDir, stream );
  effRef.SetTitle((m_histTitlePrefix+effTitle+m_histTitlePostfix).c_str() );
  effRef.SetName(effName.c_str());
 
  // Check if the hash for this effName already exists, i.e., if we have a hash collision
  const hash_t effHash = this->hash(effName);
  EffMap_t::const_iterator it = m_effMap.find( effHash );
  if ( it != m_effMap.end() ) // It does exist!
    {
      m_msg << MSG::WARNING
            << "Detected a hash collision. The hash for the TEfficiency with name=" << effName
            << " already exists and points to a TEfficiency with name=" << it->second->GetName()
            << " NOT going to book the new TEfficiency and returning a NULL pointer!" << endmsg;
      return NULL;
    }
 
  // Set the new name and title for the TEfficiency, based on the prefixes that the user set for this class instance
  // Create a clone that has the new name
 
  // Massage the final string to book things
 
  // Register the TEfficiency into the THistSvc
  if ( !((histSvc()->regEfficiency(bookingString, &effRef)).isSuccess()) )
    {
      m_msg << MSG::WARNING
            << "Problem registering TEfficiency with name " << effName
            << ", name prefix " << m_histNamePrefix
            << ", title " << effTitle
            << ", tile prefix " << m_histTitlePrefix
            << ", and tile postfix " << m_histTitlePostfix
            << " in " << m_name << "!" << endmsg;
      return NULL;
    }
 
  // Also register it in the local map of string to pointer
  m_effMap.insert( m_effMap.end(), std::pair< const hash_t, TEfficiency* >( effHash, &effRef ) );
 
  return &effRef;
}

bookGetPointer() [6/8]

TEfficiency * AthHistogramming::bookGetPointer ( TEfficiency * eff, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 293 of file AthHistogramming.h.

{
  if ( !hist ) {
    m_msg << MSG::ERROR << "Got a zero pointer to a TEfficiency in bookGetPointer" << endmsg;
    return 0;
  }
  return this->bookGetPointer( *hist, tDir, stream );
}

bookGetPointer() [7/8]

TH1 * AthHistogramming::bookGetPointer ( TH1 & histRef, std::string tDir = "", std::string stream = "" )

protectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 98 of file AthHistogramming.cxx.

{
  // Modify the name and title according to the prefixes of this classes instance
  std::string histName(histRef.GetName());
  const std::string histTitle(histRef.GetTitle());
  std::string bookingString("");
 
  this->buildBookingString( bookingString, histName, tDir, stream );
  histRef.SetTitle((m_histTitlePrefix+histTitle+m_histTitlePostfix).c_str() );
  histRef.SetName(histName.c_str());
 
  // Check if the hash for this histName already exists, i.e., if we have a hash collision
  const hash_t histHash = this->hash(histName);
  HistMap_t::const_iterator it = m_histMap.find( histHash );
  if ( it != m_histMap.end() ) // It does exist!
    {
      m_msg << MSG::WARNING
            << "Detected a hash collision. The hash for the histogram with name=" << histName
            << " already exists and points to a histogram with name=" << it->second->GetName()
            << " NOT going to book the new histogram and returning a NULL pointer!" << endmsg;
      return NULL;
    }
 
  // Set the new name and title for the histogram, based on the prefixes that the user set for this class instance
  // Create a clone that has the new name
 
  // Massage the final string to book things
 
  // Register the histogram into the THistSvc
  if ( !((histSvc()->regHist(bookingString, &histRef)).isSuccess()) )
    {
      m_msg << MSG::WARNING
            << "Problem registering histogram with name " << histName
            << ", name prefix " << m_histNamePrefix
            << ", title " << histTitle
            << ", tile prefix " << m_histTitlePrefix
            << ", and tile postfix " << m_histTitlePostfix
            << " in " << m_name << "!" << endmsg;
      return NULL;
    }
 
  // Also register it in the local map of string to pointer
  m_histMap.insert( m_histMap.end(), std::pair< const hash_t, TH1* >( histHash, &histRef ) );
 
  return &histRef;
}

bookGetPointer() [8/8]

TH1 * AthHistogramming::bookGetPointer ( TH1 * hist, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 272 of file AthHistogramming.h.

{
  if ( !hist ) {
    m_msg << MSG::ERROR << "Got a zero pointer to a TH1 in bookGetPointer" << endmsg;
    return 0;
  }
  return this->bookGetPointer( *hist, tDir, stream );
}

buildBookingString()

void AthHistogramming::buildBookingString ( std::string & bookingString, std::string & histName, std::string & tDir, std::string & stream, bool usePrefixPostfix = false )

privateinherited

Method to build individual booking string.

Definition at line 560 of file AthHistogramming.cxx.

{
  // Massage the final string to book things
  if(tDir.empty()) tDir = m_rootDir;
  size_t pos = histName.rfind('/');
  if(pos != std::string::npos){
    tDir+='/';
    tDir.append(histName, 0,pos);
    histName.erase(0,pos+1);
  };
  if(stream.empty()) stream = m_streamName;
 
  if(usePrefixPostfix){
    bookingString = "/"+stream+"/"+tDir+"/"+m_histNamePrefix+histName+m_histNamePostfix;
  } else {
    bookingString = "/"+stream+"/"+tDir+"/"+histName;
  }
  while(bookingString.find("//") != std::string::npos){
    this->myReplace(bookingString,"//","/");
  }
 
  return;
}

configAthHistogramming()

StatusCode AthHistogramming::configAthHistogramming ( const ServiceHandle< ITHistSvc > & histSvc, const std::string & prefix, const std::string & rootDir, const std::string & histNamePrefix, const std::string & histNamePostfix, const std::string & histTitlePrefix, const std::string & histTitlePostfix )

protectedinherited

To be called by the derived classes to fill the internal configuration.

Definition at line 66 of file AthHistogramming.cxx.

{
  m_histSvc          = histSvc;
  m_streamName       = prefix;
  m_rootDir          = rootDir;
  m_histNamePrefix   = histNamePrefix;
  m_histNamePostfix  = histNamePostfix;
  m_histTitlePrefix  = histTitlePrefix;
  m_histTitlePostfix = histTitlePostfix;
 
  return StatusCode::SUCCESS;
}

declareGaudiProperty()

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

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

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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; }

efficiency()

TEfficiency * AthHistogramming::efficiency ( const std::string & effName, const std::string & tDir = "", const std::string & stream = "" )

protectedinherited

Simplify the retrieval of registered TEfficiency.

Definition at line 250 of file AthHistogramming.cxx.

{
  // Build a 32 bit hash out of the name
  const hash_t effHash = this->hash(effName);
 
  // See if this entry exists in the map
  EffMap_t::const_iterator it = m_effMap.find( effHash );
  if ( it == m_effMap.end() ) // It doesn't exist!
    { // Let's see into the THistSvc if somebody else has registered the TEfficiency...
 
      // Need to copy the strings as we will massage them from here on
      std::string effNameCopy = effName;
      std::string tDirCopy     = tDir;
      std::string streamCopy   = stream;
 
      // Massage the final string to book things
      std::string bookingString("");
      this->buildBookingString( bookingString, effNameCopy, tDirCopy, streamCopy ,false);
 
      TEfficiency* effPointer(NULL);
      if ( !((histSvc()->getEfficiency(bookingString, effPointer)).isSuccess()) )
        {
          // Massage the final string to book things
          std::string bookingString("");
          this->buildBookingString( bookingString, effNameCopy, tDirCopy, streamCopy, true );
 
          if ( !((histSvc()->getEfficiency(bookingString, effPointer)).isSuccess()) )
            {
              m_msg << MSG::WARNING
                    << "Problem retrieving the TEfficiency with name (including pre- and post-fixes) "
                    << m_histNamePrefix + effNameCopy + m_histNamePostfix
                    << " or with name " << effNameCopy
                    << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
                    << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
              return NULL;
            }
          // If we get to here, we actually found the TEfficiency in the THistSvc.
          // So let's add it to the local cache map and return its pointer
          m_effMap.insert( m_effMap.end(), std::pair< const hash_t, TEfficiency* >( effHash, effPointer ) );
          return effPointer;
        }
      // If we get to here, we actually found the TEfficiency in the THistSvc.
      // So let's add it to the local cache map and return its pointer
      m_effMap.insert( m_effMap.end(), std::pair< const hash_t, TEfficiency* >( effHash, effPointer ) );
      return effPointer;
    }
 
  // Return the pointer to the TEfficiency that we got from the local cache map
  return it->second;
}

endInputFile()

StatusCode EL::AnaAlgorithm::endInputFile ( )

protectedinherited

perform the action for the end of an input file

Ideally you don't use this, but instead rely on meta-data tools instead. However, there are enough people asking for it that I decided to implement it anyways.

\warn To use this you have to call requestEndInputFile to use this.

\warn If a file is split across multiple jobs this will be called more than once. This only happens for specific batch drivers and/or if it is explicitly configured by the user. With PROOF it could even happen multiple times within the same job, and while PROOF is no longer supported that behavior may come back if support for a similar framework is added in the future. As such, this method should not be used for accounting that relies to be called exactly once per file, take a look at fileExecute if you want something that is guaranteed to be executed exactly once per input file.

\warn The execution order of endInputFile and fileExecute is currently unspecified.

Definition at line 358 of file AnaAlgorithm.cxx.

  {
    return StatusCode::SUCCESS;
  }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::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; }

execute()

StatusCode EL::AnaAlgorithm::execute ( )

protectedinherited

execute this algorithm

This gets called once on every event and is where the bulk of the processing ought to be happening.

Definition at line 320 of file AnaAlgorithm.cxx.

  {
    return StatusCode::SUCCESS;
  }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::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

extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

fileExecute()

StatusCode CP::AsgCutBookkeeperAlg::fileExecute ( )

override

run once on each file

Definition at line 80 of file AsgCutBookkeeperAlg.cxx.

  {
    ANA_MSG_DEBUG ("Updating CutBookkeeper information");
 
    // Update MC channel number if needed
    if (m_mcChannelNumber == 0)
    {
      const xAOD::FileMetaData *fmd{};
      ANA_CHECK (inputMetaStore()->retrieve(fmd, "FileMetaData"));
 
      float flt_channel_number{};
      if (fmd->value(xAOD::FileMetaData::mcProcID, flt_channel_number)) {
        m_mcChannelNumber = static_cast<uint32_t>(flt_channel_number);
      }
    }
 
    // Retrieve complete CutBookkeeperContainer
    const xAOD::CutBookkeeperContainer *completeCBC{};
    ANA_CHECK (inputMetaStore()->retrieve(completeCBC, "CutBookkeepers"));
 
    // Find the max cycle
    int maxCycle{-1};
    const xAOD::CutBookkeeper *allEvents{};
    for (const xAOD::CutBookkeeper *cbk : *completeCBC)
    {
      ANA_MSG_DEBUG ("Complete cbk name: " << cbk->name() << " - stream: " << cbk->inputStream());
 
      if (cbk->cycle() > maxCycle && cbk->name() == "AllExecutedEvents" 
      && std::find(m_allowed_streams.begin(), m_allowed_streams.end(), cbk->inputStream()) != m_allowed_streams.end())
      {
        allEvents = cbk;
        maxCycle = cbk->cycle();
      }
    }
 
    if (allEvents == nullptr)
    {
      ANA_MSG_ERROR ("Could not find AllExecutedEvents CutBookkeeper information.");
      return StatusCode::FAILURE;
    }
 
    size_t counter{};
    for (const xAOD::CutBookkeeper *cbk : *completeCBC)
    {
      if (cbk->cycle() == maxCycle && cbk->name().find("AllExecutedEvents") == 0 
      && std::find(m_allowed_streams.begin(), m_allowed_streams.end(), cbk->inputStream()) != m_allowed_streams.end())
      {
        static const std::regex re ("AllExecutedEvents.*_([0-9]+)");
        // Get the CBK index
        size_t index{0};
        std::smatch match;
        if (std::regex_match(cbk->name(), match, re))
        {
          index = std::stoi(match[1]);
        }
 
        processCutBookkeeper(cbk, index);
 
        counter++;
      }
    }
 
    // now try systematics-aware containers
    for (size_t index{1}; index < m_truthWeightTool->getWeightNames().size(); ++index)
    {
      std::string cbkName = "CutBookkeepers_weight_" + std::to_string(index);
      if (!inputMetaStore()->contains<xAOD::CutBookkeeperContainer>(cbkName))
      {
        ANA_MSG_VERBOSE ("No container named " << cbkName << "available");
        continue;
      }
 
      ANA_CHECK (inputMetaStore()->retrieve(completeCBC, cbkName));
      for (const xAOD::CutBookkeeper *cbk : *completeCBC)
      {
        if (cbk->cycle() == maxCycle && cbk->name().find("AllExecutedEvents") == 0 
        && std::find(m_allowed_streams.begin(), m_allowed_streams.end(), cbk->inputStream()) != m_allowed_streams.end())
        {
          processCutBookkeeper(cbk, index);
          counter++;
        }
      }
    }
 
    // check if we actually had systematics available
    if (counter == 1 && m_enableSystematics) {
      ANA_MSG_WARNING ("This sample does not support CutBookkeeper systematics. Disabling...");
      m_enableSystematics = false;
    }
 
    ANA_CHECK (m_systematics.retrieve());
 
    return StatusCode::SUCCESS;
  }

finalize()

StatusCode CP::AsgCutBookkeeperAlg::finalize ( )

override

finalize

Definition at line 200 of file AsgCutBookkeeperAlg.cxx.

  {
    // Temporarily handle systematics directly here
    std::vector<CP::SystematicSet> systematics;
    systematics.emplace_back();
    if (m_enableSystematics)
    {
      for (const CP::SystematicVariation &variation : m_truthWeightTool->affectingSystematics())
      {
        systematics.emplace_back(CP::SystematicSet({variation}));
      }
    }
 
    for (const CP::SystematicSet &sys : systematics)
    {
      std::string name = RCU::substitute(m_histPattern, "%DSID%", std::to_string(m_mcChannelNumber));
      name = RCU::substitute(name, "%RUN%", std::to_string(m_runNumber));
      ANA_CHECK (m_systematics->makeSystematicsName (name, name, sys));
 
      ANA_CHECK (book(TH1F(name.c_str(), "CutBookkeeper Information", 3, 0.5, 3.5)));
      TH1 *h = hist(name);
      assert(h != nullptr);
 
      h->GetXaxis()->SetBinLabel (1, "Initial events");
      h->GetXaxis()->SetBinLabel (2, "Initial sum of weights");
      h->GetXaxis()->SetBinLabel (3, "Initial sum of weights squared");
 
      ANA_MSG_INFO ("CutBookkeeper information will be stored in " << name);
 
      ANA_MSG_VERBOSE ("Running systematics " << sys.name() << " with index " << m_truthWeightTool->getSysWeightIndex(sys));
 
      // If first event is skipped, fileExecute() is not ran, and the m_weights will be empty. 
      // Ideally we should check eventRange.m_beginEvent in the if statement, and return statusCode::Failure if eventRange.m_beginEvent is 0.
      if (m_weights.empty()) {
        ANA_MSG_ERROR ("No weight is available for CutBookkeeper histogram. \nDid you set skip-n-events > 0? This is a known issue in EventLoop.");
        break;
      }
 
      const WeightsGroup &weights = m_weights.at (m_truthWeightTool->getSysWeightIndex(sys));
      h->SetBinContent (1, weights.nEventsProcessed);
      h->SetBinContent (2, weights.sumOfWeights);
      h->SetBinContent (3, weights.sumOfWeightsSquared);
    }
 
    return StatusCode::SUCCESS;
  }

graph()

TGraph * AthHistogramming::graph ( const std::string & graphName, const std::string & tDir = "", const std::string & stream = "" )

protectedinherited

Simplify the retrieval of registered TGraphs.

Definition at line 492 of file AthHistogramming.cxx.

{
  // Build a 32 bit hash out of the name
  const hash_t graphHash = this->hash(graphName);
 
  // See if this entry exists in the map
  GraphMap_t::const_iterator it = m_graphMap.find( graphHash );
  if ( it == m_graphMap.end() ) // It doesn't exist!
    { // Let's see into the THistSvc if somebody else has registered the TGraph...
 
      // Need to copy the strings as we will massage them from here on
      std::string graphNameCopy = graphName;
      std::string tDirCopy      = tDir;
      std::string streamCopy    = stream;
 
      // Massage the final string to book things
      std::string bookingString("");
      this->buildBookingString( bookingString, graphNameCopy, tDirCopy, streamCopy, true);
 
      TGraph* graphPointer(NULL);
      if ( !((histSvc()->getGraph(bookingString, graphPointer)).isSuccess()) )
        {
          // Massage the final string to book things
          std::string bookingString("");
          this->buildBookingString( bookingString, graphNameCopy, tDirCopy, streamCopy, false );
 
          if ( !((histSvc()->getGraph(bookingString, graphPointer)).isSuccess()) )
            {
              m_msg << MSG::WARNING
                    << "Problem retrieving the TGraph with name (including pre- and post-fixes) "
                    << m_histNamePrefix + graphNameCopy + m_histNamePostfix
                    << " or with name " << graphNameCopy
                    << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
                    << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
              return NULL;
            }
          // If we get to here, we actually found the TGraph in the THistSvc.
          // So let's add it to the local cache map and return its pointer
          m_graphMap.insert( m_graphMap.end(), std::pair< const hash_t, TGraph* >( graphHash, graphPointer ) );
          return graphPointer;
        }
      // If we get to here, we actually found the TGraph in the THistSvc.
      // So let's add it to the local cache map and return its pointer
      m_graphMap.insert( m_graphMap.end(), std::pair< const hash_t, TGraph* >( graphHash, graphPointer ) );
      return graphPointer;
    }
 
 
  // Return the pointer to the TGraph that we got from the local cache map
  return it->second;
}

handle()

void EL::AnaAlgorithm::handle ( const Incident & inc )

inherited

receive the given incident

Guarantee

basic

Failures

incident handling errors

Definition at line 520 of file AnaAlgorithm.cxx.

  {
    if (inc.type() == IncidentType::BeginInputFile)
    {
      if (m_hasBeginInputFile)
        ANA_CHECK_THROW (beginInputFile ());
      if (m_hasFileExecute)
        ANA_CHECK_THROW (fileExecute ());
    } else if (inc.type() == IncidentType::EndInputFile)
    {
      if (m_hasEndInputFile)
        ANA_CHECK_THROW (endInputFile ());
    } else
    {
      ATH_MSG_WARNING( "Unknown incident type received: " << inc.type() );
    }
  }

hash()

AthHistogramming::hash_t AthHistogramming::hash ( const std::string & histName ) const

inlineprivateinherited

Method to calculate a 32-bit hash from a string.

Definition at line 428 of file AthHistogramming.h.

{
  const uint64_t hash64 = CxxUtils::crc64( histName );
  return (hash_t)(hash64 & 0xFFFFFFFF);
}

hist()

TH1 * AthHistogramming::hist ( const std::string & histName, const std::string & tDir = "", const std::string & stream = "" )

protectedinherited

Simplify the retrieval of registered histograms of any type.

Definition at line 198 of file AthHistogramming.cxx.

{
  // Build a 32 bit hash out of the name
  const hash_t histHash = this->hash(histName);
 
  // See if this entry exists in the map
  HistMap_t::const_iterator it = m_histMap.find( histHash );
  if ( it == m_histMap.end() ) // It doesn't exist!
    { // Let's see into the THistSvc if somebody else has registered the histogram...
 
      // Need to copy the strings as we will massage them from here on
      std::string histNameCopy = histName;
      std::string tDirCopy     = tDir;
      std::string streamCopy   = stream;
 
      // Massage the final string to book things
      std::string bookingString("");
      this->buildBookingString( bookingString, histNameCopy, tDirCopy, streamCopy ,false);
 
      TH1* histPointer(NULL);
      if ( !((histSvc()->getHist(bookingString, histPointer)).isSuccess()) )
        {
          // Massage the final string to book things
          std::string bookingString("");
          this->buildBookingString( bookingString, histNameCopy, tDirCopy, streamCopy, true );
 
          if ( !((histSvc()->getHist(bookingString, histPointer)).isSuccess()) )
            {
              m_msg << MSG::WARNING
                    << "Problem retrieving the histogram with name (including pre- and post-fixes) "
                    << m_histNamePrefix + histNameCopy + m_histNamePostfix
                    << " or with name " << histNameCopy
                    << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
                    << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
              return NULL;
            }
          // If we get to here, we actually found the histogram in the THistSvc.
          // So let's add it to the local cache map and return its pointer
          m_histMap.insert( m_histMap.end(), std::pair< const hash_t, TH1* >( histHash, histPointer ) );
          return histPointer;
        }
      // If we get to here, we actually found the histogram in the THistSvc.
      // So let's add it to the local cache map and return its pointer
      m_histMap.insert( m_histMap.end(), std::pair< const hash_t, TH1* >( histHash, histPointer ) );
      return histPointer;
    }
 
 
  // Return the pointer to the histogram that we got from the local cache map
  return it->second;
}

hist2d()

TH2 * AthHistogramming::hist2d ( const std::string & histName, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the retrieval of registered 2-d histograms.

Definition at line 369 of file AthHistogramming.h.

{
  // Get the TH1 pointer
  TH1* th1Pointer = this->hist(histName, tDir, stream);
  if ( !th1Pointer )
    {
      m_msg << MSG::ERROR
            << "Cannot get a 2-d histogram with name " << histName
            << "... will probably seg-fault!" << endmsg;
      return NULL;
    }
  // If the TH1 pointer is valid, simply return the dynamic_cast
  return dynamic_cast<TH2*>( th1Pointer );
}

hist3d()

TH3 * AthHistogramming::hist3d ( const std::string & histName, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the retrieval of registered 3-d histograms.

Definition at line 386 of file AthHistogramming.h.

{
  // Get the TH1 pointer
  TH1* th1Pointer = this->hist(histName, tDir, stream);
  if ( !th1Pointer )
    {
      m_msg << MSG::ERROR
            << "Cannot get a 3-d histogram with name " << histName
            << "... will probably seg-fault!" << endmsg;
      return NULL;
    }
  // If the TH1 pointer is valid, simply return the dynamic_cast
  return dynamic_cast<TH3*>( th1Pointer );
}

histSvc()

const ServiceHandle< ITHistSvc > & AthHistogramAlgorithm::histSvc ( ) const

inlineinherited

The standard THistSvc (for writing histograms and TTrees and more to a root file) Returns (kind of) a pointer to the THistSvc.

Definition at line 113 of file AthHistogramAlgorithm.h.

{
  return m_histSvc;
}

initialize()

StatusCode CP::AsgCutBookkeeperAlg::initialize ( )

override

initialize

Definition at line 31 of file AsgCutBookkeeperAlg.cxx.

  {
    if (m_runNumber.value() == 0)
    {
      ANA_MSG_ERROR ("Run number should be set");
      return StatusCode::FAILURE;
    }
 
    ANA_CHECK (requestFileExecute ());
 
    // Read the channel number from FileMetaData
    const xAOD::FileMetaData *fmd{};
    ANA_CHECK (inputMetaStore()->retrieve(fmd, "FileMetaData"));
 
    float flt_channel_number{};
    if (fmd->value(xAOD::FileMetaData::mcProcID, flt_channel_number))
    {
      m_mcChannelNumber = static_cast<uint32_t>(flt_channel_number);
    }
    if (m_mcChannelNumber == 0)
    {
      ANA_MSG_WARNING ("MC channel number could not be read from the FileMetaData.");
 
      // Try also TruthMetaData
      const xAOD::TruthMetaDataContainer *tmd{};
      if (inputMetaStore()->contains<xAOD::TruthMetaDataContainer>("TruthMetaData"))
      {
        ATH_CHECK (inputMetaStore()->retrieve(tmd, "TruthMetaData"));
        ATH_MSG_DEBUG("Loaded xAOD::TruthMetaDataContainer");
 
        // If we only have one metadata item take MC channel from there if needed
        if (tmd->size() == 1) {
          m_mcChannelNumber = tmd->at(0)->mcChannelNumber();
          ATH_MSG_WARNING("... MC channel number taken from the metadata as " << m_mcChannelNumber);
        }
      }
    }
 
    // input streams supported by the algorithm
 
    // Prepare for systematics
    ANA_CHECK (m_truthWeightTool.retrieve());
 
    return StatusCode::SUCCESS;
  }

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::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() [1/2]

AnaAlgorithm::MetaStorePtr_t EL::AnaAlgorithm::inputMetaStore ( )

inherited

Definition at line 81 of file AnaAlgorithm.cxx.

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

inputMetaStore() [2/2]

AnaAlgorithm::ConstMetaStorePtr_t EL::AnaAlgorithm::inputMetaStore ( ) const

inherited

Accessor for the input metadata store

Definition at line 72 of file AnaAlgorithm.cxx.

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

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

myReplace()

void AthHistogramming::myReplace ( std::string & str, const std::string & oldStr, const std::string & newStr )

privateinherited

Helper method to replace sub-string.

Definition at line 590 of file AthHistogramming.cxx.

{
  size_t pos = 0;
  while((pos = str.find(oldStr, pos)) != std::string::npos)
    {
      str.replace(pos, oldStr.length(), newStr);
      pos += newStr.length();
    }
}

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::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() [1/2]

AnaAlgorithm::MetaStorePtr_t EL::AnaAlgorithm::outputMetaStore ( )

inherited

Definition at line 101 of file AnaAlgorithm.cxx.

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

outputMetaStore() [2/2]

AnaAlgorithm::ConstMetaStorePtr_t EL::AnaAlgorithm::outputMetaStore ( ) const

inherited

Accessor for the output metadata store

Definition at line 92 of file AnaAlgorithm.cxx.

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

print()

void EL::AnaAlgorithm::print ( ) const

protectedvirtualinherited

print the state of the algorithm

This is mostly to allow algorithms to add a little debugging information if they feel like it.

Definition at line 336 of file AnaAlgorithm.cxx.

  {}

processCutBookkeeper()

void CP::AsgCutBookkeeperAlg::processCutBookkeeper ( const xAOD::CutBookkeeper * cbk, size_t index )

private

process a CutBookkeeper

Definition at line 178 of file AsgCutBookkeeperAlg.cxx.

  {
    uint64_t nEventsProcessed  = cbk->nAcceptedEvents();
    double sumOfWeights        = cbk->sumOfEventWeights();
    double sumOfWeightsSquared = cbk->sumOfEventWeightsSquared();
 
    // Write CutBookkeeper information to the info
    ANA_MSG_VERBOSE ("CutBookkeeper information from the current file for index " << index << ":");
    ANA_MSG_VERBOSE ("Initial events                 = " << nEventsProcessed);
    ANA_MSG_VERBOSE ("Initial sum of weights         = " << sumOfWeights);
    ANA_MSG_VERBOSE ("Initial sum of weights squared = " << sumOfWeightsSquared);
 
    auto it = m_weights.emplace(index, WeightsGroup()).first;
    it->second.nEventsProcessed    += nEventsProcessed;
    it->second.sumOfWeights        += sumOfWeights;
    it->second.sumOfWeightsSquared += sumOfWeightsSquared;
  }

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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

requestBeginInputFile()

StatusCode EL::AnaAlgorithm::requestBeginInputFile ( )

inherited

register this algorithm to have an implementation of beginInputFile

Guarantee

strong

Failures

beginInputFile not supported

Definition at line 270 of file AnaAlgorithm.cxx.

  {
    m_hasBeginInputFile = true;
 
#ifndef XAOD_STANDALONE
    // Connect to the IncidentSvc:
    ServiceHandle< IIncidentSvc > incSvc( "IncidentSvc", name() );
    ATH_CHECK( incSvc.retrieve() );
 
    // Set up the right callback, but ensure we don't double-register
    // if we are called twice
    incSvc->removeListener( this, IncidentType::BeginInputFile );
    incSvc->addListener( this, IncidentType::BeginInputFile, 0, true );
#endif
 
    return StatusCode::SUCCESS;
  }

requestEndInputFile()

StatusCode EL::AnaAlgorithm::requestEndInputFile ( )

inherited

register this algorithm to have an implementation of endInputFile

Guarantee

strong

Failures

endInputFile not supported

Definition at line 291 of file AnaAlgorithm.cxx.

  {
    m_hasEndInputFile = true;
 
#ifndef XAOD_STANDALONE
    // Connect to the IncidentSvc:
    ServiceHandle< IIncidentSvc > incSvc( "IncidentSvc", name() );
    ATH_CHECK( incSvc.retrieve() );
 
    // Set up the right callback, but ensure we don't double-register
    // if we are called twice
    incSvc->removeListener( this, IncidentType::EndInputFile );
    incSvc->addListener( this, IncidentType::EndInputFile, 0, true );
#endif
 
    return StatusCode::SUCCESS;
  }

requestFileExecute()

StatusCode EL::AnaAlgorithm::requestFileExecute ( )

inherited

register this algorithm to have an implementation of fileexecute

Guarantee

strong

Failures

fileExecute not supported

Definition at line 249 of file AnaAlgorithm.cxx.

  {
    m_hasFileExecute = true;
 
#ifndef XAOD_STANDALONE
    // Connect to the IncidentSvc:
    ServiceHandle< IIncidentSvc > incSvc( "IncidentSvc", name() );
    ATH_CHECK( incSvc.retrieve() );
 
    // Set up the right callback, but ensure we don't double-register
    // if we are called twice
    incSvc->removeListener( this, IncidentType::BeginInputFile );
    incSvc->addListener( this, IncidentType::BeginInputFile, 0, true );
#endif
 
    return StatusCode::SUCCESS;
  }

sysInitialize()

StatusCode AthHistogramAlgorithm::sysInitialize ( )

virtualinherited

Initialization method invoked by the framework.

This method is responsible for any bookkeeping of initialization required by the framework itself. It will in turn invoke the initialize() method of the derived algorithm, and of any sub-algorithms which it creates.

Reimplemented from AthAlgorithm.

Reimplemented in AthAnalysisAlgorithm.

Definition at line 75 of file AthHistogramAlgorithm.cxx.

{
  // ---- stolen from GaudiKernel/Algorithm::sysInitialize -------
  // Bypass the initialization if the algorithm
  // has already been initialized.
  if ( Gaudi::StateMachine::INITIALIZED <= FSMState() ) return StatusCode::SUCCESS;
 
  // Set the Algorithm's properties
  bindPropertiesTo( serviceLocator()->getOptsSvc() );
 
  // Bypass the initialization if the algorithm is disabled.
  // Need to do this after bindPropertiesTo.
  if ( !isEnabled( ) ) return StatusCode::SUCCESS;
  
  // ---- stolen from GaudiKernel/Algorithm::sysInitialize ------- END ---
 
 
  // Get the THistSvc
  ATH_CHECK ( histSvc().retrieve() );
 
  // Configure the underlying AthHistogramming helper
  ATH_CHECK ( AthHistogramming::configAthHistogramming( m_histSvc,
                                                        m_prefix,          m_rootDir, 
                                                        m_histNamePrefix,  m_histNamePostfix,
                                                        m_histTitlePrefix, m_histTitlePostfix ) );
  
  // Print some setup information into the log file
  ATH_MSG_DEBUG ("Initializing " << name() << "...");
  ATH_MSG_DEBUG (" using THistService     = " << m_histSvc );
  ATH_MSG_DEBUG (" using RootStreamName   = " << m_prefix );
  ATH_MSG_DEBUG (" using RootDirName      = " << m_rootDir );
  ATH_MSG_DEBUG (" using HistNamePrefix   = " << m_histNamePrefix );
  ATH_MSG_DEBUG (" using HistNamePostfix  = " << m_histNamePostfix );
  ATH_MSG_DEBUG (" using HistTitlePrefix  = " << m_histTitlePrefix );
  ATH_MSG_DEBUG (" using HistTitlePostfix = " << m_histTitlePostfix );
 
 
  // re-direct to base class...
  return AthAlgorithm::sysInitialize();
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::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.

tree()

TTree * AthHistogramming::tree ( const std::string & treeName, const std::string & tDir = "", const std::string & stream = "" )

protectedinherited

Simplify the retrieval of registered TTrees.

Definition at line 378 of file AthHistogramming.cxx.

{
  // Build a 32 bit hash out of the name
  const hash_t treeHash = this->hash(treeName);
 
  // See if this entry exists in the map
  TreeMap_t::const_iterator it = m_treeMap.find( treeHash );
  if ( it == m_treeMap.end() ) // It doesn't exist!
    { // Let's see into the THistSvc if somebody else has registered the TTree...
 
      // Need to copy the strings as we will massage them from here on
      std::string treeNameCopy = treeName;
      std::string tDirCopy     = tDir;
      std::string streamCopy   = stream;
 
      // Massage the final string to book things
      std::string bookingString("");
      this->buildBookingString( bookingString, treeNameCopy, tDirCopy, streamCopy );
 
      TTree* treePointer(NULL);
      if ( !((histSvc()->getTree(bookingString, treePointer)).isSuccess()) )
        {
          m_msg << MSG::WARNING
                << "Problem retrieving the TTree with name " << treeNameCopy
                << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
                << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
          return NULL;
        }
      // If we get to here, we actually found the TTree in the THistSvc.
      // So let's add it to the local cache map and return its pointer
      m_treeMap.insert( m_treeMap.end(), std::pair< const hash_t, TTree* >( treeHash, treePointer ) );
      return treePointer;
    }
 
  // Return the pointer to the TTree that we got from the local cache map
  return it->second;
}

updateVHKA()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::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_allowed_streams

std::vector<std::string> CP::AsgCutBookkeeperAlg::m_allowed_streams {"StreamAOD", "StreamEVGEN", "StreamEVNT"}

private

input streams that we can run the CutBookkeepers against

Definition at line 78 of file AsgCutBookkeeperAlg.h.

{"StreamAOD", "StreamEVGEN", "StreamEVNT"};

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_effMap

EffMap_t AthHistogramming::m_effMap

privateinherited

The map of histogram names to their pointers.

Definition at line 208 of file AthHistogramming.h.

m_enableSystematics

Gaudi::Property<bool> CP::AsgCutBookkeeperAlg::m_enableSystematics {this, "enableSystematics", false, "enable systematics"}

private

flag to enable systematics

Definition at line 49 of file AsgCutBookkeeperAlg.h.

{this, "enableSystematics", false, "enable systematics"};

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

m_graphMap

GraphMap_t AthHistogramming::m_graphMap

privateinherited

The map of TGraph names to their pointers.

Definition at line 222 of file AthHistogramming.h.

m_hasBeginInputFile

bool EL::AnaAlgorithm::m_hasBeginInputFile {false}

privateinherited

the value of hasBeginInputFile

Definition at line 590 of file AnaAlgorithm.h.

{false};

m_hasEndInputFile

bool EL::AnaAlgorithm::m_hasEndInputFile {false}

privateinherited

the value of hasEndInputFile

Definition at line 594 of file AnaAlgorithm.h.

{false};

m_hasFileExecute

bool EL::AnaAlgorithm::m_hasFileExecute {false}

privateinherited

the value of hasFileExecute

Definition at line 586 of file AnaAlgorithm.h.

{false};

m_histMap

HistMap_t AthHistogramming::m_histMap

privateinherited

The map of histogram names to their pointers.

Definition at line 201 of file AthHistogramming.h.

m_histNamePostfix

std::string AthHistogramAlgorithm::m_histNamePostfix

privateinherited

The postfix for the histogram THx name.

Definition at line 97 of file AthHistogramAlgorithm.h.

m_histNamePrefix

std::string AthHistogramAlgorithm::m_histNamePrefix

privateinherited

The prefix for the histogram THx name.

Definition at line 94 of file AthHistogramAlgorithm.h.

m_histPattern

Gaudi::Property<std::string> CP::AsgCutBookkeeperAlg::m_histPattern {this, "histPattern", "CutBookkeeper_%DSID%_%RUN%_%SYS%", "the pattern for histogram names"}

private

the pattern for histogram names

Definition at line 86 of file AsgCutBookkeeperAlg.h.

{this, "histPattern", "CutBookkeeper_%DSID%_%RUN%_%SYS%", "the pattern for histogram names"};

m_histSvc

ServiceHandle<ITHistSvc> AthHistogramAlgorithm::m_histSvc

privateinherited

Default constructor: AthHistogramAlgorithm();.

a handle on the Hist/TTree registration service

Definition at line 83 of file AthHistogramAlgorithm.h.

m_histTitlePostfix

std::string AthHistogramAlgorithm::m_histTitlePostfix

privateinherited

The postfix for the histogram THx title.

Definition at line 103 of file AthHistogramAlgorithm.h.

m_histTitlePrefix

std::string AthHistogramAlgorithm::m_histTitlePrefix

privateinherited

The prefix for the histogram THx title.

Definition at line 100 of file AthHistogramAlgorithm.h.

m_inputMetaStore

MetaStore_t EL::AnaAlgorithm::m_inputMetaStore

privateinherited

Object accessing the input metadata store.

Definition at line 551 of file AnaAlgorithm.h.

m_mcChannelNumber

uint32_t CP::AsgCutBookkeeperAlg::m_mcChannelNumber {}

private

MC channel number we are processing.

Definition at line 65 of file AsgCutBookkeeperAlg.h.

{};

m_msg

MsgStream AthHistogramming::m_msg

privateinherited

Cached Message Stream.

Definition at line 248 of file AthHistogramming.h.

m_name

std::string AthHistogramming::m_name

privateinherited

Instance name.

Definition at line 245 of file AthHistogramming.h.

m_outputMetaStore

MetaStore_t EL::AnaAlgorithm::m_outputMetaStore

privateinherited

Object accessing the output metadata store.

Definition at line 555 of file AnaAlgorithm.h.

m_prefix

std::string AthHistogramAlgorithm::m_prefix

privateinherited

Name of the ROOT output stream (file)

Definition at line 88 of file AthHistogramAlgorithm.h.

m_rootDir

std::string AthHistogramAlgorithm::m_rootDir

privateinherited

Name of the ROOT directory.

Definition at line 91 of file AthHistogramAlgorithm.h.

m_runNumber

Gaudi::Property<uint32_t> CP::AsgCutBookkeeperAlg::m_runNumber {this, "runNumber", 0, "the run number we are processing"}

private

run number we are processing

Definition at line 61 of file AsgCutBookkeeperAlg.h.

{this, "runNumber", 0, "the run number we are processing"};

m_streamName

std::string AthHistogramming::m_streamName

privateinherited

Name of the ROOT output stream (file)

Definition at line 226 of file AthHistogramming.h.

m_systematics

ServiceHandle<ISystematicsSvc> CP::AsgCutBookkeeperAlg::m_systematics {this, "systematics", "SystematicsSvc", "systematics service"}

private

the systematics service

Definition at line 57 of file AsgCutBookkeeperAlg.h.

{this, "systematics", "SystematicsSvc", "systematics service"};

m_treeMap

TreeMap_t AthHistogramming::m_treeMap

privateinherited

The map of TTree names to their pointers.

Definition at line 215 of file AthHistogramming.h.

m_truthWeightTool

ToolHandle<PMGTools::IPMGTruthWeightTool> CP::AsgCutBookkeeperAlg::m_truthWeightTool {this, "truthWeightTool", "PMGTools::PMGTruthWeightTool", "the truth weight tool"}

private

the truth weight tool

Definition at line 53 of file AsgCutBookkeeperAlg.h.

{this, "truthWeightTool", "PMGTools::PMGTruthWeightTool", "the truth weight tool"};

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

m_weights

std::unordered_map<size_t, WeightsGroup> CP::AsgCutBookkeeperAlg::m_weights

private

weights map

Definition at line 82 of file AsgCutBookkeeperAlg.h.

---

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

• AsgCutBookkeeperAlg.h
• AsgCutBookkeeperAlg.cxx