#include <CaloCellsDumperAlg.h>

Inheritance diagram for MuonR4::CaloCellsDumperAlg:

Public Member Functions
	~CaloCellsDumperAlg ()=default
StatusCode	initialize () override final
StatusCode	execute (const EventContext &ctx) override final
	Execute method.
StatusCode	finalize () override final
	AthHistogramAlgorithm (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor with parameters:
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 bool	isClonable () const override
	Specify if the algorithm is clonable.
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
virtual bool	filterPassed (const EventContext &ctx) const
	Get filter decision:
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
	Set filter decision:
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

Protected Member Functions
virtual bool	isReEntrant () const override final
	Legacy algorithms are not thread-safe.
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 to fill the internal configuration.
TH1 *	bookGetPointer (const TH1 &hist, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
TH1 *	bookGetPointer (TH1 *hist, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
TH1 *	bookGetPointer (TH1 &histRef, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
TTree *	bookGetPointer (const TTree &treeRef, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of TTrees.
TGraph *	bookGetPointer (const TGraph &graphRef, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of TGraphs.
TEfficiency *	bookGetPointer (const TEfficiency &eff, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
TEfficiency *	bookGetPointer (TEfficiency *eff, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
TEfficiency *	bookGetPointer (TEfficiency &effRef, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
StatusCode	book (const TH1 &hist, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
StatusCode	book (TH1 *hist, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
StatusCode	book (TH1 &histRef, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
StatusCode	book (const TTree &treeRef, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of TTrees.
StatusCode	book (const TGraph &graphRef, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of TGraphs.
StatusCode	book (const TEfficiency &eff, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
StatusCode	book (TEfficiency *eff, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
StatusCode	book (TEfficiency &effRef, std::string_view tDir="", std::string_view stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
TH1 *	hist (std::string_view histName, std::string_view tDir="", std::string_view stream="")
	Simplify the retrieval of registered histograms of any type.
TH2 *	hist2d (std::string_view histName, std::string_view tDir="", std::string_view stream="")
	Simplify the retrieval of registered 2-d histograms.
TH3 *	hist3d (std::string_view histName, std::string_view tDir="", std::string_view stream="")
	Simplify the retrieval of registered 3-d histograms.
TTree *	tree (std::string_view treeName, std::string_view tDir="", std::string_view stream="")
	Simplify the retrieval of registered TTrees.
TGraph *	graph (std::string_view graphName, std::string_view tDir="", std::string_view stream="")
	Simplify the retrieval of registered TGraphs.
TEfficiency *	efficiency (std::string_view effName, std::string_view tDir="", std::string_view 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
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>
std::string	buildBookingString (std::string_view histName, std::string_view tDir, std::string_view stream, bool usePrefixPostfix=false) const
	Method to build individual booking string.
hash_t	hash (std::string_view histName) const
	Method to calculate a 32-bit hash from a string.

Private Attributes
SG::ReadHandleKey< CaloCellContainer >	m_cellKey
SG::ReadHandleKey< CaloTowerContainer >	m_towerKey
Gaudi::Property< float >	m_minE
Gaudi::Property< int >	m_maxCells
Gaudi::Property< float >	m_minTowerE
Gaudi::Property< int >	m_maxTowers
const CaloCell_ID *	m_caloId {nullptr}
MuonVal::MuonTesterTree	m_tree {"CaloDump", "MuonBucketDump"}
std::shared_ptr< MuonVal::EventHashBranch >	m_evtHash {}
MuonVal::MuonIdentifierBranch	m_cell_id {m_tree, "cell_id"}
MuonVal::ThreeVectorBranch	m_cell_pos {m_tree, "cell_position"}
MuonVal::VectorBranch< float > &	m_cell_energy {m_tree.newVector<float>("cell_energy_mev")}
MuonVal::VectorBranch< float > &	m_cell_eta {m_tree.newVector<float>("cell_eta")}
MuonVal::VectorBranch< float > &	m_cell_phi {m_tree.newVector<float>("cell_phi")}
MuonVal::VectorBranch< int > &	m_cell_sampling {m_tree.newVector<int>("cell_sampling")}
MuonVal::VectorBranch< int > &	m_cell_subCalo {m_tree.newVector<int>("cell_subCalo")}
MuonVal::VectorBranch< unsigned short > &	m_cell_isTile {m_tree.newVector<unsigned short>("cell_isTile")}
MuonVal::VectorBranch< float > &	m_tower_energy {m_tree.newVector<float>("tower_energy_mev")}
MuonVal::VectorBranch< float > &	m_tower_et {m_tree.newVector<float>("tower_et_mev")}
MuonVal::VectorBranch< float > &	m_tower_eta {m_tree.newVector<float>("tower_eta")}
MuonVal::VectorBranch< float > &	m_tower_phi {m_tree.newVector<float>("tower_phi")}
MuonVal::ThreeVectorBranch	m_tower_dir {m_tree, "tower_direction"}
MuonVal::VectorBranch< unsigned int > &	m_tower_nCells {m_tree.newVector<unsigned int>("tower_nCells")}
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
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
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

Definition at line 21 of file CaloCellsDumperAlg.h.

Member Typedef Documentation

◆ EffMap_t

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

privateinherited

Typedef for convenience.

Definition at line 199 of file AthHistogramming.h.

◆ GraphMap_t

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

privateinherited

Typedef for convenience.

Definition at line 213 of file AthHistogramming.h.

◆ hash_t

typedef uint32_t AthHistogramming::hash_t

privateinherited

typedef for the internal hash

Definition at line 171 of file AthHistogramming.h.

◆ HistMap_t

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

privateinherited

Typedef for convenience.

Definition at line 192 of file AthHistogramming.h.

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::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 206 of file AthHistogramming.h.

Constructor & Destructor Documentation

◆ ~CaloCellsDumperAlg()

MuonR4::CaloCellsDumperAlg::~CaloCellsDumperAlg ( )

default

Member Function Documentation

◆ AthHistogramAlgorithm()

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

Constructor with parameters:

Definition at line 40 of file AthHistogramAlgorithm.cxx.

                                                                         : 
  ::AthAlgorithm( name, pSvcLocator ),
  ::AthHistogramming( name ),
  m_histSvc ( "THistSvc/THistSvc", name )
{
  //
  // Property declaration
  // 
  // The histogram service
  declareProperty("THistSvc",
                  m_histSvc = ServiceHandle<ITHistSvc>("THistSvc/THistSvc", name),
                  "Handle to a THistSvc instance: it will be used to write "
                  "ROOT objects to ROOT files" );
  //  declareProperty("THistService",      m_histSvc, "The THistSvc" );
  
  declareProperty("RootStreamName",    m_prefix  = "/ANALYSIS", "Name of the output ROOT stream (file) that the THistSvc uses");
  declareProperty("RootDirName",       m_rootDir = "",
                  "Name of the ROOT directory inside the ROOT file where the histograms will go");
 
  declareProperty( "HistNamePrefix",   m_histNamePrefix  = "", "The prefix for the histogram THx name" );
  declareProperty( "HistNamePostfix",  m_histNamePostfix = "",      "The postfix for the histogram THx name" );
 
  declareProperty( "HistTitlePrefix",  m_histTitlePrefix  = "", "The prefix for the histogram THx title" );
  declareProperty( "HistTitlePostfix", m_histTitlePostfix = "", "The postfix for the histogram THx title" );
}

◆ book() [1/8]

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

inlineprotectedinherited

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

Definition at line 329 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,
		std::string_view	tDir = "",
		std::string_view	stream = "" )

inlineprotectedinherited

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

◆ book() [3/8]

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

inlineprotectedinherited

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

Definition at line 297 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,
		std::string_view	tDir = "",
		std::string_view	stream = "" )

inlineprotectedinherited

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

Definition at line 397 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,
		std::string_view	tDir = "",
		std::string_view	stream = "" )

inlineprotectedinherited

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

Definition at line 350 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,
		std::string_view	tDir = "",
		std::string_view	stream = "" )

inlineprotectedinherited

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

Definition at line 340 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,
		std::string_view	tDir = "",
		std::string_view	stream = "" )

inlineprotectedinherited

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

Definition at line 318 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,
		std::string_view	tDir = "",
		std::string_view	stream = "" )

inlineprotectedinherited

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

Definition at line 308 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,
		std::string_view	tDir = "",
		std::string_view	stream = "" )

inlineprotectedinherited

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

Definition at line 275 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_view	tDir = "",
		std::string_view	stream = "" )

protectedinherited

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

Definition at line 374 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 = buildBookingString( 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,
		std::string_view	tDir = "",
		std::string_view	stream = "" )

inlineprotectedinherited

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

Definition at line 254 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_view	tDir = "",
		std::string_view	stream = "" )

protectedinherited

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

Definition at line 268 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 = buildBookingString( 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_view	tDir = "",
		std::string_view	stream = "" )

protectedinherited

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

Definition at line 139 of file AthHistogramming.cxx.

{
  std::string originalName{effRef.GetName()};
  const auto effName = splitName(originalName).second;
  const std::string effTitle(effRef.GetTitle());
  std::string bookingString = buildBookingString(originalName, tDir, stream);
  std::string finalEffName{m_histNamePrefix};
  finalEffName += effName;
  finalEffName += m_histNamePostfix;
  effRef.SetTitle((m_histTitlePrefix + effTitle + m_histTitlePostfix).c_str());
  effRef.SetName(finalEffName.c_str());
 
  const hash_t effHash = this->hash(effName);
  EffMap_t::const_iterator it = m_effMap.find(effHash);
  if (it != m_effMap.end()) {
    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 nullptr;
  }
 
  if (!histSvc()->regEfficiency(bookingString, &effRef).isSuccess()) {
    m_msg << MSG::WARNING
          << "Problem registering TEfficiency with name " << effName
          << ", name prefix " << m_histNamePrefix
          << ", title " << effTitle
          << ", title prefix " << m_histTitlePrefix
          << ", and title postfix " << m_histTitlePostfix
          << " in " << m_name << "!" << endmsg;
    return nullptr;
  }
 
  m_effMap.insert(m_effMap.end(), std::pair<const hash_t, TEfficiency*>(effHash, &effRef));
 
  return &effRef;
}

◆ bookGetPointer() [6/8]

TEfficiency * AthHistogramming::bookGetPointer	(	TEfficiency *	eff,
		std::string_view	tDir = "",
		std::string_view	stream = "" )

inlineprotectedinherited

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

Definition at line 287 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_view	tDir = "",
		std::string_view	stream = "" )

protectedinherited

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

Definition at line 97 of file AthHistogramming.cxx.

                                                                                          {
  
  const std::string originalName{histRef.GetName()};
  const auto histName = splitName(originalName).second;
  
  const std::string histTitle(histRef.GetTitle());
  std::string bookingString = buildBookingString(originalName, tDir, stream);
 
  std::string finalHistName{m_histNamePrefix};
  finalHistName += histName;
  finalHistName += m_histNamePostfix;
 
  histRef.SetTitle((m_histTitlePrefix + histTitle + m_histTitlePostfix).c_str());
  histRef.SetName(finalHistName.c_str());
 
  const hash_t histHash = this->hash(histName);
  HistMap_t::const_iterator it = m_histMap.find(histHash);
  if (it != m_histMap.end()) {
    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 nullptr;
  }
 
  if (!histSvc()->regHist(bookingString, &histRef).isSuccess()) {
    m_msg << MSG::WARNING
          << "Problem registering histogram with name " << histName
          << ", name prefix " << m_histNamePrefix
          << ", title " << histTitle
          << ", title prefix " << m_histTitlePrefix
          << ", and title postfix " << m_histTitlePostfix
          << " in " << m_name << "!" << endmsg;
    return nullptr;
  }
 
  m_histMap.insert(m_histMap.end(), std::pair<const hash_t, TH1*>(histHash, &histRef));
 
  return &histRef;
}

◆ bookGetPointer() [8/8]

TH1 * AthHistogramming::bookGetPointer	(	TH1 *	hist,
		std::string_view	tDir = "",
		std::string_view	stream = "" )

inlineprotectedinherited

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

Definition at line 266 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()

std::string AthHistogramming::buildBookingString	(	std::string_view	histName,
		std::string_view	tDir,
		std::string_view	stream,
		bool	usePrefixPostfix = false ) const

privateinherited

Method to build individual booking string.

Definition at line 500 of file AthHistogramming.cxx.

                                                     {
  if (tDir.empty()) {
    tDir = m_rootDir;
  }
  if (stream.empty()) {
    stream = m_streamName;
  }
  const auto [histDir, baseName] = splitName(histName);
  std::string bookingString{"/"};
  bookingString += stream;
  bookingString += '/';
  bookingString += tDir;
  if (!histDir.empty()) {
    bookingString += '/';
    bookingString += histDir;
  }
  bookingString += '/';
  if (usePrefixPostfix) {
    bookingString += m_histNamePrefix;
  }
  bookingString += baseName;
  if (usePrefixPostfix) {
    bookingString += m_histNamePostfix;
  }
  const auto tail = std::ranges::unique(
    bookingString, [](char lhs, char rhs) { return lhs == '/' && rhs == '/'; });
  bookingString.erase(tail.begin(), tail.end());
  return bookingString;
}

◆ 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 to fill the internal configuration.

Definition at line 64 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< Gaudi::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< Gaudi::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< Gaudi::Algorithm > >::detStore ( ) const

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ efficiency()

TEfficiency * AthHistogramming::efficiency	(	std::string_view	effName,
		std::string_view	tDir = "",
		std::string_view	stream = "" )

protectedinherited

Simplify the retrieval of registered TEfficiency.

Definition at line 214 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...
      // Massage the final string to book things
      std::string bookingString = buildBookingString(effName, tDir, stream ,false);
 
      TEfficiency* effPointer{};
      if ( !((histSvc()->getEfficiency(bookingString, effPointer)).isSuccess()) )
        {
          // Book things
          std::string bookingString = buildBookingString( effName, tDir, stream, true );
 
          if ( !((histSvc()->getEfficiency(bookingString, effPointer)).isSuccess()) )
            {
              m_msg << MSG::WARNING
                    << "Problem retrieving the TEfficiency with name (including pre- and post-fixes) "
                    << bookingString
                    << " or with name " << effName
                    << " 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;
}

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( )

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode MuonR4::CaloCellsDumperAlg::execute ( const EventContext & ctx )

finaloverridevirtual

Execute method.

Implements AthAlgorithm.

Definition at line 43 of file CaloCellsDumperAlg.cxx.

                                                              {
  
  // -----------------------------
  // Cells
  // -----------------------------
  const CaloCellContainer* cells{};
  ATH_CHECK(SG::get(cells, m_cellKey, ctx));
 
  int nStored = 0;
  for (const CaloCell* cell : *cells) {
    if (!cell) continue;
 
    // energy() is in MeV for CaloCell
    const float eMeV = cell->energy();
    if (eMeV < m_minE) continue;
 
    const CaloDetDescrElement* dde = cell->caloDDE();
    if (!dde) continue;
 
    // Store Identifier
    const Identifier& id = cell->ID();
    m_cell_id.push_back(id);
 
    // Store position (x,y,z) in mm, eta/phi from DDE
    const Amg::Vector3D pos(dde->x(), dde->y(), dde->z());
    m_cell_pos.push_back(pos);
    m_cell_energy.push_back(eMeV);
    m_cell_eta.push_back(dde->eta());
    m_cell_phi.push_back(dde->phi());
 
    // Sampling / subCalo
    // - dde->getSampling() gives CaloSampling::CaloSample enum (int)
    // - CaloCell_ID can decode subCalo for the Identifier
    m_cell_sampling.push_back(static_cast<int>(dde->getSampling()));
    m_cell_subCalo.push_back(static_cast<int>(m_caloId->sub_calo(id)));
    m_cell_isTile.push_back(static_cast<unsigned short>(dde->is_tile()));
 
    ++nStored;
    if (m_maxCells.value() > 0 && nStored >= m_maxCells.value()) break;
  }
 
  // -----------------------------
  // Towers
  // -----------------------------
  const CaloTowerContainer* towers{};
  ATH_CHECK(SG::get(towers, m_towerKey, ctx));
    int nTowStored = 0;
    for (const CaloTower* tow : *towers) {
      if (!tow) continue;
 
      // CaloTower energy is in MeV (same convention as cells)
      const float eMeV = tow->energy();
      if (eMeV < m_minTowerE) continue;
 
      const float eta = tow->eta();
      const float phi = tow->phi();
      const float etMeV = eMeV / std::cosh(eta);
 
      m_tower_energy.push_back(eMeV);
      m_tower_et.push_back(etMeV);
      m_tower_eta.push_back(eta);
      m_tower_phi.push_back(phi);
 
      // Derived direction vector (unit length) from eta/phi
      const double theta = 2.0 * std::atan(std::exp(-static_cast<double>(eta)));
      const double st = std::sin(theta);
      const double ct = std::cos(theta);
      const double cp = std::cos(static_cast<double>(phi));
      const double sp = std::sin(static_cast<double>(phi));
      const Amg::Vector3D dir(st * cp, st * sp, ct);
      m_tower_dir.push_back(dir);
 
      // Try to provide tower "size" (how many cells contribute)
      m_tower_nCells.push_back(static_cast<unsigned int>(tow->size()));
 
      ++nTowStored;
      if (m_maxTowers.value() > 0 && nTowStored >= m_maxTowers.value()) break;
    }
 
  if (!m_tree.fill(ctx)) return StatusCode::FAILURE;
  return StatusCode::SUCCESS;
}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::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 & AthCommonAlgorithm< Gaudi::Algorithm >::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 89 of file AthCommonAlgorithm.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 BaseAlg::extraOutputDeps();
}

◆ filterPassed()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Get filter decision:

Definition at line 93 of file AthCommonAlgorithm.h.

                                                           {
    return execState( ctx ).filterPassed();
  }

◆ finalize()

StatusCode MuonR4::CaloCellsDumperAlg::finalize ( )

finaloverride

Definition at line 38 of file CaloCellsDumperAlg.cxx.

                                        {
  ATH_CHECK(m_tree.write());
  return StatusCode::SUCCESS;
}

◆ graph()

TGraph * AthHistogramming::graph	(	std::string_view	graphName,
		std::string_view	tDir = "",
		std::string_view	stream = "" )

protectedinherited

Simplify the retrieval of registered TGraphs.

Definition at line 438 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...
 
      // Massage the final string to book things
      std::string bookingString = buildBookingString( graphName, tDir, stream, false);
 
      TGraph* graphPointer(nullptr);
      if ( !((histSvc()->getGraph(bookingString, graphPointer)).isSuccess()) )
        {
          // Massage the final string to book things
          std::string bookingString = buildBookingString( graphName, tDir, stream, true );
 
          if ( !((histSvc()->getGraph(bookingString, graphPointer)).isSuccess()) )
            {
              m_msg << MSG::WARNING
                    << "Problem retrieving the TGraph with name (including pre- and post-fixes) "
                    << bookingString
                    << " or with name " << graphName
                    << " 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 nullptr;
            }
          // 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;
}

◆ hash()

AthHistogramming::hash_t AthHistogramming::hash ( std::string_view histName ) const

inlineprivateinherited

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

Definition at line 422 of file AthHistogramming.h.

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

◆ hist()

TH1 * AthHistogramming::hist	(	std::string_view	histName,
		std::string_view	tDir = "",
		std::string_view	stream = "" )

protectedinherited

Simplify the retrieval of registered histograms of any type.

Definition at line 182 of file AthHistogramming.cxx.

                       {
 
  const auto histBaseName = splitName(histName).second;
  std::string bookingString = buildBookingString(histName, tDir, stream, false);
 
  const hash_t histHash = this->hash(histBaseName);
 
  HistMap_t::const_iterator it = m_histMap.find(histHash);
  if (it == m_histMap.end()) {
    TH1* histPointer(nullptr);
 
    if (!histSvc()->getHist(bookingString, histPointer).isSuccess()) {
      std::string prefixedBookingString = buildBookingString(histName, tDir, stream, true);
      if (!histSvc()->getHist(prefixedBookingString, histPointer).isSuccess()) {
        m_msg << MSG::WARNING
              << "Problem retrieving the histogram with name (including pre- and post-fixes) "
              << prefixedBookingString
              << " or with name " << histName
              << " 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 nullptr;
      }
    }
 
    m_histMap.insert(m_histMap.end(), std::pair<const hash_t, TH1*>(histHash, histPointer));
    return histPointer;
  }
 
  return it->second;
}

◆ hist2d()

TH2 * AthHistogramming::hist2d	(	std::string_view	histName,
		std::string_view	tDir = "",
		std::string_view	stream = "" )

inlineprotectedinherited

Simplify the retrieval of registered 2-d histograms.

Definition at line 363 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	(	std::string_view	histName,
		std::string_view	tDir = "",
		std::string_view	stream = "" )

inlineprotectedinherited

Simplify the retrieval of registered 3-d histograms.

Definition at line 380 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 MuonR4::CaloCellsDumperAlg::initialize ( )

finaloverride

Definition at line 16 of file CaloCellsDumperAlg.cxx.

                                          {
  ATH_CHECK(m_cellKey.initialize());
  ATH_CHECK(m_towerKey.initialize(SG::AllowEmpty));
 
  // CaloCell_ID helper (to provide subCalo/sampling via Identifier decoding if desired)
  ATH_CHECK(detStore()->retrieve(m_caloId, "CaloCell_ID"));
 
  // Event hash branch
  m_evtHash = std::make_shared<MuonVal::EventHashBranch>(m_tree.tree());
  m_tree.addBranch(m_evtHash);
 
  ATH_CHECK(m_tree.init(this));
  ATH_MSG_INFO("Initialized Calo dump with:"
               << " CellContainerKey=" << m_cellKey.key()
               << " MinCellEnergyMeV=" << m_minE
               << " MaxCells=" << m_maxCells
               << " | TowerContainerKey=" << m_towerKey.key()
               << " MinTowerEnergyMeV=" << m_minTowerE
               << " MaxTowers=" << m_maxTowers);
  return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::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.

◆ isClonable()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::isClonable ( ) const

inlineoverridevirtualinherited

Specify if the algorithm is clonable.

Only relevant for non-reentrant algorithms. Actual number of clones needs to be set via the "Cardinality" property.

Reimplemented in AFP_DigiTop, AlgB, AlgT, BCM_Digitization, CscDigitBuilder, CscDigitToCscRDO, G4AtlasAlg, G4RunAlg, HGTD_Digitization, HiveAlgBase, InDet::GNNSeedingTrackMaker, InDet::SCT_Clusterization, InDet::SiSPGNNTrackMaker, InDet::SiSPSeededTrackFinder, InDet::SiTrackerSpacePointFinder, ISF::SimKernelMT, ITk::StripDigitization, ITkPixelCablingAlg, ITkStripCablingAlg, LArHitEMapMaker, LArTTL1Maker, LUCID_DigiTop, LVL1::L1TopoSimulation, MergeCalibHits, MergeGenericMuonSimHitColl, MergeHijingPars, MergeMcEventCollection, MergeTrackRecordCollection, MergeTruthJets, MergeTruthParticles, MuonDigitizer, PileUpMTAlg, PixelDigitization, RoIBResultToxAOD, SCT_ByteStreamErrorsTestAlg, SCT_CablingCondAlgFromCoraCool, SCT_CablingCondAlgFromText, SCT_ConditionsParameterTestAlg, SCT_ConditionsSummaryTestAlg, SCT_ConfigurationConditionsTestAlg, SCT_Digitization, SCT_FlaggedConditionTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_PrepDataToxAOD, SCT_RawDataToxAOD, SCT_ReadCalibChipDataTestAlg, SCT_ReadCalibDataTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_SiliconConditionsTestAlg, SCT_StripVetoTestAlg, SCT_TdaqEnabledTestAlg, SCT_TestCablingAlg, SCTEventFlagWriter, SCTRawDataProvider, SCTSiLorentzAngleTestAlg, SCTSiPropertiesTestAlg, SGInputLoader, Simulation::BeamEffectsAlg, TileHitVecToCnt, TileMuonFitter, TilePulseForTileMuonReceiver, TileRawChannelMaker, TRTDigitization, and ZDC_DigiTop.

Definition at line 68 of file AthCommonAlgorithm.h.

                                           {
    return true;
  }

◆ isReEntrant()

virtual bool AthAlgorithm::isReEntrant ( ) const

inlinefinaloverrideprotectedvirtualinherited

Legacy algorithms are not thread-safe.

Definition at line 47 of file AthAlgorithm.h.

47{ return false; }

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::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.

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

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ setFilterPassed()

virtual void AthCommonAlgorithm< Gaudi::Algorithm >::setFilterPassed	(	bool	state,
		const EventContext &	ctx ) const

inlinevirtualinherited

Set filter decision:

Definition at line 99 of file AthCommonAlgorithm.h.

                                                                            {
    execState( ctx ).setFilterPassed( state );
  }

◆ sysExecute()

StatusCode AthCommonAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Reimplemented in AthAnalysisAlgorithm.

Definition at line 80 of file AthCommonAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

◆ 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 AthCommonAlgorithm< Gaudi::Algorithm >.

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< Gaudi::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	(	std::string_view	treeName,
		std::string_view	tDir = "",
		std::string_view	stream = "" )

protectedinherited

Simplify the retrieval of registered TTrees.

Definition at line 333 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...
      // Massage the final string to book things
      std::string bookingString = buildBookingString( treeName, tDir, stream);
 
      TTree* treePointer(NULL);
      if ( !((histSvc()->getTree(bookingString, treePointer)).isSuccess()) )
        {
          m_msg << MSG::WARNING
                << "Problem retrieving the TTree with name " << treeName
                << " 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< Gaudi::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);
      }
    }
  }

{this, "CellContainerKey", "AllCalo",

◆ m_graphMap

GraphMap_t AthHistogramming::m_graphMap

privateinherited

The map of TGraph names to their pointers.

Definition at line 216 of file AthHistogramming.h.

◆ m_histMap

HistMap_t AthHistogramming::m_histMap

privateinherited

The map of histogram names to their pointers.

Definition at line 195 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

SG::ReadHandleKey<CaloTowerContainer> MuonR4::CaloCellsDumperAlg::m_towerKey

private

Initial value:

{this, "TowerContainerKey", "CombinedTower",

"Input CaloTowerContainer key (e.g. CombinedTower)"}

Definition at line 33 of file CaloCellsDumperAlg.h.

33 {this, "TowerContainerKey", "CombinedTower",

34 "Input CaloTowerContainer key (e.g. CombinedTower)"};

◆ m_tree

MuonVal::MuonTesterTree MuonR4::CaloCellsDumperAlg::m_tree {"CaloDump", "MuonBucketDump"}

private

Definition at line 46 of file CaloCellsDumperAlg.h.

46{"CaloDump", "MuonBucketDump"};

◆ m_treeMap

TreeMap_t AthHistogramming::m_treeMap

privateinherited

The map of TTree names to their pointers.

Definition at line 209 of file AthHistogramming.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ EffMap_t

◆ GraphMap_t

◆ hash_t

◆ HistMap_t

◆ StoreGateSvc_t

◆ TreeMap_t

Constructor & Destructor Documentation

◆ ~CaloCellsDumperAlg()

Member Function Documentation

◆ AthHistogramAlgorithm()

◆ book() [1/8]

◆ book() [2/8]

◆ book() [3/8]

◆ book() [4/8]

◆ book() [5/8]

◆ book() [6/8]

◆ book() [7/8]

◆ book() [8/8]

◆ bookGetPointer() [1/8]

◆ bookGetPointer() [2/8]

◆ bookGetPointer() [3/8]

◆ bookGetPointer() [4/8]

◆ bookGetPointer() [5/8]

◆ bookGetPointer() [6/8]

◆ bookGetPointer() [7/8]

◆ bookGetPointer() [8/8]

◆ buildBookingString()

◆ configAthHistogramming()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ efficiency()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ filterPassed()

◆ finalize()

◆ graph()

◆ hash()

◆ hist()

◆ hist2d()

◆ hist3d()

◆ histSvc()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ isReEntrant()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ tree()

◆ updateVHKA()

Member Data Documentation

◆ m_caloId

◆ m_cell_energy

◆ m_cell_eta

◆ m_cell_id

◆ m_cell_isTile

◆ m_cell_phi

◆ m_cell_pos

◆ m_cell_sampling

◆ m_cell_subCalo

◆ m_cellKey

◆ m_detStore

◆ m_effMap

◆ m_evtHash