ATLAS Offline Software
Loading...
Searching...
No Matches
TruthHitAnalysis Class Reference

#include <TruthHitAnalysis.h>

Inheritance diagram for TruthHitAnalysis:
Collaboration diagram for TruthHitAnalysis:

Public Member Functions

 ~TruthHitAnalysis ()=default
virtual StatusCode execute (const EventContext &ctx) override final
 Execute method.
virtual StatusCode initialize () 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 by the derived classes to fill the internal configuration.
TH1 * bookGetPointer (const TH1 &hist, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of histograms.
TH1 * bookGetPointer (TH1 *hist, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of histograms.
TH1 * bookGetPointer (TH1 &histRef, std::string tDir="", std::string stream="")
 Simplify the booking and registering (into THistSvc) of histograms.
TTree * bookGetPointer (const TTree &treeRef, std::string tDir="", std::string stream="")
 Simplify the booking and registering (into THistSvc) of TTrees.
TGraph * bookGetPointer (const TGraph &graphRef, std::string tDir="", std::string stream="")
 Simplify the booking and registering (into THistSvc) of TGraphs.
TEfficiency * bookGetPointer (const TEfficiency &eff, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of TEfficiency.
TEfficiency * bookGetPointer (TEfficiency *eff, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of TEfficiency.
TEfficiency * bookGetPointer (TEfficiency &effRef, std::string tDir="", std::string stream="")
 Simplify the booking and registering (into THistSvc) of TEfficiency.
StatusCode book (const TH1 &hist, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of histograms.
StatusCode book (TH1 *hist, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of histograms.
StatusCode book (TH1 &histRef, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of histograms.
StatusCode book (const TTree &treeRef, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of TTrees.
StatusCode book (const TGraph &graphRef, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of TGraphs.
StatusCode book (const TEfficiency &eff, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of TEfficiency.
StatusCode book (TEfficiency *eff, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of TEfficiency.
StatusCode book (TEfficiency &effRef, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of TEfficiency.
TH1 * hist (std::string_view histName, const std::string &tDir="", const std::string &stream="")
 Simplify the retrieval of registered histograms of any type.
TH2 * hist2d (std::string_view histName, const std::string &tDir="", const std::string &stream="")
 Simplify the retrieval of registered 2-d histograms.
TH3 * hist3d (std::string_view histName, const std::string &tDir="", const std::string &stream="")
 Simplify the retrieval of registered 3-d histograms.
TTree * tree (const std::string &treeName, const std::string &tDir="", const std::string &stream="")
 Simplify the retrieval of registered TTrees.
TGraph * graph (const std::string &graphName, const std::string &tDir="", const std::string &stream="")
 Simplify the retrieval of registered TGraphs.
TEfficiency * efficiency (const std::string &effName, const std::string &tDir="", const std::string &stream="")
 Simplify the retrieval of registered TEfficiency.

Private Types

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

Private Attributes

TH1 * m_h_n_vert {nullptr}
 Some variables.
TH1 * m_h_n_part {nullptr}
TH1 * m_h_n_vert_prim {nullptr}
TH1 * m_h_n_part_prim {nullptr}
TH1 * m_h_n_vert_sec {nullptr}
TH1 * m_h_n_part_sec {nullptr}
TH1 * m_h_vtx_x {nullptr}
TH1 * m_h_vtx_y {nullptr}
TH1 * m_h_vtx_z {nullptr}
TH1 * m_h_vtx_r {nullptr}
TH1 * m_h_vtx_proc_x {nullptr}
TH1 * m_h_vtx_proc_y {nullptr}
TH1 * m_h_vtx_proc_z {nullptr}
TH1 * m_h_vtx_proc_r {nullptr}
TH1 * m_h_vtx_prim_x {nullptr}
TH1 * m_h_vtx_prim_y {nullptr}
TH1 * m_h_vtx_prim_z {nullptr}
TH1 * m_h_vtx_prim_r {nullptr}
TH2 * m_h_vtx_prim_xy {nullptr}
TH2 * m_h_vtx_prim_zr {nullptr}
TH2 * m_h_vtx_sec_xy {nullptr}
TH2 * m_h_vtx_sec_zr {nullptr}
TH1 * m_h_n_generations {nullptr}
TH1 * m_h_truth_px {nullptr}
TH1 * m_h_truth_py {nullptr}
TH1 * m_h_truth_pz {nullptr}
TH1 * m_h_truth_pt {nullptr}
TH1 * m_h_truth_eta {nullptr}
TH1 * m_h_truth_phi {nullptr}
TH1 * m_h_barcode {nullptr}
TH1 * m_h_part_status {nullptr}
TH1 * m_h_part_pdgid {nullptr}
TH1 * m_h_part_pdgid_sec {nullptr}
TH1 * m_h_part_eta {nullptr}
TH1 * m_h_part_phi {nullptr}
TH1 * m_h_part_p {nullptr}
std::vector< float > * m_vtx_x {nullptr}
std::vector< float > * m_vtx_y {nullptr}
std::vector< float > * m_vtx_z {nullptr}
std::vector< float > * m_vtx_r {nullptr}
std::vector< float > * m_vtx_barcode {nullptr}
std::vector< float > * m_vtx_proc_x {nullptr}
std::vector< float > * m_vtx_proc_y {nullptr}
std::vector< float > * m_vtx_proc_z {nullptr}
std::vector< float > * m_vtx_proc_r {nullptr}
std::vector< float > * m_vtx_proc_barcode {nullptr}
std::vector< float > * m_vtx_prim_x {nullptr}
std::vector< float > * m_vtx_prim_y {nullptr}
std::vector< float > * m_vtx_prim_z {nullptr}
std::vector< float > * m_vtx_prim_r {nullptr}
std::vector< float > * m_vtx_prim_barcode {nullptr}
std::vector< float > * m_truth_px {nullptr}
std::vector< float > * m_truth_py {nullptr}
std::vector< float > * m_truth_pz {nullptr}
std::vector< float > * m_truth_pt {nullptr}
std::vector< float > * m_truth_eta {nullptr}
std::vector< float > * m_truth_phi {nullptr}
std::vector< float > * m_barcode {nullptr}
std::vector< float > * m_status {nullptr}
std::vector< float > * m_pdgid {nullptr}
TTree * m_tree {nullptr}
Gaudi::Property< std::string > m_path {this, "HistPath","/TruthHitAnalysis/"}
Gaudi::Property< std::string > m_ntupleFileName {this, "NtupleFileName","/TruthHitAnalysis/"}
SG::ReadHandleKey< McEventCollectionm_readKey {this, "InputKey", "TruthEvent"}
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 14 of file TruthHitAnalysis.h.

Member Typedef Documentation

◆ EffMap_t

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

Typedef for convenience.

Definition at line 206 of file AthHistogramming.h.

◆ GraphMap_t

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

Typedef for convenience.

Definition at line 220 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 199 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 213 of file AthHistogramming.h.

Constructor & Destructor Documentation

◆ ~TruthHitAnalysis()

TruthHitAnalysis::~TruthHitAnalysis ( )
default

Member Function Documentation

◆ AthHistogramAlgorithm()

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

Constructor with parameters:

Definition at line 40 of file AthHistogramAlgorithm.cxx.

32 :
33 ::AthAlgorithm( name, pSvcLocator ),
34 ::AthHistogramming( name ),
35 m_histSvc ( "THistSvc/THistSvc", name )
36{
37 //
38 // Property declaration
39 //
40 // The histogram service
41 declareProperty("THistSvc",
42 m_histSvc = ServiceHandle<ITHistSvc>("THistSvc/THistSvc", name),
43 "Handle to a THistSvc instance: it will be used to write "
44 "ROOT objects to ROOT files" );
45 // declareProperty("THistService", m_histSvc, "The THistSvc" );
46
47 declareProperty("RootStreamName", m_prefix = "/ANALYSIS", "Name of the output ROOT stream (file) that the THistSvc uses");
48 declareProperty("RootDirName", m_rootDir = "",
49 "Name of the ROOT directory inside the ROOT file where the histograms will go");
50
51 declareProperty( "HistNamePrefix", m_histNamePrefix = "", "The prefix for the histogram THx name" );
52 declareProperty( "HistNamePostfix", m_histNamePostfix = "", "The postfix for the histogram THx name" );
53
54 declareProperty( "HistTitlePrefix", m_histTitlePrefix = "", "The prefix for the histogram THx title" );
55 declareProperty( "HistTitlePostfix", m_histTitlePostfix = "", "The postfix for the histogram THx title" );
56}
AthAlgorithm(const std::string &name, ISvcLocator *pSvcLocator)
Constructor.
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T, V, H > &t)
std::string m_histNamePrefix
The prefix for the histogram THx name.
ServiceHandle< ITHistSvc > m_histSvc
Default constructor: AthHistogramAlgorithm();.
std::string m_prefix
Name of the ROOT output stream (file).
std::string m_histNamePostfix
The postfix for the histogram THx name.
std::string m_histTitlePostfix
The postfix for the histogram THx title.
std::string m_rootDir
Name of the ROOT directory.
std::string m_histTitlePrefix
The prefix for the histogram THx title.
AthHistogramming(const std::string &name)
Constructor with parameters:

◆ 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 336 of file AthHistogramming.h.

337{
338 // We need to create a non-const clone
339 TEfficiency* effClone = dynamic_cast< TEfficiency* >( eff.Clone() );
340 if ( !effClone ) {
341 m_msg << MSG::ERROR << "Couldn't create a TEfficiency clone" << endmsg;
342 return StatusCode::FAILURE;
343 }
344 return this->book( *effClone, tDir, stream );
345}
#define endmsg
StatusCode book(const TH1 &hist, const std::string &tDir="", const std::string &stream="")
Simplify the booking and registering (into THistSvc) of histograms.
MsgStream m_msg
Cached Message 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 304 of file AthHistogramming.h.

305{
306 // We need to create a non-const clone
307 TH1* histClone = dynamic_cast< TH1* >( hist.Clone() );
308 if ( !histClone ) {
309 m_msg << MSG::ERROR << "Couldn't create a TH1 clone" << endmsg;
310 return StatusCode::FAILURE;
311 }
312 return this->book( *histClone, tDir, stream );
313}
TH1 * hist(std::string_view histName, const std::string &tDir="", const std::string &stream="")
Simplify the retrieval of registered histograms of any type.

◆ 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 404 of file AthHistogramming.h.

405{
406 // Call the other Book method and see if it returns a valid pointer
407 TTree* treePointer = this->bookGetPointer( treeRef, tDir, stream );
408 if ( treePointer )
409 {
410 return StatusCode::SUCCESS;
411 }
412 else
413 {
414 return StatusCode::FAILURE;
415 }
416}
TH1 * bookGetPointer(const TH1 &hist, const std::string &tDir="", const std::string &stream="")
Simplify the booking and registering (into THistSvc) of histograms.

◆ 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 357 of file AthHistogramming.h.

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

◆ 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 347 of file AthHistogramming.h.

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

◆ 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 325 of file AthHistogramming.h.

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

◆ 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 315 of file AthHistogramming.h.

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

◆ 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 282 of file AthHistogramming.h.

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

◆ 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 378 of file AthHistogramming.cxx.

379{
380 // Get a pointer
381 const TGraph* graphPointer = &graphRef;
382
383 // Check that we got a valid pointer
384 if ( !graphPointer )
385 {
386 m_msg << MSG::WARNING
387 << "We got an invalid TGraph pointer in the BookGetPointer(TGraph*) method of the class" << m_name
388 << "!" << endmsg;
389 return NULL;
390 }
391
392 // Modify the name and title according to the prefixes of this classes instance
393 std::string graphName = graphPointer->GetName();
394 const std::string graphTitle = graphPointer->GetTitle();
395
396 // Check if the hash for this graphName already exists, i.e., if we have a hash collision
397 const hash_t graphHash = this->hash(graphName);
398 GraphMap_t::const_iterator it = m_graphMap.find( graphHash );
399 if ( it != m_graphMap.end() ) // It does exist!
400 {
401 m_msg << MSG::WARNING
402 << "Detected a hash collision. The hash for the TGraph with name=" << graphName
403 << " already exists and points to a TGraph with name=" << it->second->GetName()
404 << " NOT going to book the new histogram and returning a NULL pointer!" << endmsg;
405 return NULL;
406 }
407
408 // Create a clone that has the new name
409 TGraph* graphClone = dynamic_cast< TGraph* >( graphPointer->Clone((m_histNamePrefix+graphName+m_histNamePostfix).c_str()) );
410 if( !graphClone )
411 {
412 m_msg << MSG::WARNING
413 << "We couldn't clone the TGraph in the BookGetPointer(TGraph&) method of the class" << m_name
414 << "!" << endmsg;
415 return NULL;
416 }
417 graphClone->SetTitle ((m_histTitlePrefix+graphTitle+m_histTitlePostfix).c_str());
418
419 // Massage the final string to book things
420 std::string bookingString = buildBookingString( graphName, tDir, stream );
421
422 // Register the TGraph into the THistSvc
423 if ( !((histSvc()->regGraph(bookingString, graphClone)).isSuccess()) )
424 {
425 m_msg << MSG::WARNING
426 << "Problem registering TGraph with name " << graphName
427 << ", title " << graphTitle
428 << " in " << m_name << "!" << endmsg;
429 return NULL;
430 }
431
432 // Also register it in the local map of string to pointer
433 m_graphMap.insert( m_graphMap.end(), std::pair< const hash_t, TGraph* >( graphHash, graphClone ) );
434
435 return graphClone;
436}
const ServiceHandle< ITHistSvc > & histSvc() const
The standard THistSvc (for writing histograms and TTrees and more to a root file) Returns (kind of) a...
std::string m_histNamePostfix
The postfix for the histogram THx name.
std::string buildBookingString(std::string &histName, std::string &tDir, std::string &stream, bool usePrefixPostfix=false)
Method to build individual booking string.
hash_t hash(const std::string &histName) const
Method to calculate a 32-bit hash from a string.
uint32_t hash_t
typedef for the internal hash
std::string m_histTitlePostfix
The postfix for the histogram THx title.
std::string m_histTitlePrefix
The prefix for the histogram THx title.
std::string m_name
Instance name.
std::string m_histNamePrefix
The prefix for the histogram THx name.
GraphMap_t m_graphMap
The map of TGraph names to their pointers.

◆ 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 261 of file AthHistogramming.h.

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

◆ 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 265 of file AthHistogramming.cxx.

266{
267 // Get a pointer
268 const TTree* treePointer = &treeRef;
269
270 // Check that we got a valid pointer
271 if ( !treePointer )
272 {
273 m_msg << MSG::WARNING
274 << "We got an invalid TTree pointer in the BookGetPointer(TTree*) method of the class" << m_name
275 << "!" << endmsg;
276 return NULL;
277 }
278
279 // Modify the name and title according to the prefixes of this classes instance
280 std::string treeName = treePointer->GetName();
281 const std::string treeTitle = treePointer->GetTitle();
282
283 // Check if the hash for this treeName already exists, i.e., if we have a hash collision
284 const hash_t treeHash = this->hash(treeName);
285 TreeMap_t::const_iterator it = m_treeMap.find( treeHash );
286 if ( it != m_treeMap.end() ) // It does exist!
287 {
288 m_msg << MSG::WARNING
289 << "Detected a hash collision. The hash for the TTree with name=" << treeName
290 << " already exists and points to a TTree with name=" << it->second->GetName()
291 << " NOT going to book the new histogram and returning a NULL pointer!" << endmsg;
292 return NULL;
293 }
294
295 // Create a clone that has the new name
296 TTree* treeClone = dynamic_cast< TTree* >( treePointer->Clone(treeName.c_str()) );
297 if( !treeClone )
298 {
299 m_msg << MSG::WARNING
300 << "We couldn't clone the TTree in the BookGetPointer(TTree&) method of the class" << m_name
301 << "!" << endmsg;
302 return NULL;
303 }
304 treeClone->SetTitle (treeTitle.c_str());
305
306 // Massage the final string to book things
307 std::string bookingString = buildBookingString( treeName, tDir, stream );
308
309 // Register the TTree into the THistSvc
310 if ( !((histSvc()->regTree(bookingString, treeClone)).isSuccess()) )
311 {
312 m_msg << MSG::WARNING
313 << "Problem registering TTree with name " << treeName
314 << ", title " << treeTitle
315 << " in " << m_name << "!" << endmsg;
316 return NULL;
317 }
318
319 // Also register it in the local map of string to pointer
320 m_treeMap.insert( m_treeMap.end(), std::pair< const hash_t, TTree* >( treeHash, treeClone ) );
321
322 return treeClone;
323}
TreeMap_t m_treeMap
The map of TTree names to their pointers.

◆ 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 121 of file AthHistogramming.cxx.

122{
123 std::string effName(effRef.GetName());
124 const std::string effTitle(effRef.GetTitle());
125 std::string bookingString = buildBookingString(effName, tDir, stream);
126 const std::string finalEffName = m_histNamePrefix + effName + m_histNamePostfix;
127 effRef.SetTitle((m_histTitlePrefix + effTitle + m_histTitlePostfix).c_str());
128 effRef.SetName(finalEffName.c_str());
129
130 const hash_t effHash = this->hash(effName);
131 EffMap_t::const_iterator it = m_effMap.find(effHash);
132 if (it != m_effMap.end()) {
133 m_msg << MSG::WARNING
134 << "Detected a hash collision. The hash for the TEfficiency with name=" << effName
135 << " already exists and points to a TEfficiency with name=" << it->second->GetName()
136 << " NOT going to book the new TEfficiency and returning a NULL pointer!" << endmsg;
137 return nullptr;
138 }
139
140 if (!histSvc()->regEfficiency(bookingString, &effRef).isSuccess()) {
141 m_msg << MSG::WARNING
142 << "Problem registering TEfficiency with name " << effName
143 << ", name prefix " << m_histNamePrefix
144 << ", title " << effTitle
145 << ", title prefix " << m_histTitlePrefix
146 << ", and title postfix " << m_histTitlePostfix
147 << " in " << m_name << "!" << endmsg;
148 return nullptr;
149 }
150
151 m_effMap.insert(m_effMap.end(), std::pair<const hash_t, TEfficiency*>(effHash, &effRef));
152
153 return &effRef;
154}
EffMap_t m_effMap
The map of histogram names to their pointers.

◆ 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 294 of file AthHistogramming.h.

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

◆ 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 83 of file AthHistogramming.cxx.

84{
85 std::string histName(histRef.GetName());
86 const std::string histTitle(histRef.GetTitle());
87 std::string bookingString = buildBookingString(histName, tDir, stream);
88
89 const std::string finalHistName = m_histNamePrefix + histName + m_histNamePostfix;
90
91 histRef.SetTitle((m_histTitlePrefix + histTitle + m_histTitlePostfix).c_str());
92 histRef.SetName(finalHistName.c_str());
93
94 const hash_t histHash = this->hash(histName);
95 HistMap_t::const_iterator it = m_histMap.find(histHash);
96 if (it != m_histMap.end()) {
97 m_msg << MSG::WARNING
98 << "Detected a hash collision. The hash for the histogram with name=" << histName
99 << " already exists and points to a histogram with name=" << it->second->GetName()
100 << " NOT going to book the new histogram and returning a NULL pointer!" << endmsg;
101 return nullptr;
102 }
103
104 if (!histSvc()->regHist(bookingString, &histRef).isSuccess()) {
105 m_msg << MSG::WARNING
106 << "Problem registering histogram with name " << histName
107 << ", name prefix " << m_histNamePrefix
108 << ", title " << histTitle
109 << ", title prefix " << m_histTitlePrefix
110 << ", and title postfix " << m_histTitlePostfix
111 << " in " << m_name << "!" << endmsg;
112 return nullptr;
113 }
114
115 m_histMap.insert(m_histMap.end(), std::pair<const hash_t, TH1*>(histHash, &histRef));
116
117 return &histRef;
118}
HistMap_t m_histMap
The map of histogram names to their pointers.

◆ 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 273 of file AthHistogramming.h.

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

◆ buildBookingString()

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

Method to build individual booking string.

Definition at line 509 of file AthHistogramming.cxx.

511{
512 std::string bookingString;
513 // Massage the final string to book things
514 if(tDir.empty()) tDir = m_rootDir;
515 size_t pos = histName.rfind('/');
516 if(pos != std::string::npos){
517 tDir+='/';
518 tDir.append(histName, 0,pos);
519 histName.erase(0,pos+1);
520 };
521 if(stream.empty()) stream = m_streamName;
522
523 if(usePrefixPostfix){
524 bookingString = "/"+stream+"/"+tDir+"/"+m_histNamePrefix+histName+m_histNamePostfix;
525 } else {
526 bookingString = "/"+stream+"/"+tDir+"/"+histName;
527 }
528 while(bookingString.find("//") != std::string::npos){
529 this->myReplace(bookingString,"//","/");
530 }
531
532 return bookingString;
533}
std::string m_rootDir
Name of the ROOT directory.
std::string m_streamName
Name of the ROOT output stream (file).
void myReplace(std::string &str, const std::string &oldStr, const std::string &newStr)
Helper method to replace sub-string.

◆ 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 51 of file AthHistogramming.cxx.

55{
58 m_rootDir = rootDir;
59 m_histNamePrefix = histNamePrefix;
60 m_histNamePostfix = histNamePostfix;
61 m_histTitlePrefix = histTitlePrefix;
62 m_histTitlePostfix = histTitlePostfix;
63
64 return StatusCode::SUCCESS;
65}
ServiceHandle< ITHistSvc > m_histSvc
Pointer to the THistSvc (event store by default).

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

158 {
160 hndl.value(),
161 hndl.documentation());
162
163 }

◆ declareProperty()

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

Definition at line 145 of file AthCommonDataStore.h.

145 {
146 typedef typename SG::HandleClassifier<T>::type htype;
148 }
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>

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

◆ 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 205 of file AthHistogramming.cxx.

206{
207 // Build a 32 bit hash out of the name
208 const hash_t effHash = this->hash(effName);
209
210 // See if this entry exists in the map
211 EffMap_t::const_iterator it = m_effMap.find( effHash );
212 if ( it == m_effMap.end() ) // It doesn't exist!
213 { // Let's see into the THistSvc if somebody else has registered the TEfficiency...
214
215 // Need to copy the strings as we will massage them from here on
216 std::string effNameCopy = effName;
217 std::string tDirCopy = tDir;
218 std::string streamCopy = stream;
219
220 // Massage the final string to book things
221 std::string bookingString = buildBookingString(effNameCopy, tDirCopy, streamCopy ,false);
222
223 TEfficiency* effPointer(NULL);
224 if ( !((histSvc()->getEfficiency(bookingString, effPointer)).isSuccess()) )
225 {
226 // Massage the final string to book things
227 std::string bookingString = buildBookingString( effNameCopy, tDirCopy, streamCopy, true );
228
229 if ( !((histSvc()->getEfficiency(bookingString, effPointer)).isSuccess()) )
230 {
231 m_msg << MSG::WARNING
232 << "Problem retrieving the TEfficiency with name (including pre- and post-fixes) "
233 << m_histNamePrefix + effNameCopy + m_histNamePostfix
234 << " or with name " << effNameCopy
235 << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
236 << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
237 return NULL;
238 }
239 // If we get to here, we actually found the TEfficiency in the THistSvc.
240 // So let's add it to the local cache map and return its pointer
241 m_effMap.insert( m_effMap.end(), std::pair< const hash_t, TEfficiency* >( effHash, effPointer ) );
242 return effPointer;
243 }
244 // If we get to here, we actually found the TEfficiency in the THistSvc.
245 // So let's add it to the local cache map and return its pointer
246 m_effMap.insert( m_effMap.end(), std::pair< const hash_t, TEfficiency* >( effHash, effPointer ) );
247 return effPointer;
248 }
249
250 // Return the pointer to the TEfficiency that we got from the local cache map
251 return it->second;
252}
std::pair< StatusCode, TEfficiency * > getEfficiency(ITHistSvc &svc, const std::string &name)

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

◆ execute()

StatusCode TruthHitAnalysis::execute ( const EventContext & ctx)
finaloverridevirtual

Execute method.

Implements AthAlgorithm.

Definition at line 198 of file TruthHitAnalysis.cxx.

198 {
199 ATH_MSG_DEBUG( "In TruthHitAnalysis::execute()" );
200
201 m_vtx_x->clear();
202 m_vtx_y->clear();
203 m_vtx_z->clear();
204 m_vtx_r->clear();
205 m_vtx_barcode->clear();
206 m_vtx_proc_x->clear();
207 m_vtx_proc_y->clear();
208 m_vtx_proc_z->clear();
209 m_vtx_proc_r->clear();
210 m_vtx_proc_barcode->clear();
211 m_vtx_prim_x->clear();
212 m_vtx_prim_y->clear();
213 m_vtx_prim_z->clear();
214 m_vtx_prim_r->clear();
215 m_vtx_prim_barcode->clear();
216 m_truth_px->clear();
217 m_truth_py->clear();
218 m_truth_pz->clear();
219 m_truth_pt->clear();
220 m_truth_eta->clear();
221 m_truth_phi->clear();
222 m_barcode->clear();
223 m_status->clear();
224 m_pdgid->clear();
225
226 const McEventCollection* mcCollection{nullptr};
227 ATH_CHECK(SG::get(mcCollection, m_readKey, ctx));
228
229
230 McEventCollection::const_iterator currentGenEventIter = mcCollection->begin();
231 if (currentGenEventIter != mcCollection->end()) {
232 int nvtx = 0;
233 int nvtx_sec=0;
234
235 const auto &procVtx = HepMC::signal_process_vertex(*currentGenEventIter);
236 const auto &barcodes = (*currentGenEventIter)->attribute<HepMC::GenEventBarcodes> (HepMCStr::barcodes);
237 std::map<int,int> id_to_barcode_map;
238 if (barcodes) id_to_barcode_map = barcodes->id_to_barcode_map();
239 for (const auto& vtx: (*currentGenEventIter)->vertices()) {
240 int bcode = id_to_barcode_map[vtx->id()];
241 double x = vtx->position().x();
242 double y = vtx->position().y();
243 double z = vtx->position().z();
244 double r = std::sqrt(x*x+y*y);
245 m_h_vtx_x->Fill(x);
246 m_h_vtx_y->Fill(y);
247 m_h_vtx_r->Fill(r);
248 m_h_vtx_z->Fill(z);
249
250 m_vtx_x->push_back(x);
251 m_vtx_y->push_back(y);
252 m_vtx_r->push_back(r);
253 m_vtx_z->push_back(z);
254 m_vtx_barcode->push_back(bcode);
255
256 if (vtx == procVtx) {
257 m_h_vtx_proc_x->Fill(x);
258 m_h_vtx_proc_y->Fill(y);
259 m_h_vtx_proc_r->Fill(r);
260 m_h_vtx_proc_z->Fill(z);
261
262 m_vtx_proc_x->push_back(x);
263 m_vtx_proc_y->push_back(y);
264 m_vtx_proc_r->push_back(r);
265 m_vtx_proc_z->push_back(z);
266 m_vtx_proc_barcode->push_back(bcode);
267 }
268
269 if (!HepMC::is_simulation_vertex(vtx)) {
270 m_h_vtx_prim_x->Fill(x);
271 m_h_vtx_prim_y->Fill(y);
272 m_h_vtx_prim_r->Fill(r);
273 m_h_vtx_prim_z->Fill(z);
274 m_h_vtx_prim_xy->Fill(x,y);
275 m_h_vtx_prim_zr->Fill(z,r);
276
277 m_vtx_prim_x->push_back(x);
278 m_vtx_prim_y->push_back(y);
279 m_vtx_prim_r->push_back(r);
280 m_vtx_prim_z->push_back(z);
281 m_vtx_prim_barcode->push_back(bcode);
282 ++nvtx;
283 }
284 else {
285 m_h_vtx_sec_xy->Fill(x,y);
286 m_h_vtx_sec_zr->Fill(z,r);
287 ++nvtx_sec;
288 }
289 } //End iteration over vertices
290
291 m_h_n_vert->Fill(nvtx+nvtx_sec);
292 m_h_n_vert_prim->Fill(nvtx);
293 m_h_n_vert_sec->Fill(nvtx_sec);
294
295 int npart_prim=0;
296 int npart_sec=0;
297
298 for (auto currentGenParticle: *(*currentGenEventIter)) {
299 const HepMC::FourVector mom = currentGenParticle->momentum();
300 int currentGenParticlebarcode = id_to_barcode_map[currentGenParticle->id()];
301 m_h_truth_px->Fill(mom.x());
302 m_h_truth_py->Fill(mom.y());
303 m_h_truth_pz->Fill(mom.z());
304 m_h_truth_pt->Fill(mom.perp());
305 m_h_truth_eta->Fill(mom.eta());
306 m_h_truth_phi->Fill(mom.phi());
307 m_h_barcode->Fill(currentGenParticlebarcode);
308 m_h_part_status->Fill(currentGenParticle->status());
309 m_truth_px->push_back(mom.x());
310 m_truth_py->push_back(mom.y());
311 m_truth_pz->push_back(mom.z());
312 m_truth_pt->push_back(mom.perp());
313 m_truth_eta->push_back(mom.eta());
314 m_truth_phi->push_back(mom.phi());
315 m_barcode->push_back(currentGenParticlebarcode);
316 m_status->push_back(currentGenParticle->status());
317
318 int pdg = currentGenParticle->pdg_id();
319 m_pdgid->push_back(pdg);
320
321 if (!HepMC::is_simulation_particle(currentGenParticle)) {
322 m_h_part_pdgid->Fill(pdg);
323 m_h_part_p->Fill(std::sqrt(mom.x()*mom.x()+mom.y()*mom.y()+mom.z()*mom.z()));
324 m_h_part_eta->Fill(mom.eta());
325 m_h_part_phi->Fill(mom.phi());
326 ++npart_prim;
327 m_h_n_generations->Fill(1);
328/* The conditions don't make any sense.
329 if (currentGenParticlebarcode < HepMC::PHOTOSMIN) {
330 m_h_n_generations->Fill(0);
331 }
332 else {
333 m_h_n_generations->Fill(1);
334 }
335*/
336 } //End simulation particle
337 else {
338 m_h_part_pdgid_sec->Fill(pdg);
339 ++npart_sec;
340 const int gen = HepMC::generations(currentGenParticle) + 2;
341 m_h_n_generations->Fill(gen);
342 }
343 } // End iteration over particles
344
345 m_h_n_part_prim->Fill(npart_prim);
346 m_h_n_part_sec->Fill(npart_sec);
347 m_h_n_part->Fill(npart_prim+npart_sec);
348 } // End mcCollection
349
350 m_tree->Fill();
351
352 return StatusCode::SUCCESS;
353}
#define ATH_CHECK
Evaluate an expression and check for errors.
#define ATH_MSG_DEBUG(x,...)
#define y
#define x
#define z
DataModel_detail::const_iterator< DataVector > const_iterator
Definition DataVector.h:837
const_iterator end() const noexcept
Return a const_iterator pointing past the end of the collection.
const_iterator begin() const noexcept
Return a const_iterator pointing at the beginning of the collection.
std::vector< float > * m_vtx_z
std::vector< float > * m_truth_pt
std::vector< float > * m_truth_py
std::vector< float > * m_vtx_prim_barcode
std::vector< float > * m_vtx_proc_r
std::vector< float > * m_pdgid
std::vector< float > * m_vtx_y
std::vector< float > * m_vtx_prim_z
TH1 * m_h_n_vert
Some variables.
std::vector< float > * m_vtx_proc_y
std::vector< float > * m_vtx_prim_x
std::vector< float > * m_vtx_x
SG::ReadHandleKey< McEventCollection > m_readKey
std::vector< float > * m_vtx_proc_x
std::vector< float > * m_vtx_barcode
std::vector< float > * m_vtx_proc_z
std::vector< float > * m_vtx_prim_r
std::vector< float > * m_vtx_prim_y
std::vector< float > * m_truth_pz
std::vector< float > * m_truth_eta
std::vector< float > * m_barcode
std::vector< float > * m_truth_phi
std::vector< float > * m_status
std::vector< float > * m_vtx_r
std::vector< float > * m_truth_px
std::vector< float > * m_vtx_proc_barcode
int r
Definition globals.cxx:22
bool is_simulation_vertex(const T &v)
Method to establish if the vertex was created during simulation (TODO migrate to be based on status).
HepMC3::FourVector FourVector
ConstGenVertexPtr signal_process_vertex(const GenEvent *e)
Definition GenEvent.h:597
bool is_simulation_particle(const T &p)
Method to establish if a particle (or barcode) was created during the simulation (TODO update to be s...
int generations(const T &p)
Method to return how many interactions a particle has undergone during simulation (TODO migrate to be...
const T * get(const ReadCondHandleKey< T > &key, const EventContext &ctx)
Convenience function to retrieve an object given a ReadCondHandleKey.
barcodes(beg, end, sz)
Definition Dumpers.py:2509

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

54{
55 // If we didn't find any symlinks to add, just return the collection
56 // from the base class. Otherwise, return the extended collection.
57 if (!m_extendedExtraObjects.empty()) {
59 }
61}
Common base class for algorithms.

◆ filterPassed()

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

Get filter decision:

Definition at line 93 of file AthCommonAlgorithm.h.

93 {
94 return execState( ctx ).filterPassed();
95 }
virtual bool filterPassed(const EventContext &ctx) const
Get filter decision:

◆ 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 442 of file AthHistogramming.cxx.

443{
444 // Build a 32 bit hash out of the name
445 const hash_t graphHash = this->hash(graphName);
446
447 // See if this entry exists in the map
448 GraphMap_t::const_iterator it = m_graphMap.find( graphHash );
449 if ( it == m_graphMap.end() ) // It doesn't exist!
450 { // Let's see into the THistSvc if somebody else has registered the TGraph...
451
452 // Need to copy the strings as we will massage them from here on
453 std::string graphNameCopy = graphName;
454 std::string tDirCopy = tDir;
455 std::string streamCopy = stream;
456
457 // Massage the final string to book things
458 std::string bookingString = buildBookingString( graphNameCopy, tDirCopy, streamCopy, false);
459
460 TGraph* graphPointer(nullptr);
461 if ( !((histSvc()->getGraph(bookingString, graphPointer)).isSuccess()) )
462 {
463 // Massage the final string to book things
464 std::string bookingString = buildBookingString( graphNameCopy, tDirCopy, streamCopy, true );
465
466 if ( !((histSvc()->getGraph(bookingString, graphPointer)).isSuccess()) )
467 {
468 m_msg << MSG::WARNING
469 << "Problem retrieving the TGraph with name (including pre- and post-fixes) "
470 << m_histNamePrefix + graphNameCopy + m_histNamePostfix
471 << " or with name " << graphNameCopy
472 << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
473 << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
474 return nullptr;
475 }
476 // If we get to here, we actually found the TGraph in the THistSvc.
477 // So let's add it to the local cache map and return its pointer
478 m_graphMap.insert( m_graphMap.end(), std::pair< const hash_t, TGraph* >( graphHash, graphPointer ) );
479 return graphPointer;
480 }
481 // If we get to here, we actually found the TGraph in the THistSvc.
482 // So let's add it to the local cache map and return its pointer
483 m_graphMap.insert( m_graphMap.end(), std::pair< const hash_t, TGraph* >( graphHash, graphPointer ) );
484 return graphPointer;
485 }
486
487
488 // Return the pointer to the TGraph that we got from the local cache map
489 return it->second;
490}
std::pair< StatusCode, TGraph * > getGraph(ITHistSvc &svc, const std::string &name)

◆ 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 429 of file AthHistogramming.h.

430{
431 const uint64_t hash64 = CxxUtils::crc64( histName );
432 return (hash_t)(hash64 & 0xFFFFFFFF);
433}
uint64_t crc64(const CRCTable &table, const char *data, size_t data_len)
Find the CRC-64 of a string,.
Definition crc64.cxx:696
std::uint64_t hash64(const void *data, std::size_t size)
Passthrough to XXH3_64bits.
Definition XXH.cxx:9

◆ hist()

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

Simplify the retrieval of registered histograms of any type.

Definition at line 161 of file AthHistogramming.cxx.

164{
165 std::string histNameCopy{histName};
166 std::string tDirCopy = tDir;
167 std::string streamCopy = stream;
168
169 std::string bookingString = buildBookingString(histNameCopy, tDirCopy, streamCopy, false);
170
171 const hash_t histHash = this->hash(histNameCopy);
172
173 HistMap_t::const_iterator it = m_histMap.find(histHash);
174 if (it == m_histMap.end()) {
175 TH1* histPointer(nullptr);
176
177 if (!histSvc()->getHist(bookingString, histPointer).isSuccess()) {
178 std::string prefixedHistNameCopy{histName};
179 std::string prefixedTDirCopy = tDir;
180 std::string prefixedStreamCopy = stream;
181
182 std::string prefixedBookingString = buildBookingString(prefixedHistNameCopy,
183 prefixedTDirCopy,
184 prefixedStreamCopy,
185 true);
186
187 if (!histSvc()->getHist(prefixedBookingString, histPointer).isSuccess()) {
188 m_msg << MSG::WARNING
189 << "Problem retrieving the histogram with name (including pre- and post-fixes) "
190 << m_histNamePrefix + histNameCopy + m_histNamePostfix
191 << " or with name " << histNameCopy
192 << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
193 << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
194 return nullptr;
195 }
196 }
197
198 m_histMap.insert(m_histMap.end(), std::pair<const hash_t, TH1*>(histHash, histPointer));
199 return histPointer;
200 }
201
202 return it->second;
203}
std::pair< StatusCode, TH1 * > getHist(ITHistSvc &svc, const std::string &name, size_t index=0)

◆ hist2d()

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

Simplify the retrieval of registered 2-d histograms.

Definition at line 370 of file AthHistogramming.h.

371{
372 // Get the TH1 pointer
373 TH1* th1Pointer = this->hist(histName, tDir, stream);
374 if ( !th1Pointer )
375 {
376 m_msg << MSG::ERROR
377 << "Cannot get a 2-d histogram with name " << histName
378 << "... will probably seg-fault!" << endmsg;
379 return NULL;
380 }
381 // If the TH1 pointer is valid, simply return the dynamic_cast
382 return dynamic_cast<TH2*>( th1Pointer );
383}

◆ hist3d()

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

Simplify the retrieval of registered 3-d histograms.

Definition at line 387 of file AthHistogramming.h.

388{
389 // Get the TH1 pointer
390 TH1* th1Pointer = this->hist(histName, tDir, stream);
391 if ( !th1Pointer )
392 {
393 m_msg << MSG::ERROR
394 << "Cannot get a 3-d histogram with name " << histName
395 << "... will probably seg-fault!" << endmsg;
396 return NULL;
397 }
398 // If the TH1 pointer is valid, simply return the dynamic_cast
399 return dynamic_cast<TH3*>( th1Pointer );
400}

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

114{
115 return m_histSvc;
116}

◆ initialize()

StatusCode TruthHitAnalysis::initialize ( )
finaloverridevirtual

histograms declaration

now add branches and leaves to the tree

Definition at line 13 of file TruthHitAnalysis.cxx.

13 {
14 ATH_MSG_DEBUG( "Initializing TruthHitAnalysis" );
15
16 // Grab the Ntuple and histogramming service for the tree
17 ATH_CHECK(m_readKey.initialize());
18
20 m_h_n_vert = new TH1D("h_n_vert","n_vert", 100,200, 1500);
21 m_h_n_vert->StatOverflows();
22 ATH_CHECK(histSvc()->regHist(m_path + m_h_n_vert->GetName(), m_h_n_vert));
23
24 m_h_n_part = new TH1D("h_n_part","n_part", 100,1000, 10000);
25 m_h_n_part->StatOverflows();
26 ATH_CHECK(histSvc()->regHist(m_path + m_h_n_part->GetName(), m_h_n_part));
27
28 m_h_n_vert_prim = new TH1D("h_n_vert_prim","n_vert prim", 100,0, 1000);
29 m_h_n_vert_prim->StatOverflows();
30 ATH_CHECK(histSvc()->regHist(m_path + m_h_n_vert_prim->GetName(), m_h_n_vert_prim));
31
32 m_h_n_part_prim = new TH1D("h_n_part_prim","n_part prim", 100,200, 1500);
33 m_h_n_part_prim->StatOverflows();
34 ATH_CHECK(histSvc()->regHist(m_path + m_h_n_part_prim->GetName(), m_h_n_part_prim));
35
36 m_h_n_vert_sec = new TH1D("h_n_vert_sec","n_vert sec", 100,0, 1000);
37 m_h_n_vert_sec->StatOverflows();
38 ATH_CHECK(histSvc()->regHist(m_path + m_h_n_vert_sec->GetName(), m_h_n_vert_sec));
39
40 m_h_n_part_sec = new TH1D("h_n_part_sec","n_part sec", 100,0, 5000);
41 m_h_n_part_sec->StatOverflows();
42 ATH_CHECK(histSvc()->regHist(m_path + m_h_n_part_sec->GetName(), m_h_n_part_sec));
43
44 m_h_vtx_x = new TH1D("h_vtx_x","vtx_x", 100,-1300, 1300);
45 m_h_vtx_x->StatOverflows();
46 ATH_CHECK(histSvc()->regHist(m_path + m_h_vtx_x->GetName(), m_h_vtx_x));
47
48 m_h_vtx_y = new TH1D("h_vtx_y","vtx_y", 100,-1200, 1200);
49 m_h_vtx_y->StatOverflows();
50 ATH_CHECK(histSvc()->regHist(m_path + m_h_vtx_y->GetName(), m_h_vtx_y));
51
52 m_h_vtx_z = new TH1D("h_vtx_z","vtx_z", 100,-5000, 5000);
53 m_h_vtx_z->StatOverflows();
54 ATH_CHECK(histSvc()->regHist(m_path + m_h_vtx_z->GetName(), m_h_vtx_z));
55
56 m_h_vtx_r = new TH1D("h_vtx_r","vtx_r", 100,0, 1160);
57 m_h_vtx_r->StatOverflows();
58 ATH_CHECK(histSvc()->regHist(m_path + m_h_vtx_r->GetName(), m_h_vtx_r));
59
60 m_h_vtx_proc_x = new TH1D("h_vtx_proc_x","vtx_proc_x", 100,-1300, 1300);
61 m_h_vtx_proc_x->StatOverflows();
62 ATH_CHECK(histSvc()->regHist(m_path + m_h_vtx_proc_x->GetName(), m_h_vtx_proc_x));
63
64 m_h_vtx_proc_y = new TH1D("h_vtx_proc_y","vtx_proc_y", 100,-1200, 1200);
65 m_h_vtx_proc_y->StatOverflows();
66 ATH_CHECK(histSvc()->regHist(m_path + m_h_vtx_proc_y->GetName(), m_h_vtx_proc_y));
67
68 m_h_vtx_proc_z = new TH1D("h_vtx_proc_z","vtx_proc_z", 100,-5000, 5000);
69 m_h_vtx_proc_z->StatOverflows();
70 ATH_CHECK(histSvc()->regHist(m_path + m_h_vtx_proc_z->GetName(), m_h_vtx_proc_z));
71
72 m_h_vtx_proc_r = new TH1D("h_vtx_proc_r","vtx_proc_r", 100,0, 1160);
73 m_h_vtx_proc_r->StatOverflows();
74 ATH_CHECK(histSvc()->regHist(m_path + m_h_vtx_proc_r->GetName(), m_h_vtx_proc_r));
75
76 m_h_vtx_prim_x = new TH1D("h_vtx_prim_x","vtx_prim_x", 100,-1300, 1300);
77 m_h_vtx_prim_x->StatOverflows();
78 ATH_CHECK(histSvc()->regHist(m_path + m_h_vtx_prim_x->GetName(), m_h_vtx_prim_x));
79
80 m_h_vtx_prim_y = new TH1D("h_vtx_prim_y","vtx_prim_y", 100,-1200, 1200);
81 m_h_vtx_prim_y->StatOverflows();
82 ATH_CHECK(histSvc()->regHist(m_path + m_h_vtx_prim_y->GetName(), m_h_vtx_prim_y));
83
84 m_h_vtx_prim_z = new TH1D("h_vtx_prim_z","vtx_prim_z", 100,-5000, 5000);
85 m_h_vtx_prim_z->StatOverflows();
86 ATH_CHECK(histSvc()->regHist(m_path + m_h_vtx_prim_z->GetName(), m_h_vtx_prim_z));
87
88 m_h_vtx_prim_r = new TH1D("h_vtx_prim_r","vtx_prim_r", 100,0, 1160);
89 m_h_vtx_prim_r->StatOverflows();
90 ATH_CHECK(histSvc()->regHist(m_path + m_h_vtx_prim_r->GetName(), m_h_vtx_prim_r));
91
92 m_h_vtx_prim_xy = new TH2D("h_vtx_prim_xy","vtx_prim_xy", 100,-100, 100, 100,-100, 100);
93 m_h_vtx_prim_xy->StatOverflows();
94 ATH_CHECK(histSvc()->regHist(m_path + m_h_vtx_prim_xy->GetName(), m_h_vtx_prim_xy));
95
96 m_h_vtx_prim_zr = new TH2D("h_vtx_prim_zr","vtx_prim_zr", 100,-1500, 1500, 100,0, 150);
97 m_h_vtx_prim_zr->StatOverflows();
98 ATH_CHECK(histSvc()->regHist(m_path + m_h_vtx_prim_zr->GetName(), m_h_vtx_prim_zr));
99
100 m_h_vtx_sec_xy = new TH2D("h_vtx_sec_xy","vtx_sec_xy", 100,-1200, 1200, 100,-1200, 1200);
101 m_h_vtx_sec_xy->StatOverflows();
102 ATH_CHECK(histSvc()->regHist(m_path + m_h_vtx_sec_xy->GetName(), m_h_vtx_sec_xy));
103
104 m_h_vtx_sec_zr = new TH2D("h_vtx_sec_zr","vtx_sec_zr", 100,-6000, 6000, 100,0, 1160);
105 m_h_vtx_sec_zr->StatOverflows();
106 ATH_CHECK(histSvc()->regHist(m_path + m_h_vtx_sec_zr->GetName(), m_h_vtx_sec_zr));
107
108 m_h_n_generations = new TH1D("h_n_generations","h_generations", 100,0, 25);
109 m_h_n_generations->StatOverflows();
111
112 m_h_truth_px = new TH1D("h_truth_px","truth_px", 100,0, 4000);
113 m_h_truth_px->StatOverflows();
114 ATH_CHECK(histSvc()->regHist(m_path + m_h_truth_px->GetName(), m_h_truth_px));
115
116 m_h_truth_py = new TH1D("h_truth_py","truth_py", 100,0, 4000);
117 m_h_truth_py->StatOverflows();
118 ATH_CHECK(histSvc()->regHist(m_path + m_h_truth_py->GetName(), m_h_truth_py));
119
120 m_h_truth_pz = new TH1D("h_truth_pz","truth_pz", 100,0, 4000);
121 m_h_truth_pz->StatOverflows();
122 ATH_CHECK(histSvc()->regHist(m_path + m_h_truth_pz->GetName(), m_h_truth_pz));
123
124 m_h_truth_pt = new TH1D("h_truth_pt","truth_pt", 100,0, 4000);
125 m_h_truth_pt->StatOverflows();
126 ATH_CHECK(histSvc()->regHist(m_path + m_h_truth_pt->GetName(), m_h_truth_pt));
127
128 m_h_truth_eta = new TH1D("h_truth_eta","truth_eta", 50,-10, 10);
129 m_h_truth_eta->StatOverflows();
130 ATH_CHECK(histSvc()->regHist(m_path + m_h_truth_eta->GetName(), m_h_truth_eta));
131
132 m_h_truth_phi = new TH1D("h_truth_phi","truth_phi", 25,-3.1416, 3.1416);
133 m_h_truth_phi->StatOverflows();
134 ATH_CHECK(histSvc()->regHist(m_path + m_h_truth_phi->GetName(), m_h_truth_phi));
135
136 m_h_barcode = new TH1D("h_truth_barcode","truth_barcode", 100,0, 300000);
137 m_h_barcode->StatOverflows();
138 ATH_CHECK(histSvc()->regHist(m_path + m_h_barcode->GetName(), m_h_barcode));
139
140 m_h_part_status = new TH1D("h_part_status","part status", 100,0,50);
141 m_h_part_status->StatOverflows();
142 ATH_CHECK(histSvc()->regHist(m_path + m_h_part_status->GetName(), m_h_part_status));
143
144 m_h_part_pdgid = new TH1D("h_part_pdgid","part pdgid", 100,-5000, 5000);
145 m_h_part_pdgid->StatOverflows();
146 ATH_CHECK(histSvc()->regHist(m_path + m_h_part_pdgid->GetName(), m_h_part_pdgid));
147
148 m_h_part_pdgid_sec = new TH1D("h_part_pdgid_sec","part pdgid sec", 100,-5000, 5000);
149 m_h_part_pdgid_sec->StatOverflows();
151
152 m_h_part_eta = new TH1D("h_part_eta","part eta", 100,-10, 10);
153 m_h_part_eta->StatOverflows();
154 ATH_CHECK(histSvc()->regHist(m_path + m_h_part_eta->GetName(), m_h_part_eta));
155
156 m_h_part_phi = new TH1D("h_part_phi","part phi", 100,-3.2, 3.2);
157 m_h_part_phi->StatOverflows();
158 ATH_CHECK(histSvc()->regHist(m_path + m_h_part_phi->GetName(), m_h_part_phi));
159
160 m_h_part_p = new TH1D("h_part_p","part p", 100,0, 5000);
161 m_h_part_p->StatOverflows();
162 ATH_CHECK(histSvc()->regHist(m_path + m_h_part_p->GetName(), m_h_part_p));
163
165 m_tree = new TTree("Truth", "Truth");
166 std::string fullNtupleName = "/" + m_ntupleFileName + "/";
167 ATH_CHECK(histSvc()->regTree(fullNtupleName,m_tree));
168
169 m_tree->Branch("vtx_x", &m_vtx_x);
170 m_tree->Branch("vtx_y", &m_vtx_y);
171 m_tree->Branch("vtx_z", &m_vtx_z);
172 m_tree->Branch("vtx_r", &m_vtx_r);
173 m_tree->Branch("vtx_barcode", &m_vtx_barcode);
174 m_tree->Branch("vtx_proc_x", &m_vtx_proc_x);
175 m_tree->Branch("vtx_proc_y", &m_vtx_proc_y);
176 m_tree->Branch("vtx_proc_z", &m_vtx_proc_z);
177 m_tree->Branch("vtx_proc_r", &m_vtx_proc_r);
178 m_tree->Branch("vtx_proc_barcode", &m_vtx_proc_barcode);
179 m_tree->Branch("vtx_prim_x", &m_vtx_prim_x);
180 m_tree->Branch("vtx_prim_y", &m_vtx_prim_y);
181 m_tree->Branch("vtx_prim_z", &m_vtx_prim_z);
182 m_tree->Branch("vtx_prim_r", &m_vtx_prim_r);
183 m_tree->Branch("vtx_prim_barcode", &m_vtx_prim_barcode);
184 m_tree->Branch("truth_px", &m_truth_px);
185 m_tree->Branch("truth_py", &m_truth_py);
186 m_tree->Branch("truth_pz", &m_truth_pz);
187 m_tree->Branch("truth_pt", &m_truth_pt);
188 m_tree->Branch("truth_eta", &m_truth_eta);
189 m_tree->Branch("truth_phi", &m_truth_phi);
190 m_tree->Branch("barcode", &m_barcode);
191 m_tree->Branch("status", &m_status);
192 m_tree->Branch("pdg_id", &m_pdgid);
193
194 return StatusCode::SUCCESS;
195}
const ServiceHandle< ITHistSvc > & histSvc() const
The standard THistSvc (for writing histograms and TTrees and more to a root file) Returns (kind of) a...
Gaudi::Property< std::string > m_path
Gaudi::Property< std::string > m_ntupleFileName

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

68 {
69 return true;
70 }

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

24 {
25 return this->msgStream();
26 }

◆ msgLvl()

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

Definition at line 30 of file AthCommonMsg.h.

30 {
31 return this->msgLevel(lvl);
32 }

◆ 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 537 of file AthHistogramming.cxx.

540{
541 size_t pos = 0;
542 while((pos = str.find(oldStr, pos)) != std::string::npos)
543 {
544 str.replace(pos, oldStr.length(), newStr);
545 pos += newStr.length();
546 }
547}

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

381 {
382 h.renounce();
384 }
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)

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

364 {
366 }

◆ setFilterPassed()

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

Set filter decision:

Reimplemented in AthFilterAlgorithm.

Definition at line 99 of file AthCommonAlgorithm.h.

99 {
101 }
virtual void setFilterPassed(bool state, const EventContext &ctx) const
Set filter decision:

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

41{
42 return BaseAlg::sysExecute (ctx);
43}

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

76{
77 // ---- stolen from GaudiKernel/Algorithm::sysInitialize -------
78 // Bypass the initialization if the algorithm
79 // has already been initialized.
80 if ( Gaudi::StateMachine::INITIALIZED <= FSMState() ) return StatusCode::SUCCESS;
81
82 // Set the Algorithm's properties
83 bindPropertiesTo( serviceLocator()->getOptsSvc() );
84
85 // Bypass the initialization if the algorithm is disabled.
86 // Need to do this after bindPropertiesTo.
87 if ( !isEnabled( ) ) return StatusCode::SUCCESS;
88
89 // ---- stolen from GaudiKernel/Algorithm::sysInitialize ------- END ---
90
91
92 // Get the THistSvc
93 ATH_CHECK ( histSvc().retrieve() );
94
95 // Configure the underlying AthHistogramming helper
100
101 // Print some setup information into the log file
102 ATH_MSG_DEBUG ("Initializing " << name() << "...");
103 ATH_MSG_DEBUG (" using THistService = " << m_histSvc );
104 ATH_MSG_DEBUG (" using RootStreamName = " << m_prefix );
105 ATH_MSG_DEBUG (" using RootDirName = " << m_rootDir );
106 ATH_MSG_DEBUG (" using HistNamePrefix = " << m_histNamePrefix );
107 ATH_MSG_DEBUG (" using HistNamePostfix = " << m_histNamePostfix );
108 ATH_MSG_DEBUG (" using HistTitlePrefix = " << m_histTitlePrefix );
109 ATH_MSG_DEBUG (" using HistTitlePostfix = " << m_histTitlePostfix );
110
111
112 // re-direct to base class...
114}
virtual StatusCode sysInitialize() override
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.

◆ 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 ( const std::string & treeName,
const std::string & tDir = "",
const std::string & stream = "" )
protectedinherited

Simplify the retrieval of registered TTrees.

Definition at line 330 of file AthHistogramming.cxx.

331{
332 // Build a 32 bit hash out of the name
333 const hash_t treeHash = this->hash(treeName);
334
335 // See if this entry exists in the map
336 TreeMap_t::const_iterator it = m_treeMap.find( treeHash );
337 if ( it == m_treeMap.end() ) // It doesn't exist!
338 { // Let's see into the THistSvc if somebody else has registered the TTree...
339
340 // Need to copy the strings as we will massage them from here on
341 std::string treeNameCopy = treeName;
342 std::string tDirCopy = tDir;
343 std::string streamCopy = stream;
344
345 // Massage the final string to book things
346 std::string bookingString = buildBookingString( treeNameCopy, tDirCopy, streamCopy );
347
348 TTree* treePointer(NULL);
349 if ( !((histSvc()->getTree(bookingString, treePointer)).isSuccess()) )
350 {
351 m_msg << MSG::WARNING
352 << "Problem retrieving the TTree with name " << treeNameCopy
353 << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
354 << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
355 return NULL;
356 }
357 // If we get to here, we actually found the TTree in the THistSvc.
358 // So let's add it to the local cache map and return its pointer
359 m_treeMap.insert( m_treeMap.end(), std::pair< const hash_t, TTree* >( treeHash, treePointer ) );
360 return treePointer;
361 }
362
363 // Return the pointer to the TTree that we got from the local cache map
364 return it->second;
365}
std::pair< StatusCode, TTree * > getTree(ITHistSvc &svc, const std::string &name)

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )
inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

308 {
309 // debug() << "updateVHKA for property " << p.name() << " " << p.toString()
310 // << " size: " << m_vhka.size() << endmsg;
311 for (auto &a : m_vhka) {
313 for (auto k : keys) {
314 k->setOwner(this);
315 }
316 }
317 }

Member Data Documentation

◆ m_barcode

std::vector<float>* TruthHitAnalysis::m_barcode {nullptr}
private

Definition at line 84 of file TruthHitAnalysis.h.

84{nullptr};

◆ m_detStore

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

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

◆ m_effMap

EffMap_t AthHistogramming::m_effMap
privateinherited

The map of histogram names to their pointers.

Definition at line 209 of file AthHistogramming.h.

◆ m_evtStore

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

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthCommonAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects
privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 108 of file AthCommonAlgorithm.h.

◆ m_graphMap

GraphMap_t AthHistogramming::m_graphMap
privateinherited

The map of TGraph names to their pointers.

Definition at line 223 of file AthHistogramming.h.

◆ m_h_barcode

TH1* TruthHitAnalysis::m_h_barcode {nullptr}
private

Definition at line 55 of file TruthHitAnalysis.h.

55{nullptr};

◆ m_h_n_generations

TH1* TruthHitAnalysis::m_h_n_generations {nullptr}
private

Definition at line 48 of file TruthHitAnalysis.h.

48{nullptr};

◆ m_h_n_part

TH1* TruthHitAnalysis::m_h_n_part {nullptr}
private

Definition at line 27 of file TruthHitAnalysis.h.

27{nullptr};

◆ m_h_n_part_prim

TH1* TruthHitAnalysis::m_h_n_part_prim {nullptr}
private

Definition at line 29 of file TruthHitAnalysis.h.

29{nullptr};

◆ m_h_n_part_sec

TH1* TruthHitAnalysis::m_h_n_part_sec {nullptr}
private

Definition at line 31 of file TruthHitAnalysis.h.

31{nullptr};

◆ m_h_n_vert

TH1* TruthHitAnalysis::m_h_n_vert {nullptr}
private

Some variables.

Definition at line 26 of file TruthHitAnalysis.h.

26{nullptr};

◆ m_h_n_vert_prim

TH1* TruthHitAnalysis::m_h_n_vert_prim {nullptr}
private

Definition at line 28 of file TruthHitAnalysis.h.

28{nullptr};

◆ m_h_n_vert_sec

TH1* TruthHitAnalysis::m_h_n_vert_sec {nullptr}
private

Definition at line 30 of file TruthHitAnalysis.h.

30{nullptr};

◆ m_h_part_eta

TH1* TruthHitAnalysis::m_h_part_eta {nullptr}
private

Definition at line 59 of file TruthHitAnalysis.h.

59{nullptr};

◆ m_h_part_p

TH1* TruthHitAnalysis::m_h_part_p {nullptr}
private

Definition at line 61 of file TruthHitAnalysis.h.

61{nullptr};

◆ m_h_part_pdgid

TH1* TruthHitAnalysis::m_h_part_pdgid {nullptr}
private

Definition at line 57 of file TruthHitAnalysis.h.

57{nullptr};

◆ m_h_part_pdgid_sec

TH1* TruthHitAnalysis::m_h_part_pdgid_sec {nullptr}
private

Definition at line 58 of file TruthHitAnalysis.h.

58{nullptr};

◆ m_h_part_phi

TH1* TruthHitAnalysis::m_h_part_phi {nullptr}
private

Definition at line 60 of file TruthHitAnalysis.h.

60{nullptr};

◆ m_h_part_status

TH1* TruthHitAnalysis::m_h_part_status {nullptr}
private

Definition at line 56 of file TruthHitAnalysis.h.

56{nullptr};

◆ m_h_truth_eta

TH1* TruthHitAnalysis::m_h_truth_eta {nullptr}
private

Definition at line 53 of file TruthHitAnalysis.h.

53{nullptr};

◆ m_h_truth_phi

TH1* TruthHitAnalysis::m_h_truth_phi {nullptr}
private

Definition at line 54 of file TruthHitAnalysis.h.

54{nullptr};

◆ m_h_truth_pt

TH1* TruthHitAnalysis::m_h_truth_pt {nullptr}
private

Definition at line 52 of file TruthHitAnalysis.h.

52{nullptr};

◆ m_h_truth_px

TH1* TruthHitAnalysis::m_h_truth_px {nullptr}
private

Definition at line 49 of file TruthHitAnalysis.h.

49{nullptr};

◆ m_h_truth_py

TH1* TruthHitAnalysis::m_h_truth_py {nullptr}
private

Definition at line 50 of file TruthHitAnalysis.h.

50{nullptr};

◆ m_h_truth_pz

TH1* TruthHitAnalysis::m_h_truth_pz {nullptr}
private

Definition at line 51 of file TruthHitAnalysis.h.

51{nullptr};

◆ m_h_vtx_prim_r

TH1* TruthHitAnalysis::m_h_vtx_prim_r {nullptr}
private

Definition at line 43 of file TruthHitAnalysis.h.

43{nullptr};

◆ m_h_vtx_prim_x

TH1* TruthHitAnalysis::m_h_vtx_prim_x {nullptr}
private

Definition at line 40 of file TruthHitAnalysis.h.

40{nullptr};

◆ m_h_vtx_prim_xy

TH2* TruthHitAnalysis::m_h_vtx_prim_xy {nullptr}
private

Definition at line 44 of file TruthHitAnalysis.h.

44{nullptr};

◆ m_h_vtx_prim_y

TH1* TruthHitAnalysis::m_h_vtx_prim_y {nullptr}
private

Definition at line 41 of file TruthHitAnalysis.h.

41{nullptr};

◆ m_h_vtx_prim_z

TH1* TruthHitAnalysis::m_h_vtx_prim_z {nullptr}
private

Definition at line 42 of file TruthHitAnalysis.h.

42{nullptr};

◆ m_h_vtx_prim_zr

TH2* TruthHitAnalysis::m_h_vtx_prim_zr {nullptr}
private

Definition at line 45 of file TruthHitAnalysis.h.

45{nullptr};

◆ m_h_vtx_proc_r

TH1* TruthHitAnalysis::m_h_vtx_proc_r {nullptr}
private

Definition at line 39 of file TruthHitAnalysis.h.

39{nullptr};

◆ m_h_vtx_proc_x

TH1* TruthHitAnalysis::m_h_vtx_proc_x {nullptr}
private

Definition at line 36 of file TruthHitAnalysis.h.

36{nullptr};

◆ m_h_vtx_proc_y

TH1* TruthHitAnalysis::m_h_vtx_proc_y {nullptr}
private

Definition at line 37 of file TruthHitAnalysis.h.

37{nullptr};

◆ m_h_vtx_proc_z

TH1* TruthHitAnalysis::m_h_vtx_proc_z {nullptr}
private

Definition at line 38 of file TruthHitAnalysis.h.

38{nullptr};

◆ m_h_vtx_r

TH1* TruthHitAnalysis::m_h_vtx_r {nullptr}
private

Definition at line 35 of file TruthHitAnalysis.h.

35{nullptr};

◆ m_h_vtx_sec_xy

TH2* TruthHitAnalysis::m_h_vtx_sec_xy {nullptr}
private

Definition at line 46 of file TruthHitAnalysis.h.

46{nullptr};

◆ m_h_vtx_sec_zr

TH2* TruthHitAnalysis::m_h_vtx_sec_zr {nullptr}
private

Definition at line 47 of file TruthHitAnalysis.h.

47{nullptr};

◆ m_h_vtx_x

TH1* TruthHitAnalysis::m_h_vtx_x {nullptr}
private

Definition at line 32 of file TruthHitAnalysis.h.

32{nullptr};

◆ m_h_vtx_y

TH1* TruthHitAnalysis::m_h_vtx_y {nullptr}
private

Definition at line 33 of file TruthHitAnalysis.h.

33{nullptr};

◆ m_h_vtx_z

TH1* TruthHitAnalysis::m_h_vtx_z {nullptr}
private

Definition at line 34 of file TruthHitAnalysis.h.

34{nullptr};

◆ m_histMap

HistMap_t AthHistogramming::m_histMap
privateinherited

The map of histogram names to their pointers.

Definition at line 202 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_msg

MsgStream AthHistogramming::m_msg
privateinherited

Cached Message Stream.

Definition at line 249 of file AthHistogramming.h.

◆ m_name

std::string AthHistogramming::m_name
privateinherited

Instance name.

Definition at line 246 of file AthHistogramming.h.

◆ m_ntupleFileName

Gaudi::Property<std::string> TruthHitAnalysis::m_ntupleFileName {this, "NtupleFileName","/TruthHitAnalysis/"}
private

Definition at line 91 of file TruthHitAnalysis.h.

91{this, "NtupleFileName","/TruthHitAnalysis/"};

◆ m_path

Gaudi::Property<std::string> TruthHitAnalysis::m_path {this, "HistPath","/TruthHitAnalysis/"}
private

Definition at line 90 of file TruthHitAnalysis.h.

90{this, "HistPath","/TruthHitAnalysis/"};

◆ m_pdgid

std::vector<float>* TruthHitAnalysis::m_pdgid {nullptr}
private

Definition at line 86 of file TruthHitAnalysis.h.

86{nullptr};

◆ m_prefix

std::string AthHistogramAlgorithm::m_prefix
privateinherited

Name of the ROOT output stream (file).

Definition at line 88 of file AthHistogramAlgorithm.h.

◆ m_readKey

SG::ReadHandleKey<McEventCollection> TruthHitAnalysis::m_readKey {this, "InputKey", "TruthEvent"}
private

Definition at line 92 of file TruthHitAnalysis.h.

92{this, "InputKey", "TruthEvent"};

◆ m_rootDir

std::string AthHistogramAlgorithm::m_rootDir
privateinherited

Name of the ROOT directory.

Definition at line 91 of file AthHistogramAlgorithm.h.

◆ m_status

std::vector<float>* TruthHitAnalysis::m_status {nullptr}
private

Definition at line 85 of file TruthHitAnalysis.h.

85{nullptr};

◆ m_streamName

std::string AthHistogramming::m_streamName
privateinherited

Name of the ROOT output stream (file).

Definition at line 227 of file AthHistogramming.h.

◆ m_tree

TTree* TruthHitAnalysis::m_tree {nullptr}
private

Definition at line 88 of file TruthHitAnalysis.h.

88{nullptr};

◆ m_treeMap

TreeMap_t AthHistogramming::m_treeMap
privateinherited

The map of TTree names to their pointers.

Definition at line 216 of file AthHistogramming.h.

◆ m_truth_eta

std::vector<float>* TruthHitAnalysis::m_truth_eta {nullptr}
private

Definition at line 82 of file TruthHitAnalysis.h.

82{nullptr};

◆ m_truth_phi

std::vector<float>* TruthHitAnalysis::m_truth_phi {nullptr}
private

Definition at line 83 of file TruthHitAnalysis.h.

83{nullptr};

◆ m_truth_pt

std::vector<float>* TruthHitAnalysis::m_truth_pt {nullptr}
private

Definition at line 81 of file TruthHitAnalysis.h.

81{nullptr};

◆ m_truth_px

std::vector<float>* TruthHitAnalysis::m_truth_px {nullptr}
private

Definition at line 78 of file TruthHitAnalysis.h.

78{nullptr};

◆ m_truth_py

std::vector<float>* TruthHitAnalysis::m_truth_py {nullptr}
private

Definition at line 79 of file TruthHitAnalysis.h.

79{nullptr};

◆ m_truth_pz

std::vector<float>* TruthHitAnalysis::m_truth_pz {nullptr}
private

Definition at line 80 of file TruthHitAnalysis.h.

80{nullptr};

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

◆ m_vtx_barcode

std::vector<float>* TruthHitAnalysis::m_vtx_barcode {nullptr}
private

Definition at line 67 of file TruthHitAnalysis.h.

67{nullptr};

◆ m_vtx_prim_barcode

std::vector<float>* TruthHitAnalysis::m_vtx_prim_barcode {nullptr}
private

Definition at line 77 of file TruthHitAnalysis.h.

77{nullptr};

◆ m_vtx_prim_r

std::vector<float>* TruthHitAnalysis::m_vtx_prim_r {nullptr}
private

Definition at line 76 of file TruthHitAnalysis.h.

76{nullptr};

◆ m_vtx_prim_x

std::vector<float>* TruthHitAnalysis::m_vtx_prim_x {nullptr}
private

Definition at line 73 of file TruthHitAnalysis.h.

73{nullptr};

◆ m_vtx_prim_y

std::vector<float>* TruthHitAnalysis::m_vtx_prim_y {nullptr}
private

Definition at line 74 of file TruthHitAnalysis.h.

74{nullptr};

◆ m_vtx_prim_z

std::vector<float>* TruthHitAnalysis::m_vtx_prim_z {nullptr}
private

Definition at line 75 of file TruthHitAnalysis.h.

75{nullptr};

◆ m_vtx_proc_barcode

std::vector<float>* TruthHitAnalysis::m_vtx_proc_barcode {nullptr}
private

Definition at line 72 of file TruthHitAnalysis.h.

72{nullptr};

◆ m_vtx_proc_r

std::vector<float>* TruthHitAnalysis::m_vtx_proc_r {nullptr}
private

Definition at line 71 of file TruthHitAnalysis.h.

71{nullptr};

◆ m_vtx_proc_x

std::vector<float>* TruthHitAnalysis::m_vtx_proc_x {nullptr}
private

Definition at line 68 of file TruthHitAnalysis.h.

68{nullptr};

◆ m_vtx_proc_y

std::vector<float>* TruthHitAnalysis::m_vtx_proc_y {nullptr}
private

Definition at line 69 of file TruthHitAnalysis.h.

69{nullptr};

◆ m_vtx_proc_z

std::vector<float>* TruthHitAnalysis::m_vtx_proc_z {nullptr}
private

Definition at line 70 of file TruthHitAnalysis.h.

70{nullptr};

◆ m_vtx_r

std::vector<float>* TruthHitAnalysis::m_vtx_r {nullptr}
private

Definition at line 66 of file TruthHitAnalysis.h.

66{nullptr};

◆ m_vtx_x

std::vector<float>* TruthHitAnalysis::m_vtx_x {nullptr}
private

Definition at line 63 of file TruthHitAnalysis.h.

63{nullptr};

◆ m_vtx_y

std::vector<float>* TruthHitAnalysis::m_vtx_y {nullptr}
private

Definition at line 64 of file TruthHitAnalysis.h.

64{nullptr};

◆ m_vtx_z

std::vector<float>* TruthHitAnalysis::m_vtx_z {nullptr}
private

Definition at line 65 of file TruthHitAnalysis.h.

65{nullptr};

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