AthAnalysisAlgorithm Class Reference

#include <AthAnalysisBaseComps/AthAnalysisAlgorithm.h>

Inheritance diagram for AthAnalysisAlgorithm:

Collaboration diagram for AthAnalysisAlgorithm:

Public Member Functions
	AthAnalysisAlgorithm (const std::string &name)
	Constructor taking just a name. More...
	AthAnalysisAlgorithm (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor with parameters: More...
virtual	~AthAnalysisAlgorithm () override
virtual StatusCode	sysInitialize () override
	Function initialising the tool in the correct way in Athena. More...
virtual StatusCode	sysExecute (const EventContext &) override
	override to do firstEvent method More...
template<typename T >
StatusCode	retrieveMetadata (const std::string &folder, const std::string &key, T &out)
	Helper function to access IOVMetaDataContainer information helped in the MetaDataStore. More...
template<typename T >
StatusCode	retrieveMetadata (const std::string &folder, const std::string &key, T &out, const IOVTime &time, int channel=-1)
	Helper function to access IOVMetaDataContainer information held in InputMetaDataStore, but will check IOVTime. More...
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. More...
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. 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

Protected Member Functions
void	updateEvtStore (Gaudi::Details::PropertyBase &prop)
virtual void	handle (const Incident &inc) override
	Function receiving incidents from IncidentSvc/TEvent Experts can override but they should ensure they add AthAnalysisAlgorithm::handle(); to the end of their own implementation. More...
virtual StatusCode	beginInputFile ()
	Function called when a new input file is opened user can read input metadata from inputMetaStore() More...
virtual StatusCode	endInputFile ()
	Function called as an input file is being closed. More...
virtual StatusCode	metaDataStop ()
	Function called before finalize user can read output metadata from outputMetaStore() More...
virtual StatusCode	firstExecute ()
	Function called when first execute is encountered user can read event information with evtStore() More...
virtual TFile *	currentFile (const char *evtSelName="EventSelector") final
	Function returning the TFile pointer of the currently open file of the given EventSelector (in athena jobs this defaults to "EventSelector") More...
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...
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. More...
TH1 *	bookGetPointer (const TH1 &hist, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of histograms. More...
TH1 *	bookGetPointer (TH1 *hist, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of histograms. More...
TH1 *	bookGetPointer (TH1 &histRef, std::string tDir="", std::string stream="")
	Simplify the booking and registering (into THistSvc) of histograms. More...
TTree *	bookGetPointer (const TTree &treeRef, std::string tDir="", std::string stream="")
	Simplify the booking and registering (into THistSvc) of TTrees. More...
TGraph *	bookGetPointer (const TGraph &graphRef, std::string tDir="", std::string stream="")
	Simplify the booking and registering (into THistSvc) of TGraphs. More...
TEfficiency *	bookGetPointer (const TEfficiency &eff, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency. More...
TEfficiency *	bookGetPointer (TEfficiency *eff, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency. More...
TEfficiency *	bookGetPointer (TEfficiency &effRef, std::string tDir="", std::string stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency. More...
StatusCode	book (const TH1 &hist, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of histograms. More...
StatusCode	book (TH1 *hist, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of histograms. More...
StatusCode	book (TH1 &histRef, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of histograms. More...
StatusCode	book (const TTree &treeRef, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of TTrees. More...
StatusCode	book (const TGraph &graphRef, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of TGraphs. More...
StatusCode	book (const TEfficiency &eff, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency. More...
StatusCode	book (TEfficiency *eff, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency. More...
StatusCode	book (TEfficiency &effRef, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency. More...
TH1 *	hist (const std::string &histName, const std::string &tDir="", const std::string &stream="")
	Simplify the retrieval of registered histograms of any type. More...
TH2 *	hist2d (const std::string &histName, const std::string &tDir="", const std::string &stream="")
	Simplify the retrieval of registered 2-d histograms. More...
TH3 *	hist3d (const std::string &histName, const std::string &tDir="", const std::string &stream="")
	Simplify the retrieval of registered 3-d histograms. More...
TTree *	tree (const std::string &treeName, const std::string &tDir="", const std::string &stream="")
	Simplify the retrieval of registered TTrees. More...
TGraph *	graph (const std::string &graphName, const std::string &tDir="", const std::string &stream="")
	Simplify the retrieval of registered TGraphs. More...
TEfficiency *	efficiency (const std::string &effName, const std::string &tDir="", const std::string &stream="")
	Simplify the retrieval of registered TEfficiency. More...

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

Private Member Functions
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...
void	buildBookingString (std::string &bookingString, std::string &histName, std::string &tDir, std::string &stream, bool usePrefixPostfix=false)
	Method to build individual booking string. More...
void	myReplace (std::string &str, const std::string &oldStr, const std::string &newStr)
	Helper method to replace sub-string. More...
hash_t	hash (const std::string &histName) const
	Method to calculate a 32-bit hash from a string. More...

Private Attributes
ServiceHandle< StoreGateSvc >	m_inputMetaStore
	Object accessing the input metadata store. More...
ServiceHandle< StoreGateSvc >	m_outputMetaStore
	Object accessing the output metadata store. More...
TFile *	m_currentFile {nullptr}
bool	m_doneFirstEvent {false}
ServiceHandle< ITHistSvc >	m_histSvc
	Default constructor: AthHistogramAlgorithm();. More...
std::string	m_prefix
	Name of the ROOT output stream (file) More...
std::string	m_rootDir
	Name of the ROOT directory. More...
std::string	m_histNamePrefix
	The prefix for the histogram THx name. More...
std::string	m_histNamePostfix
	The postfix for the histogram THx name. More...
std::string	m_histTitlePrefix
	The prefix for the histogram THx title. More...
std::string	m_histTitlePostfix
	The postfix for the histogram THx title. More...
DataObjIDColl	m_extendedExtraObjects
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
HistMap_t	m_histMap
	The map of histogram names to their pointers. More...
EffMap_t	m_effMap
	The map of histogram names to their pointers. More...
TreeMap_t	m_treeMap
	The map of TTree names to their pointers. More...
GraphMap_t	m_graphMap
	The map of TGraph names to their pointers. More...
std::string	m_streamName
	Name of the ROOT output stream (file) More...
std::string	m_name
	Instance name. More...
MsgStream	m_msg
	Cached Message Stream. More...

Detailed Description

Same as AthAlgorithm but adds a beginInputFile method and handle method for incident listening Also adds a retrieveMetadata method for easy metadata retrieval from InputMetaDataStore (method not IOV Safe though!) Update Feb 2016: Made inherit from AthHistogramAlgorithm, since that has nice histogram booking features

Author

Will Buttinger

Date

2015

Definition at line 34 of file AthAnalysisAlgorithm.h.

Member Typedef Documentation

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.

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.

Constructor & Destructor Documentation

AthAnalysisAlgorithm() [1/2]

AthAnalysisAlgorithm::AthAnalysisAlgorithm

(

const std::string &

name

)

Constructor taking just a name.

Definition at line 19 of file AthAnalysisAlgorithm.cxx.

  : AthAnalysisAlgorithm( name, Gaudi::svcLocator() )
{
  //we assume this constructor is used outside of the framework
  //therefore we must increment the ref count so that 
  //any SmartIF doesn't "release" the alg and therefore delete it
  addRef();
}

AthAnalysisAlgorithm() [2/2]

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

Constructor with parameters:

Definition at line 28 of file AthAnalysisAlgorithm.cxx.

  : AthHistogramAlgorithm(name,pSvcLocator)
  , m_inputMetaStore( "StoreGateSvc/InputMetaDataStore", name )
  , m_outputMetaStore( "StoreGateSvc/MetaDataStore", name )
{
  
  //declare an update handler for the EvtStore property, to reset the ServiceHandle
  for(auto prop : getProperties()) {
    if(prop->name() != "EvtStore") continue;
    prop->declareUpdateHandler(&AthAnalysisAlgorithm::updateEvtStore, this );
    break;
  }
 
}

~AthAnalysisAlgorithm()

AthAnalysisAlgorithm::~AthAnalysisAlgorithm ( )

overridevirtual

Definition at line 43 of file AthAnalysisAlgorithm.cxx.

{ }

Member Function Documentation

beginInputFile()

StatusCode AthAnalysisAlgorithm::beginInputFile ( )

protectedvirtual

Function called when a new input file is opened user can read input metadata from inputMetaStore()

Dummy implementation that can be overridden by the derived tool.

Reimplemented in MuonVal::MetaDataAlg.

Definition at line 114 of file AthAnalysisAlgorithm.cxx.

                                                {
 
   // Return gracefully:
   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;
}

currentFile()

TFile * AthAnalysisAlgorithm::currentFile ( const char *  evtSelName = "EventSelector" )

finalprotectedvirtual

Function returning the TFile pointer of the currently open file of the given EventSelector (in athena jobs this defaults to "EventSelector")

Definition at line 147 of file AthAnalysisAlgorithm.cxx.

                                                               {
   if(m_currentFile) return m_currentFile;
 
   //get the EventSelector so we can get it's list of input files
   //dont get it with a ServiceHandle, because that invokes initialize, can get into init loop
 
   SmartIF<IProperty> evtSelector{service(evtSelName, false)};
   if(!evtSelector) {
     ATH_MSG_ERROR("currentFile(): Couldn't find the service: " << evtSelName);return 0;
   }
 
   try {
      //get the list of input files - use this to determine which open file is the current input file
      const StringArrayProperty& inputCollectionsName = dynamic_cast<const StringArrayProperty&>(evtSelector->getProperty("InputCollections"));
 
      ATH_MSG_VERBOSE("nOpenFile=" << gROOT->GetListOfFiles()->GetSize() << ". nFilesInInputCollection=" << inputCollectionsName.value().size());
      if(msgLvl(MSG::VERBOSE)) {
          for(int i=0;i<gROOT->GetListOfFiles()->GetSize();i++) {
            ATH_MSG_VERBOSE("Open file: " << gROOT->GetListOfFiles()->At(i)->GetName());
          }
      }
 
      //look through list of files and find the one from the input collection that is currently open
 
      for(int i=0;i<gROOT->GetListOfFiles()->GetSize();i++) {
            TFile *g = (TFile*)gROOT->GetListOfFiles()->At(i);
            //see if this file is in the input file list
            //strip everything except stuff either side of last /
            TString s(g->GetName());
            TObjArray* tokens = s.Tokenize("/");
            TObjString* lastToken = static_cast<TObjString*>(tokens->Last());
            TString sToCompare("");
            bool shortComparison(false);
            if(tokens->GetEntries()>1) {
                TString beforeSlash((static_cast<TObjString*>(tokens->At(tokens->GetEntries()-2)))->GetString());
                if(beforeSlash.Length()>0) sToCompare += beforeSlash;
                sToCompare += "/";
            } else {
                shortComparison=true;
            }
            sToCompare += lastToken->GetString();
            TString sToCompare_short(lastToken->GetString()); //short versions search
            delete tokens;
 
            for(unsigned int j=0;j<inputCollectionsName.value().size();j++) {
                TString t(inputCollectionsName.value()[j].c_str());
                //try perfect match first
                if(s.EqualTo(t)) {
                  ATH_MSG_VERBOSE("Current File is: " << inputCollectionsName.value()[j]);
                  m_currentFile = g;
                  return g;
                }
                TObjArray* tokens = t.Tokenize("/");
                TObjString* lastToken = dynamic_cast<TObjString*>(tokens->Last());
                if (!lastToken) {
                  ATH_MSG_ERROR("Cannot cast token string to TObjString");
                  return nullptr;
                }
                TString tToCompare = "";
                bool shortComparison2(false);
                if(tokens->GetEntries()>1) {
                  TObjString* beforeSlashStr = dynamic_cast<TObjString*>(tokens->At(tokens->GetEntries()-2));
                  if (!beforeSlashStr) {
                    ATH_MSG_ERROR("Cannot cast token string to TObjString");
                    return nullptr;
                  }
                  TString beforeSlash(beforeSlashStr->GetString());
                  if(beforeSlash.Length()>0) tToCompare += beforeSlash;
                  tToCompare += "/";
                } else {
                  shortComparison2=true;
                }
                tToCompare += lastToken->GetString();
                TString tToCompare_short(lastToken->GetString());
                delete tokens;
 
                if(shortComparison || shortComparison2) { //doing short version search, no directories to distinguish files!
                  if(sToCompare_short.EqualTo(tToCompare_short)) {
                      ATH_MSG_VERBOSE("Current File is: " << inputCollectionsName.value()[j]);
                      m_currentFile = g;
                      return g;
                  }
                } else
                if(sToCompare.EqualTo(tToCompare)) {
                  ATH_MSG_VERBOSE("Current File is: " << inputCollectionsName.value()[j]);
                  m_currentFile=g;
                  return g;
                }
            }
      }
 
   } catch(...) {
     ATH_MSG_ERROR("currentFile(): Couldn't load InputCollections property of " << evtSelName); return 0;
   }
 
   ATH_MSG_ERROR("currentFile(): Could not find the current file!");
   return 0; //something went wrong :-(
 
}

declareGaudiProperty() [1/4]

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

declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::declareGaudiProperty ( Gaudi::Property< T, V, H > &  t, const SG::NotHandleType &    )

inlineprivateinherited

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

Definition at line 199 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(t);
  }

declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< 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 AthAnalysisAlgorithm::endInputFile ( )

protectedvirtual

Function called as an input file is being closed.

Dummy implementation that can be overridden by the derived tool.

Definition at line 122 of file AthAnalysisAlgorithm.cxx.

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

evtStore() [1/2]

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

evtStore() [2/2]

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

firstExecute()

StatusCode AthAnalysisAlgorithm::firstExecute ( )

protectedvirtual

Function called when first execute is encountered user can read event information with evtStore()

Dummy implementation that can be overridden by the derived tool.

Reimplemented in CP::JetTileCorrectionAlg.

Definition at line 139 of file AthAnalysisAlgorithm.cxx.

                                              {
 
   // Return gracefully:
   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 AthAnalysisAlgorithm::handle ( const Incident &  inc )

overrideprotectedvirtual

Function receiving incidents from IncidentSvc/TEvent Experts can override but they should ensure they add AthAnalysisAlgorithm::handle(); to the end of their own implementation.

Definition at line 83 of file AthAnalysisAlgorithm.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_currentFile=0;
      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() == "MetaDataStop" ) {
     if( metaDataStop().isFailure() ) {
         ATH_MSG_FATAL( "Failed to call metaDataStop()" );
         throw std::runtime_error( "Couldn't call metaDataStop()" );
      }
   } else {
      ATH_MSG_WARNING( "Unknown incident type received: " << inc.type() );
   }
 
   return;
}

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

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]

ServiceHandle< StoreGateSvc >& AthAnalysisAlgorithm::inputMetaStore ( )

inline

Accessor for the input metadata store.

Definition at line 51 of file AthAnalysisAlgorithm.h.

{ return m_inputMetaStore; }

inputMetaStore() [2/2]

const ServiceHandle< StoreGateSvc >& AthAnalysisAlgorithm::inputMetaStore ( ) const

inline

Const accessor for the input metadata store.

Definition at line 49 of file AthAnalysisAlgorithm.h.

{ return m_inputMetaStore; }

metaDataStop()

StatusCode AthAnalysisAlgorithm::metaDataStop ( )

protectedvirtual

Function called before finalize user can read output metadata from outputMetaStore()

Dummy implementation that can be overridden by the derived tool.

Definition at line 130 of file AthAnalysisAlgorithm.cxx.

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

msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

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

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

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]

ServiceHandle< StoreGateSvc >& AthAnalysisAlgorithm::outputMetaStore ( )

inline

Accessor for the output metadata store.

Definition at line 55 of file AthAnalysisAlgorithm.h.

{ return m_outputMetaStore; }

outputMetaStore() [2/2]

const ServiceHandle< StoreGateSvc >& AthAnalysisAlgorithm::outputMetaStore ( ) const

inline

Const accessor for the output metadata store.

Definition at line 53 of file AthAnalysisAlgorithm.h.

{ return m_outputMetaStore; }

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

retrieveMetadata() [1/2]

template<typename T >

StatusCode AthAnalysisAlgorithm::retrieveMetadata ( const std::string &  folder, const std::string &  key, T &  out  )

inline

Helper function to access IOVMetaDataContainer information helped in the MetaDataStore.

Definition at line 65 of file AthAnalysisAlgorithm.h.

                                                                                                            {
        try {
            return AthAnalysisHelper::retrieveMetadata(folder,key,out,inputMetaStore());
        } catch(std::exception& e) {
            ATH_MSG_WARNING(e.what());
            return StatusCode::FAILURE;
        }
    }

retrieveMetadata() [2/2]

template<typename T >

StatusCode AthAnalysisAlgorithm::retrieveMetadata ( const std::string &  folder, const std::string &  key, T &  out, const IOVTime &  time, int  channel = -1  )

inline

Helper function to access IOVMetaDataContainer information held in InputMetaDataStore, but will check IOVTime.

Also can give a channel (leave as -1 to take first available) IOVTime(runNumber, eventNumber) is a valid constructor for example

Definition at line 76 of file AthAnalysisAlgorithm.h.

                                                                                                                                                 {
        try {
            return AthAnalysisHelper::retrieveMetadata(folder,key,out,inputMetaStore(),time,channel);
        } catch(std::exception& e) {
            ATH_MSG_WARNING(e.what());
            return StatusCode::FAILURE;
        }
    }

sysExecute()

StatusCode AthAnalysisAlgorithm::sysExecute ( const EventContext &  ctx )

overridevirtual

override to do firstEvent method

Definition at line 72 of file AthAnalysisAlgorithm.cxx.

                                                                   {
  if(!m_doneFirstEvent) {
    m_doneFirstEvent=true;
    if( firstExecute().isFailure() ) {
      ATH_MSG_FATAL("Failure in firstEvent method");
      return StatusCode::FAILURE;
    }
  }
  return AthHistogramAlgorithm::sysExecute(ctx);
}

sysInitialize()

StatusCode AthAnalysisAlgorithm::sysInitialize ( )

overridevirtual

Function initialising the tool in the correct way in Athena.

Reimplemented from AthHistogramAlgorithm.

Definition at line 50 of file AthAnalysisAlgorithm.cxx.

                                               {
 
      // Connect to the IncidentSvc:
      ServiceHandle< IIncidentSvc > incSvc( "IncidentSvc", name() );
      ATH_CHECK( incSvc.retrieve() );
 
      // Set up the right callbacks: //but ensure we don't double-register if sysInitialize called twice (appears to be the case)
      incSvc->removeListener( this, IncidentType::BeginInputFile );
      incSvc->addListener( this, IncidentType::BeginInputFile, 0, true );
      incSvc->removeListener( this, IncidentType::EndInputFile );
      incSvc->addListener( this, IncidentType::EndInputFile, 0, true );
      incSvc->removeListener( this, "MetaDataStop" );
      incSvc->addListener( this, "MetaDataStop", 0, true );
 
 
      // Let the base class do its thing:
      ATH_CHECK( AthHistogramAlgorithm::sysInitialize() );
 
      // Return gracefully:
      return StatusCode::SUCCESS;
}

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

updateEvtStore()

void AthAnalysisAlgorithm::updateEvtStore ( Gaudi::Details::PropertyBase &  prop )

protected

Definition at line 45 of file AthAnalysisAlgorithm.cxx.

                                                                        {
  evtStore().release().ignore(); 
  evtStore().setTypeAndName(prop.toString());
}

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_currentFile

TFile* AthAnalysisAlgorithm::m_currentFile {nullptr}

private

Definition at line 120 of file AthAnalysisAlgorithm.h.

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_doneFirstEvent

bool AthAnalysisAlgorithm::m_doneFirstEvent {false}

private

Definition at line 122 of file AthAnalysisAlgorithm.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_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_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_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

ServiceHandle< StoreGateSvc > AthAnalysisAlgorithm::m_inputMetaStore

private

Object accessing the input metadata store.

Definition at line 116 of file AthAnalysisAlgorithm.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

ServiceHandle< StoreGateSvc > AthAnalysisAlgorithm::m_outputMetaStore

private

Object accessing the output metadata store.

Definition at line 118 of file AthAnalysisAlgorithm.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_streamName

std::string AthHistogramming::m_streamName

privateinherited

Name of the ROOT output stream (file)

Definition at line 226 of file AthHistogramming.h.

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

---

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

• AthAnalysisAlgorithm.h
• AthAnalysisAlgorithm.cxx