ATLAS Offline Software
Loading...
Searching...
No Matches
CP::AsgViewFromSelectionAlg Class Referencefinal

create a view container based on selection decorations More...

#include <AsgViewFromSelectionAlg.h>

Inheritance diagram for CP::AsgViewFromSelectionAlg:
Collaboration diagram for CP::AsgViewFromSelectionAlg:

Public Types

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

Public Member Functions

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

Protected Member Functions

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

Private Types

typedef ServiceHandle< 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

template<typename Type>
StatusCode executeTemplate (const CP::SystematicSet &sys)
 the templated version of execute for a single systematic
StatusCode executeFindType (const CP::SystematicSet &sys)
 the version of execute to find the type
StatusCode executeMissing (const CP::SystematicSet &sys)
 The version of execute for missing input containers.
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
 specialization for handling Gaudi::Property<SG::VarHandleKey>
void buildBookingString (std::string &bookingString, std::string &histName, std::string &tDir, std::string &stream, bool usePrefixPostfix=false)
 Method to build individual booking string.
void myReplace (std::string &str, const std::string &oldStr, const std::string &newStr)
 Helper method to replace sub-string.
hash_t hash (const std::string &histName) const
 Method to calculate a 32-bit hash from a string.

Private Attributes

SysListHandle m_systematicsList {this}
 the systematics list we run
SysReadHandle< xAOD::IParticleContainerm_inputHandle
 the input collection we run on
SysWriteHandle< xAOD::IParticleContainerm_outputHandle
 the output view container we produce
Gaudi::Property< std::vector< std::string > > m_selection {this, "selection", {}, "the list of selection decorations"}
Gaudi::Property< std::vector< SelectionType > > m_ignore {this, "ignore", {}, "the list of cuts to *ignore* for each selection"}
Gaudi::Property< boolm_sortPt {this, "sortPt", false, "whether to sort objects in pt"}
 Sort the output (view) container by pT.
Gaudi::Property< boolm_allowMissing {this, "allowMissing", false, "Allow the input container to be missing"}
 Allow the input container to be missing.
Gaudi::Property< boolm_deepCopy {this, "deepCopy", false, "perform a deep copy"}
 Perform a deep copy for creating the output container.
Gaudi::Property< std::size_t > m_sizeLimit {this, "sizeLimit", std::numeric_limits<std::size_t>::max(), "the limit on the size of the output container"}
std::vector< std::pair< std::unique_ptr< ISelectionReadAccessor >, SelectionType > > m_accessors
 the list of accessors and cut ignore list
StatusCode(AsgViewFromSelectionAlg::* m_function )(const CP::SystematicSet &sys)
MetaStore_t m_inputMetaStore
 Object accessing the input metadata store.
MetaStore_t m_outputMetaStore
 Object accessing the output metadata store.
bool m_hasFileExecute {false}
 the value of hasFileExecute
bool m_hasBeginInputFile {false}
 the value of hasBeginInputFile
bool m_hasEndInputFile {false}
 the value of hasEndInputFile
ServiceHandle< ITHistSvc > m_histSvc
 Default constructor: AthHistogramAlgorithm();.
std::string m_prefix
 Name of the ROOT output stream (file).
std::string m_rootDir
 Name of the ROOT directory.
std::string m_histNamePrefix
 The prefix for the histogram THx name.
std::string m_histNamePostfix
 The postfix for the histogram THx name.
std::string m_histTitlePrefix
 The prefix for the histogram THx title.
std::string m_histTitlePostfix
 The postfix for the histogram THx title.
DataObjIDColl m_extendedExtraObjects
StoreGateSvc_t m_evtStore
 Pointer to StoreGate (event store by default).
StoreGateSvc_t m_detStore
 Pointer to StoreGate (detector store by default).
std::vector< SG::VarHandleKeyArray * > m_vhka
bool m_varHandleArraysDeclared
HistMap_t m_histMap
 The map of histogram names to their pointers.
EffMap_t m_effMap
 The map of histogram names to their pointers.
TreeMap_t m_treeMap
 The map of TTree names to their pointers.
GraphMap_t m_graphMap
 The map of TGraph names to their pointers.
std::string m_streamName
 Name of the ROOT output stream (file).
std::string m_name
 Instance name.
MsgStream m_msg
 Cached Message Stream.

Detailed Description

create a view container based on selection decorations

This is a generic algorithm that works for all object types to read our standard selection decorations and create a view container. This avoids the need for the algorithm/tool to read the selection decoration on the input, instead it can just assume that all its input objects are meant to be processed.

Definition at line 31 of file AsgViewFromSelectionAlg.h.

Member Typedef Documentation

◆ ConstMetaStorePtr_t

Definition at line 111 of file AnaAlgorithm.h.

◆ EffMap_t

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

Typedef for convenience.

Definition at line 207 of file AthHistogramming.h.

◆ GraphMap_t

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

Typedef for convenience.

Definition at line 221 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 200 of file AthHistogramming.h.

◆ MetaStore_t

Type of the metadata store variable in Athena.

Definition at line 546 of file AnaAlgorithm.h.

◆ MetaStorePtr_t

Type of the metadata store pointer in standalone mode.

Definition at line 110 of file AnaAlgorithm.h.

◆ StoreGateSvc_t

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

Definition at line 388 of file AthCommonDataStore.h.

◆ TreeMap_t

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

Typedef for convenience.

Definition at line 214 of file AthHistogramming.h.

Member Function Documentation

◆ AnaAlgorithm()

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

the standard constructor

Definition at line 89 of file AnaAlgorithm.cxx.

47 : AsgComponent (name)
50#else
51 : AthHistogramAlgorithm (name, pSvcLocator)
52 , m_inputMetaStore ("StoreGateSvc/InputMetaDataStore", name)
53 , m_outputMetaStore ("StoreGateSvc/MetaDataStore", name)
54#endif
55 {
56#ifdef XAOD_STANDALONE
57 declareProperty ("RootStreamName", m_treeStreamName = "ANALYSIS",
58 "Name of the stream to put trees into");
59#endif
60
61 ANA_MSG_DEBUG ("AnaAlgorithm: " << name);
62 }
#define ANA_MSG_DEBUG(xmsg)
Macro printing debug messages.
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T, V, H > &t)
AthHistogramAlgorithm(const std::string &name, ISvcLocator *pSvcLocator)
Constructor with parameters:
MetaStore_t m_outputMetaStore
Object accessing the output metadata store.
MetaStore_t m_inputMetaStore
Object accessing the input metadata store.
@ InputStore
This store is used to access the input metadata.
Definition SgEventMeta.h:50
@ OutputStore
This store is used to access the output metadata.
Definition SgEventMeta.h:51

◆ beginInputFile()

StatusCode EL::AnaAlgorithm::beginInputFile ( )
protectedinherited

perform the action for the beginning of an input file

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

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

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

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

Definition at line 350 of file AnaAlgorithm.cxx.

352 {
353 return StatusCode::SUCCESS;
354 }

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

338{
339 // We need to create a non-const clone
340 TEfficiency* effClone = dynamic_cast< TEfficiency* >( eff.Clone() );
341 if ( !effClone ) {
342 m_msg << MSG::ERROR << "Couldn't create a TEfficiency clone" << endmsg;
343 return StatusCode::FAILURE;
344 }
345 return this->book( *effClone, tDir, stream );
346}
#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 305 of file AthHistogramming.h.

306{
307 // We need to create a non-const clone
308 TH1* histClone = dynamic_cast< TH1* >( hist.Clone() );
309 if ( !histClone ) {
310 m_msg << MSG::ERROR << "Couldn't create a TH1 clone" << endmsg;
311 return StatusCode::FAILURE;
312 }
313 return this->book( *histClone, tDir, stream );
314}
TH1 * hist(const std::string &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 405 of file AthHistogramming.h.

406{
407 // Call the other Book method and see if it returns a valid pointer
408 TTree* treePointer = this->bookGetPointer( treeRef, tDir, stream );
409 if ( treePointer )
410 {
411 return StatusCode::SUCCESS;
412 }
413 else
414 {
415 return StatusCode::FAILURE;
416 }
417}
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 358 of file AthHistogramming.h.

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

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

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

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

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

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

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

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

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

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

413{
414 // Get a pointer
415 const TGraph* graphPointer = &graphRef;
416
417 // Check that we got a valid pointer
418 if ( !graphPointer )
419 {
420 m_msg << MSG::WARNING
421 << "We got an invalid TGraph pointer in the BookGetPointer(TGraph*) method of the class" << m_name
422 << "!" << endmsg;
423 return NULL;
424 }
425
426 // Modify the name and title according to the prefixes of this classes instance
427 std::string graphName = graphPointer->GetName();
428 const std::string graphTitle = graphPointer->GetTitle();
429
430 // Check if the hash for this graphName already exists, i.e., if we have a hash collision
431 const hash_t graphHash = this->hash(graphName);
432 GraphMap_t::const_iterator it = m_graphMap.find( graphHash );
433 if ( it != m_graphMap.end() ) // It does exist!
434 {
435 m_msg << MSG::WARNING
436 << "Detected a hash collision. The hash for the TGraph with name=" << graphName
437 << " already exists and points to a TGraph with name=" << it->second->GetName()
438 << " NOT going to book the new histogram and returning a NULL pointer!" << endmsg;
439 return NULL;
440 }
441
442 // Create a clone that has the new name
443 TGraph* graphClone = dynamic_cast< TGraph* >( graphPointer->Clone((m_histNamePrefix+graphName+m_histNamePostfix).c_str()) );
444 if( !graphClone )
445 {
446 m_msg << MSG::WARNING
447 << "We couldn't clone the TGraph in the BookGetPointer(TGraph&) method of the class" << m_name
448 << "!" << endmsg;
449 return NULL;
450 }
451 graphClone->SetTitle ((m_histTitlePrefix+graphTitle+m_histTitlePostfix).c_str());
452
453 // Massage the final string to book things
454 std::string bookingString("");
455 this->buildBookingString( bookingString, graphName, tDir, stream );
456
457 // Register the TGraph into the THistSvc
458 if ( !((histSvc()->regGraph(bookingString, graphClone)).isSuccess()) )
459 {
460 m_msg << MSG::WARNING
461 << "Problem registering TGraph with name " << graphName
462 << ", title " << graphTitle
463 << " in " << m_name << "!" << endmsg;
464 return NULL;
465 }
466
467 // Also register it in the local map of string to pointer
468 m_graphMap.insert( m_graphMap.end(), std::pair< const hash_t, TGraph* >( graphHash, graphClone ) );
469
470 return graphClone;
471}
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.
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.
void buildBookingString(std::string &bookingString, std::string &histName, std::string &tDir, std::string &stream, bool usePrefixPostfix=false)
Method to build individual booking string.
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 262 of file AthHistogramming.h.

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

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

298{
299 // Get a pointer
300 const TTree* treePointer = &treeRef;
301
302 // Check that we got a valid pointer
303 if ( !treePointer )
304 {
305 m_msg << MSG::WARNING
306 << "We got an invalid TTree pointer in the BookGetPointer(TTree*) method of the class" << m_name
307 << "!" << endmsg;
308 return NULL;
309 }
310
311 // Modify the name and title according to the prefixes of this classes instance
312 std::string treeName = treePointer->GetName();
313 const std::string treeTitle = treePointer->GetTitle();
314
315 // Check if the hash for this treeName already exists, i.e., if we have a hash collision
316 const hash_t treeHash = this->hash(treeName);
317 TreeMap_t::const_iterator it = m_treeMap.find( treeHash );
318 if ( it != m_treeMap.end() ) // It does exist!
319 {
320 m_msg << MSG::WARNING
321 << "Detected a hash collision. The hash for the TTree with name=" << treeName
322 << " already exists and points to a TTree with name=" << it->second->GetName()
323 << " NOT going to book the new histogram and returning a NULL pointer!" << endmsg;
324 return NULL;
325 }
326
327 // Create a clone that has the new name
328 TTree* treeClone = dynamic_cast< TTree* >( treePointer->Clone(treeName.c_str()) );
329 if( !treeClone )
330 {
331 m_msg << MSG::WARNING
332 << "We couldn't clone the TTree in the BookGetPointer(TTree&) method of the class" << m_name
333 << "!" << endmsg;
334 return NULL;
335 }
336 treeClone->SetTitle (treeTitle.c_str());
337
338 // Massage the final string to book things
339 std::string bookingString("");
340 this->buildBookingString( bookingString, treeName, tDir, stream );
341
342 // Register the TTree into the THistSvc
343 if ( !((histSvc()->regTree(bookingString, treeClone)).isSuccess()) )
344 {
345 m_msg << MSG::WARNING
346 << "Problem registering TTree with name " << treeName
347 << ", title " << treeTitle
348 << " in " << m_name << "!" << endmsg;
349 return NULL;
350 }
351
352 // Also register it in the local map of string to pointer
353 m_treeMap.insert( m_treeMap.end(), std::pair< const hash_t, TTree* >( treeHash, treeClone ) );
354
355 return treeClone;
356}
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 131 of file AthHistogramming.cxx.

132{
133 // Modify the name and title according to the prefixes of this classes instance
134 std::string effName(effRef.GetName());
135 const std::string effTitle(effRef.GetTitle());
136 std::string bookingString("");
137
138 this->buildBookingString( bookingString, effName, tDir, stream );
139 effRef.SetTitle((m_histTitlePrefix+effTitle+m_histTitlePostfix).c_str() );
140 effRef.SetName(effName.c_str());
141
142 // Check if the hash for this effName already exists, i.e., if we have a hash collision
143 const hash_t effHash = this->hash(effName);
144 EffMap_t::const_iterator it = m_effMap.find( effHash );
145 if ( it != m_effMap.end() ) // It does exist!
146 {
147 m_msg << MSG::WARNING
148 << "Detected a hash collision. The hash for the TEfficiency with name=" << effName
149 << " already exists and points to a TEfficiency with name=" << it->second->GetName()
150 << " NOT going to book the new TEfficiency and returning a NULL pointer!" << endmsg;
151 return NULL;
152 }
153
154 // Set the new name and title for the TEfficiency, based on the prefixes that the user set for this class instance
155 // Create a clone that has the new name
156
157 // Massage the final string to book things
158
159 // Register the TEfficiency into the THistSvc
160 if ( !((histSvc()->regEfficiency(bookingString, &effRef)).isSuccess()) )
161 {
162 m_msg << MSG::WARNING
163 << "Problem registering TEfficiency with name " << effName
164 << ", name prefix " << m_histNamePrefix
165 << ", title " << effTitle
166 << ", tile prefix " << m_histTitlePrefix
167 << ", and tile postfix " << m_histTitlePostfix
168 << " in " << m_name << "!" << endmsg;
169 return NULL;
170 }
171
172 // Also register it in the local map of string to pointer
173 m_effMap.insert( m_effMap.end(), std::pair< const hash_t, TEfficiency* >( effHash, &effRef ) );
174
175 return &effRef;
176}
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 295 of file AthHistogramming.h.

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

◆ 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 // Modify the name and title according to the prefixes of this classes instance
86 std::string histName(histRef.GetName());
87 const std::string histTitle(histRef.GetTitle());
88 std::string bookingString("");
89
90 this->buildBookingString( bookingString, histName, tDir, stream );
91 histRef.SetTitle((m_histTitlePrefix+histTitle+m_histTitlePostfix).c_str() );
92 histRef.SetName(histName.c_str());
93
94 // Check if the hash for this histName already exists, i.e., if we have a hash collision
95 const hash_t histHash = this->hash(histName);
96 HistMap_t::const_iterator it = m_histMap.find( histHash );
97 if ( it != m_histMap.end() ) // It does exist!
98 {
99 m_msg << MSG::WARNING
100 << "Detected a hash collision. The hash for the histogram with name=" << histName
101 << " already exists and points to a histogram with name=" << it->second->GetName()
102 << " NOT going to book the new histogram and returning a NULL pointer!" << endmsg;
103 return NULL;
104 }
105
106 // Set the new name and title for the histogram, based on the prefixes that the user set for this class instance
107 // Create a clone that has the new name
108
109 // Massage the final string to book things
110
111 // Register the histogram into the THistSvc
112 if ( !((histSvc()->regHist(bookingString, &histRef)).isSuccess()) )
113 {
114 m_msg << MSG::WARNING
115 << "Problem registering histogram with name " << histName
116 << ", name prefix " << m_histNamePrefix
117 << ", title " << histTitle
118 << ", tile prefix " << m_histTitlePrefix
119 << ", and tile postfix " << m_histTitlePostfix
120 << " in " << m_name << "!" << endmsg;
121 return NULL;
122 }
123
124 // Also register it in the local map of string to pointer
125 m_histMap.insert( m_histMap.end(), std::pair< const hash_t, TH1* >( histHash, &histRef ) );
126
127 return &histRef;
128}
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 274 of file AthHistogramming.h.

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

◆ buildBookingString()

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

Method to build individual booking string.

Definition at line 545 of file AthHistogramming.cxx.

550{
551 // Massage the final string to book things
552 if(tDir.empty()) tDir = m_rootDir;
553 size_t pos = histName.rfind('/');
554 if(pos != std::string::npos){
555 tDir+='/';
556 tDir.append(histName, 0,pos);
557 histName.erase(0,pos+1);
558 };
559 if(stream.empty()) stream = m_streamName;
560
561 if(usePrefixPostfix){
562 bookingString = "/"+stream+"/"+tDir+"/"+m_histNamePrefix+histName+m_histNamePostfix;
563 } else {
564 bookingString = "/"+stream+"/"+tDir+"/"+histName;
565 }
566 while(bookingString.find("//") != std::string::npos){
567 this->myReplace(bookingString,"//","/");
568 }
569
570 return;
571}
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< 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< 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< 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 235 of file AthHistogramming.cxx.

236{
237 // Build a 32 bit hash out of the name
238 const hash_t effHash = this->hash(effName);
239
240 // See if this entry exists in the map
241 EffMap_t::const_iterator it = m_effMap.find( effHash );
242 if ( it == m_effMap.end() ) // It doesn't exist!
243 { // Let's see into the THistSvc if somebody else has registered the TEfficiency...
244
245 // Need to copy the strings as we will massage them from here on
246 std::string effNameCopy = effName;
247 std::string tDirCopy = tDir;
248 std::string streamCopy = stream;
249
250 // Massage the final string to book things
251 std::string bookingString("");
252 this->buildBookingString( bookingString, effNameCopy, tDirCopy, streamCopy ,false);
253
254 TEfficiency* effPointer(NULL);
255 if ( !((histSvc()->getEfficiency(bookingString, effPointer)).isSuccess()) )
256 {
257 // Massage the final string to book things
258 std::string bookingString("");
259 this->buildBookingString( bookingString, effNameCopy, tDirCopy, streamCopy, true );
260
261 if ( !((histSvc()->getEfficiency(bookingString, effPointer)).isSuccess()) )
262 {
263 m_msg << MSG::WARNING
264 << "Problem retrieving the TEfficiency with name (including pre- and post-fixes) "
265 << m_histNamePrefix + effNameCopy + m_histNamePostfix
266 << " or with name " << effNameCopy
267 << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
268 << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
269 return NULL;
270 }
271 // If we get to here, we actually found the TEfficiency in the THistSvc.
272 // So let's add it to the local cache map and return its pointer
273 m_effMap.insert( m_effMap.end(), std::pair< const hash_t, TEfficiency* >( effHash, effPointer ) );
274 return effPointer;
275 }
276 // If we get to here, we actually found the TEfficiency in the THistSvc.
277 // So let's add it to the local cache map and return its pointer
278 m_effMap.insert( m_effMap.end(), std::pair< const hash_t, TEfficiency* >( effHash, effPointer ) );
279 return effPointer;
280 }
281
282 // Return the pointer to the TEfficiency that we got from the local cache map
283 return it->second;
284}
std::pair< StatusCode, TEfficiency * > getEfficiency(ITHistSvc &svc, const std::string &name)

◆ endInputFile()

StatusCode EL::AnaAlgorithm::endInputFile ( )
protectedinherited

perform the action for the end of an input file

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

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

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

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

Definition at line 358 of file AnaAlgorithm.cxx.

360 {
361 return StatusCode::SUCCESS;
362 }

◆ evtStore()

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

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

Definition at line 85 of file AthCommonDataStore.h.

◆ execute()

StatusCode CP::AsgViewFromSelectionAlg::execute ( )
override

Definition at line 218 of file AsgViewFromSelectionAlg.cxx.

220 {
221 for (const auto& sys : m_systematicsList.systematicsVector())
222 {
223 ANA_CHECK ((this->*m_function) (sys));
224 }
225 return StatusCode::SUCCESS;
226 }
#define ANA_CHECK(EXP)
check whether the given expression was successful
StatusCode(AsgViewFromSelectionAlg::* m_function)(const CP::SystematicSet &sys)
SysListHandle m_systematicsList
the systematics list we run

◆ executeFindType()

StatusCode CP::AsgViewFromSelectionAlg::executeFindType ( const CP::SystematicSet & sys)
private

the version of execute to find the type

Definition at line 104 of file AsgViewFromSelectionAlg.cxx.

106 {
107 if( m_allowMissing ) {
108 const std::string& name = m_inputHandle.getName( sys );
111 return StatusCode::SUCCESS;
112 }
113 }
114
115 const xAOD::IParticleContainer *input = nullptr;
116 ANA_CHECK (m_inputHandle.retrieve (input, sys));
117
118 if (dynamic_cast<const xAOD::ElectronContainer*> (input))
119 {
120 m_function =
122 }
123 else if (dynamic_cast<const xAOD::PhotonContainer*> (input))
124 {
125 m_function =
127 }
128 else if (dynamic_cast<const xAOD::JetContainer*> (input))
129 {
130 m_function =
132 }
133 else if (dynamic_cast<const xAOD::MuonContainer*> (input)) {
134 m_function =
136 }
137 else if (dynamic_cast<const xAOD::TauJetContainer*> (input))
138 {
139 m_function =
141 }
142 else if (dynamic_cast<const xAOD::DiTauJetContainer*> (input))
143 {
144 m_function =
146 }
147 else if (dynamic_cast<const xAOD::TrackParticleContainer*> (input))
148 {
149 m_function =
151 }
152 else if (dynamic_cast<const xAOD::TruthParticleContainer*> (input))
153 {
154 m_function =
156 }
157 else
158 {
159 ANA_MSG_ERROR ("unknown type contained in AsgViewFromSelectionAlg, please extend it");
160 return StatusCode::FAILURE;
161 }
162
163 return (this->*m_function) (sys);
164 }
#define ANA_MSG_ERROR(xmsg)
Macro printing error messages.
StatusCode executeTemplate(const CP::SystematicSet &sys)
the templated version of execute for a single systematic
SysReadHandle< xAOD::IParticleContainer > m_inputHandle
the input collection we run on
Gaudi::Property< bool > m_allowMissing
Allow the input container to be missing.
StatusCode executeMissing(const CP::SystematicSet &sys)
The version of execute for missing input containers.
bool contains(const std::string &s, const std::string &regx)
does a string contain the substring
Definition hcg.cxx:116
PhotonContainer_v1 PhotonContainer
Definition of the current "photon container version".
ElectronContainer_v1 ElectronContainer
Definition of the current "electron container version".
DiTauJetContainer_v1 DiTauJetContainer
Definition of the current DiTauJet container version.
TrackParticleContainer_v1 TrackParticleContainer
Definition of the current "TrackParticle container version".
JetContainer_v1 JetContainer
Definition of the current "jet container version".
TauJetContainer_v3 TauJetContainer
Definition of the current "taujet container version".
MuonContainer_v1 MuonContainer
Definition of the current "Muon container version".
TruthParticleContainer_v1 TruthParticleContainer
Declare the latest version of the truth particle container.
DataVector< IParticle > IParticleContainer
Simple convenience declaration of IParticleContainer.

◆ executeMissing()

StatusCode CP::AsgViewFromSelectionAlg::executeMissing ( const CP::SystematicSet & sys)
private

The version of execute for missing input containers.

Definition at line 168 of file AsgViewFromSelectionAlg.cxx.

170 {
171 return StatusCode::SUCCESS;
172 }

◆ executeTemplate()

template<typename Type>
StatusCode CP::AsgViewFromSelectionAlg::executeTemplate ( const CP::SystematicSet & sys)
private

the templated version of execute for a single systematic

Definition at line 33 of file AsgViewFromSelectionAlg.cxx.

35 {
36 const Type *input = nullptr;
37 ANA_CHECK (evtStore()->retrieve (input, m_inputHandle.getName (sys)));
38 auto viewCopy = std::make_unique<ConstDataVector<Type>> (SG::VIEW_ELEMENTS);
39 for (const auto particle : *input)
40 {
41 bool keep = true;
42 for (const auto& accessor : m_accessors)
43 {
44 if ((accessor.first->getBits (*particle) | accessor.second) != selectionAccept())
45 {
46 keep = false;
47 break;
48 }
49 }
50 if (keep)
51 {
52 viewCopy->push_back (particle);
53 }
54 }
55
56 if (m_sortPt)
57 {
58 std::sort (viewCopy->begin(), viewCopy->end(), [] (const xAOD::IParticle *a, const xAOD::IParticle *b) {return CxxUtils::fpcompare::greater (a->pt(), b->pt());});
59 }
60
61 // If anyone might be concerned about efficiency here, this will
62 // add/sort a couple more entries than needed only to remove them
63 // from the vector afterwards, so there is a slight efficiency
64 // loss. However, this option is not expected to be used very
65 // often and the algorithm is still expected to run quickly, so I
66 // decided to keep the code above simpler and just do this as a
67 // separate step, instead of trying to optimize this by
68 // integrating it with the code above.
69 if (viewCopy->size() > m_sizeLimit)
70 viewCopy->resize (m_sizeLimit);
71
72 // In case we want to output a view copy, do that here.
73 if (!m_deepCopy)
74 {
75 ANA_CHECK (evtStore()->record (viewCopy.release(),
76 m_outputHandle.getName (sys)));
77 return StatusCode::SUCCESS;
78 }
79
80 // Apparently we want to make a deep copy. So set that one up.
81 auto deepCopy = std::make_unique<Type> ();
82 auto aux = std::make_unique<xAOD::AuxContainerBase> ();
83 deepCopy->setStore (aux.get());
84 deepCopy->reserve (viewCopy->size());
85 for (auto particle : *viewCopy)
86 {
87 typename Type::value_type pcopy = new typename Type::base_value_type();
88 deepCopy->push_back (pcopy);
89 *pcopy = *particle;
90 }
91
92 // Record the deep copy into the event store.
93 ANA_CHECK (evtStore()->record (deepCopy.release(),
94 m_outputHandle.getName (sys)));
95 ANA_CHECK (evtStore()->record (aux.release(),
96 m_outputHandle.getName (sys) + "Aux."));
97
98 return StatusCode::SUCCESS;
99 }
static Double_t a
RootType Type
Gaudi::Property< bool > m_sortPt
Sort the output (view) container by pT.
Gaudi::Property< std::size_t > m_sizeLimit
SysWriteHandle< xAOD::IParticleContainer > m_outputHandle
the output view container we produce
Gaudi::Property< bool > m_deepCopy
Perform a deep copy for creating the output container.
std::vector< std::pair< std::unique_ptr< ISelectionReadAccessor >, SelectionType > > m_accessors
the list of accessors and cut ignore list
constexpr SelectionType selectionAccept()
the selection decoration to apply for objects that are selected
@ VIEW_ELEMENTS
this data object is a view, it does not own its elmts
constexpr ParticleHypothesis particle[PARTICLEHYPOTHESES]
the array of masses
void sort(typename DataModel_detail::iterator< DVL > beg, typename DataModel_detail::iterator< DVL > end)
Specialization of sort for DataVector/List.
const AccessorWrapper< T > * accessor(xAOD::JetAttribute::AttributeID id)
Returns an attribute accessor corresponding to an AttributeID.

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps)
protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const
overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 50 of file AthAlgorithm.cxx.

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

◆ fileExecute()

StatusCode EL::AnaAlgorithm::fileExecute ( )
protectedinherited

perform the action exactly once for each file in the dataset

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

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

\warn The user should not expect this to be called at any particular point in execution. If a file is split between multiple jobs this will be called in only one of these jobs, and not the others. It usually gets called before the first event in a file, but that is not guaranteed and relying on this is a bug.

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

\warn fileExecute does not work with sub-file splitting in Athena, i.e. processing half the events of a file in one job the other half in another job. this should not normally happen, unless you do crazy things like run AthenaMP or explicitly select sub-file splitting in panda. in that case you are on your own.

Definition at line 342 of file AnaAlgorithm.cxx.

344 {
345 return StatusCode::SUCCESS;
346 }

◆ finalize()

StatusCode EL::AnaAlgorithm::finalize ( )
protectedinherited

finalize this algorithm

This gets called after event processing has finished. The last event may no longer be in memory, and the code should not try to access it.

Definition at line 328 of file AnaAlgorithm.cxx.

330 {
331 return StatusCode::SUCCESS;
332 }

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

478{
479 // Build a 32 bit hash out of the name
480 const hash_t graphHash = this->hash(graphName);
481
482 // See if this entry exists in the map
483 GraphMap_t::const_iterator it = m_graphMap.find( graphHash );
484 if ( it == m_graphMap.end() ) // It doesn't exist!
485 { // Let's see into the THistSvc if somebody else has registered the TGraph...
486
487 // Need to copy the strings as we will massage them from here on
488 std::string graphNameCopy = graphName;
489 std::string tDirCopy = tDir;
490 std::string streamCopy = stream;
491
492 // Massage the final string to book things
493 std::string bookingString("");
494 this->buildBookingString( bookingString, graphNameCopy, tDirCopy, streamCopy, true);
495
496 TGraph* graphPointer(NULL);
497 if ( !((histSvc()->getGraph(bookingString, graphPointer)).isSuccess()) )
498 {
499 // Massage the final string to book things
500 std::string bookingString("");
501 this->buildBookingString( bookingString, graphNameCopy, tDirCopy, streamCopy, false );
502
503 if ( !((histSvc()->getGraph(bookingString, graphPointer)).isSuccess()) )
504 {
505 m_msg << MSG::WARNING
506 << "Problem retrieving the TGraph with name (including pre- and post-fixes) "
507 << m_histNamePrefix + graphNameCopy + m_histNamePostfix
508 << " or with name " << graphNameCopy
509 << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
510 << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
511 return NULL;
512 }
513 // If we get to here, we actually found the TGraph in the THistSvc.
514 // So let's add it to the local cache map and return its pointer
515 m_graphMap.insert( m_graphMap.end(), std::pair< const hash_t, TGraph* >( graphHash, graphPointer ) );
516 return graphPointer;
517 }
518 // If we get to here, we actually found the TGraph in the THistSvc.
519 // So let's add it to the local cache map and return its pointer
520 m_graphMap.insert( m_graphMap.end(), std::pair< const hash_t, TGraph* >( graphHash, graphPointer ) );
521 return graphPointer;
522 }
523
524
525 // Return the pointer to the TGraph that we got from the local cache map
526 return it->second;
527}
std::pair< StatusCode, TGraph * > getGraph(ITHistSvc &svc, const std::string &name)

◆ handle()

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

receive the given incident

Guarantee
basic
Failures
incident handling errors

Definition at line 520 of file AnaAlgorithm.cxx.

522 {
523 if (inc.type() == IncidentType::BeginInputFile)
524 {
529 } else if (inc.type() == IncidentType::EndInputFile)
530 {
533 } else
534 {
535 ATH_MSG_WARNING( "Unknown incident type received: " << inc.type() );
536 }
537 }
#define ATH_MSG_WARNING(x)
#define ANA_CHECK_THROW(EXP)
check whether the given expression was successful, throwing an exception on failure
virtual::StatusCode endInputFile()
perform the action for the end of an input file
virtual::StatusCode fileExecute()
perform the action exactly once for each file in the dataset
bool m_hasBeginInputFile
the value of hasBeginInputFile
bool m_hasFileExecute
the value of hasFileExecute
bool m_hasEndInputFile
the value of hasEndInputFile
virtual::StatusCode beginInputFile()
perform the action for the beginning of an input file

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

431{
432 const uint64_t hash64 = CxxUtils::crc64( histName );
433 return (hash_t)(hash64 & 0xFFFFFFFF);
434}
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 ( const std::string & histName,
const std::string & tDir = "",
const std::string & stream = "" )
protectedinherited

Simplify the retrieval of registered histograms of any type.

Definition at line 183 of file AthHistogramming.cxx.

184{
185 // Build a 32 bit hash out of the name
186 const hash_t histHash = this->hash(histName);
187
188 // See if this entry exists in the map
189 HistMap_t::const_iterator it = m_histMap.find( histHash );
190 if ( it == m_histMap.end() ) // It doesn't exist!
191 { // Let's see into the THistSvc if somebody else has registered the histogram...
192
193 // Need to copy the strings as we will massage them from here on
194 std::string histNameCopy = histName;
195 std::string tDirCopy = tDir;
196 std::string streamCopy = stream;
197
198 // Massage the final string to book things
199 std::string bookingString("");
200 this->buildBookingString( bookingString, histNameCopy, tDirCopy, streamCopy ,false);
201
202 TH1* histPointer(NULL);
203 if ( !((histSvc()->getHist(bookingString, histPointer)).isSuccess()) )
204 {
205 // Massage the final string to book things
206 std::string bookingString("");
207 this->buildBookingString( bookingString, histNameCopy, tDirCopy, streamCopy, true );
208
209 if ( !((histSvc()->getHist(bookingString, histPointer)).isSuccess()) )
210 {
211 m_msg << MSG::WARNING
212 << "Problem retrieving the histogram with name (including pre- and post-fixes) "
213 << m_histNamePrefix + histNameCopy + m_histNamePostfix
214 << " or with name " << histNameCopy
215 << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
216 << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
217 return NULL;
218 }
219 // If we get to here, we actually found the histogram in the THistSvc.
220 // So let's add it to the local cache map and return its pointer
221 m_histMap.insert( m_histMap.end(), std::pair< const hash_t, TH1* >( histHash, histPointer ) );
222 return histPointer;
223 }
224 // If we get to here, we actually found the histogram in the THistSvc.
225 // So let's add it to the local cache map and return its pointer
226 m_histMap.insert( m_histMap.end(), std::pair< const hash_t, TH1* >( histHash, histPointer ) );
227 return histPointer;
228 }
229
230
231 // Return the pointer to the histogram that we got from the local cache map
232 return it->second;
233}
std::pair< StatusCode, TH1 * > getHist(ITHistSvc &svc, const std::string &name, size_t index=0)

◆ hist2d()

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

Simplify the retrieval of registered 2-d histograms.

Definition at line 371 of file AthHistogramming.h.

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

◆ hist3d()

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

Simplify the retrieval of registered 3-d histograms.

Definition at line 388 of file AthHistogramming.h.

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

◆ 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}
ServiceHandle< ITHistSvc > m_histSvc
Default constructor: AthHistogramAlgorithm();.

◆ initialize()

StatusCode CP::AsgViewFromSelectionAlg::initialize ( )
override

Definition at line 177 of file AsgViewFromSelectionAlg.cxx.

179 {
180 ANA_CHECK (m_systematicsList.service().registerCopy (m_inputHandle.getNamePattern(), m_outputHandle.getNamePattern()));
183 ANA_CHECK (m_systematicsList.initialize());
184
185 if (m_ignore.size() > m_selection.size())
186 {
187 ANA_MSG_ERROR ("ignore property can't have more properties than selection property");
188 return StatusCode::FAILURE;
189 }
190 for (std::size_t iter = 0, end = m_selection.size(); iter != end; ++ iter)
191 {
193 if (iter < m_ignore.size())
195 std::unique_ptr<ISelectionReadAccessor> accessor;
197 m_accessors.push_back (std::make_pair (std::move (accessor), ignore));
198 }
199
200#ifndef XAOD_STANDALONE
201 const CLID clidRead = detail::getClidForDependency<xAOD::IParticleContainer>("", "deco", false);
202 const CLID clidWrite = detail::getClidForDependency<xAOD::IParticleContainer>("", "deco", true);
203 std::function<void(const DataObjID&, Gaudi::DataHandle::Mode)> addAlgDependency = [this] (const DataObjID& id, Gaudi::DataHandle::Mode mode) {
204 this->addDependency(id, mode);
205 };
206 for (const auto& decoName : m_systematicsList.service().getObjectDecorations(m_inputHandle.getNamePattern()))
207 {
208 ANA_CHECK (detail::addSysDependency(msg(), m_systematicsList.service(), addAlgDependency, clidRead, m_inputHandle.getNamePattern(), Gaudi::DataHandle::Reader, decoName, false));
209 ANA_CHECK (detail::addSysDependency(msg(), m_systematicsList.service(), addAlgDependency, clidWrite, m_outputHandle.getNamePattern(), Gaudi::DataHandle::Writer, decoName, true));
210 }
211#endif
212
213 return StatusCode::SUCCESS;
214 }
uint32_t CLID
The Class ID type.
Gaudi::Property< std::vector< std::string > > m_selection
Gaudi::Property< std::vector< SelectionType > > m_ignore
CLID getClidForDependency(const std::string &typeName, const std::string &decoName, bool decoWrite)
StatusCode addSysDependency(MsgStream &msg, const ISystematicsSvc &svc, const std::function< void(const DataObjID &, Gaudi::DataHandle::Mode)> &addAlgDependency, const CLID clid, const std::string &name, Gaudi::DataHandle::Mode mode, const std::string &decoName, bool decoWrite)
StatusCode makeSelectionReadAccessor(const std::string &expr, std::unique_ptr< ISelectionReadAccessor > &accessor, bool defaultToChar)
make the ISelectionReadAccessor for the given name
uint32_t SelectionType
the type for selection decorations that are meant to hold a asg::AcceptData
MsgStream & msg
Definition testRead.cxx:32

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::inputHandles ( ) const
overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ inputMetaStore() [1/2]

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

Definition at line 81 of file AnaAlgorithm.cxx.

82 {
83#ifdef XAOD_STANDALONE
84 return &m_inputMetaStore;
85#else
86 return m_inputMetaStore;
87#endif // XAOD_STANDALONE
88 }

◆ inputMetaStore() [2/2]

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

Accessor for the input metadata store

Definition at line 72 of file AnaAlgorithm.cxx.

73 {
74#ifdef XAOD_STANDALONE
75 return &m_inputMetaStore;
76#else
77 return m_inputMetaStore;
78#endif // XAOD_STANDALONE
79 }

◆ msg()

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

Definition at line 24 of file AthCommonMsg.h.

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

◆ msgLvl()

bool AthCommonMsg< 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 575 of file AthHistogramming.cxx.

578{
579 size_t pos = 0;
580 while((pos = str.find(oldStr, pos)) != std::string::npos)
581 {
582 str.replace(pos, oldStr.length(), newStr);
583 pos += newStr.length();
584 }
585}

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::outputHandles ( ) const
overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ outputMetaStore() [1/2]

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

Definition at line 101 of file AnaAlgorithm.cxx.

102 {
103#ifdef XAOD_STANDALONE
104 return &m_outputMetaStore;
105#else
106 return m_outputMetaStore;
107#endif // XAOD_STANDALONE
108 }

◆ outputMetaStore() [2/2]

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

Accessor for the output metadata store

Definition at line 92 of file AnaAlgorithm.cxx.

93 {
94#ifdef XAOD_STANDALONE
95 return &m_outputMetaStore;
96#else
97 return m_outputMetaStore;
98#endif // XAOD_STANDALONE
99 }

◆ print()

void EL::AnaAlgorithm::print ( ) const
protectedvirtualinherited

print the state of the algorithm

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

Definition at line 336 of file AnaAlgorithm.cxx.

338 {}

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< Algorithm > >::renounce ( T & h)
inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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< Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray)
inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

364 {
366 }

◆ requestBeginInputFile()

StatusCode EL::AnaAlgorithm::requestBeginInputFile ( )
inherited

register this algorithm to have an implementation of beginInputFile

Guarantee
strong
Failures
beginInputFile not supported

Definition at line 270 of file AnaAlgorithm.cxx.

272 {
273 m_hasBeginInputFile = true;
274
275#ifndef XAOD_STANDALONE
276 // Connect to the IncidentSvc:
277 ServiceHandle< IIncidentSvc > incSvc( "IncidentSvc", name() );
278 ATH_CHECK( incSvc.retrieve() );
279
280 // Set up the right callback, but ensure we don't double-register
281 // if we are called twice
282 incSvc->removeListener( this, IncidentType::BeginInputFile );
283 incSvc->addListener( this, IncidentType::BeginInputFile, 0, true );
284#endif
285
286 return StatusCode::SUCCESS;
287 }
#define ATH_CHECK
Evaluate an expression and check for errors.

◆ requestEndInputFile()

StatusCode EL::AnaAlgorithm::requestEndInputFile ( )
inherited

register this algorithm to have an implementation of endInputFile

Guarantee
strong
Failures
endInputFile not supported

Definition at line 291 of file AnaAlgorithm.cxx.

293 {
294 m_hasEndInputFile = true;
295
296#ifndef XAOD_STANDALONE
297 // Connect to the IncidentSvc:
298 ServiceHandle< IIncidentSvc > incSvc( "IncidentSvc", name() );
299 ATH_CHECK( incSvc.retrieve() );
300
301 // Set up the right callback, but ensure we don't double-register
302 // if we are called twice
303 incSvc->removeListener( this, IncidentType::EndInputFile );
304 incSvc->addListener( this, IncidentType::EndInputFile, 0, true );
305#endif
306
307 return StatusCode::SUCCESS;
308 }

◆ requestFileExecute()

StatusCode EL::AnaAlgorithm::requestFileExecute ( )
inherited

register this algorithm to have an implementation of fileexecute

Guarantee
strong
Failures
fileExecute not supported

Definition at line 249 of file AnaAlgorithm.cxx.

251 {
252 m_hasFileExecute = true;
253
254#ifndef XAOD_STANDALONE
255 // Connect to the IncidentSvc:
256 ServiceHandle< IIncidentSvc > incSvc( "IncidentSvc", name() );
257 ATH_CHECK( incSvc.retrieve() );
258
259 // Set up the right callback, but ensure we don't double-register
260 // if we are called twice
261 incSvc->removeListener( this, IncidentType::BeginInputFile );
262 incSvc->addListener( this, IncidentType::BeginInputFile, 0, true );
263#endif
264
265 return StatusCode::SUCCESS;
266 }

◆ sysInitialize()

StatusCode AthHistogramAlgorithm::sysInitialize ( )
virtualinherited

Initialization method invoked by the framework.

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

Reimplemented from AthAlgorithm.

Reimplemented in AthAnalysisAlgorithm.

Definition at line 75 of file AthHistogramAlgorithm.cxx.

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}
#define ATH_MSG_DEBUG(x)
virtual StatusCode sysInitialize() override
Override sysInitialize.
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_histNamePrefix
The prefix for the histogram THx name.
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.
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< 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 363 of file AthHistogramming.cxx.

364{
365 // Build a 32 bit hash out of the name
366 const hash_t treeHash = this->hash(treeName);
367
368 // See if this entry exists in the map
369 TreeMap_t::const_iterator it = m_treeMap.find( treeHash );
370 if ( it == m_treeMap.end() ) // It doesn't exist!
371 { // Let's see into the THistSvc if somebody else has registered the TTree...
372
373 // Need to copy the strings as we will massage them from here on
374 std::string treeNameCopy = treeName;
375 std::string tDirCopy = tDir;
376 std::string streamCopy = stream;
377
378 // Massage the final string to book things
379 std::string bookingString("");
380 this->buildBookingString( bookingString, treeNameCopy, tDirCopy, streamCopy );
381
382 TTree* treePointer(NULL);
383 if ( !((histSvc()->getTree(bookingString, treePointer)).isSuccess()) )
384 {
385 m_msg << MSG::WARNING
386 << "Problem retrieving the TTree with name " << treeNameCopy
387 << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
388 << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
389 return NULL;
390 }
391 // If we get to here, we actually found the TTree in the THistSvc.
392 // So let's add it to the local cache map and return its pointer
393 m_treeMap.insert( m_treeMap.end(), std::pair< const hash_t, TTree* >( treeHash, treePointer ) );
394 return treePointer;
395 }
396
397 // Return the pointer to the TTree that we got from the local cache map
398 return it->second;
399}
std::pair< StatusCode, TTree * > getTree(ITHistSvc &svc, const std::string &name)

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< 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 }
std::vector< SG::VarHandleKeyArray * > m_vhka

Member Data Documentation

◆ m_accessors

std::vector<std::pair<std::unique_ptr<ISelectionReadAccessor>,SelectionType> > CP::AsgViewFromSelectionAlg::m_accessors
private

the list of accessors and cut ignore list

Definition at line 79 of file AsgViewFromSelectionAlg.h.

◆ m_allowMissing

Gaudi::Property<bool> CP::AsgViewFromSelectionAlg::m_allowMissing {this, "allowMissing", false, "Allow the input container to be missing"}
private

Allow the input container to be missing.

Definition at line 68 of file AsgViewFromSelectionAlg.h.

68{this, "allowMissing", false, "Allow the input container to be missing"};

◆ m_deepCopy

Gaudi::Property<bool> CP::AsgViewFromSelectionAlg::m_deepCopy {this, "deepCopy", false, "perform a deep copy"}
private

Perform a deep copy for creating the output container.

Definition at line 72 of file AsgViewFromSelectionAlg.h.

72{this, "deepCopy", false, "perform a deep copy"};

◆ m_detStore

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

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

◆ m_effMap

EffMap_t AthHistogramming::m_effMap
privateinherited

The map of histogram names to their pointers.

Definition at line 210 of file AthHistogramming.h.

◆ m_evtStore

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

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects
privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_function

StatusCode(AsgViewFromSelectionAlg::* CP::AsgViewFromSelectionAlg::m_function) (const CP::SystematicSet &sys)
inlineprivate

Definition at line 95 of file AsgViewFromSelectionAlg.h.

StatusCode executeFindType(const CP::SystematicSet &sys)
the version of execute to find the type

◆ m_graphMap

GraphMap_t AthHistogramming::m_graphMap
privateinherited

The map of TGraph names to their pointers.

Definition at line 224 of file AthHistogramming.h.

◆ m_hasBeginInputFile

bool EL::AnaAlgorithm::m_hasBeginInputFile {false}
privateinherited

the value of hasBeginInputFile

Definition at line 590 of file AnaAlgorithm.h.

590{false};

◆ m_hasEndInputFile

bool EL::AnaAlgorithm::m_hasEndInputFile {false}
privateinherited

the value of hasEndInputFile

Definition at line 594 of file AnaAlgorithm.h.

594{false};

◆ m_hasFileExecute

bool EL::AnaAlgorithm::m_hasFileExecute {false}
privateinherited

the value of hasFileExecute

Definition at line 586 of file AnaAlgorithm.h.

586{false};

◆ m_histMap

HistMap_t AthHistogramming::m_histMap
privateinherited

The map of histogram names to their pointers.

Definition at line 203 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_ignore

Gaudi::Property<std::vector<SelectionType> > CP::AsgViewFromSelectionAlg::m_ignore {this, "ignore", {}, "the list of cuts to *ignore* for each selection"}
private

Definition at line 60 of file AsgViewFromSelectionAlg.h.

60{this, "ignore", {}, "the list of cuts to *ignore* for each selection"};

◆ m_inputHandle

SysReadHandle<xAOD::IParticleContainer> CP::AsgViewFromSelectionAlg::m_inputHandle
private
Initial value:
{
this, "input", "", "the input collection to run on"}

the input collection we run on

Definition at line 46 of file AsgViewFromSelectionAlg.h.

46 {
47 this, "input", "", "the input collection to run on"};

◆ m_inputMetaStore

MetaStore_t EL::AnaAlgorithm::m_inputMetaStore
privateinherited

Object accessing the input metadata store.

Definition at line 551 of file AnaAlgorithm.h.

◆ m_msg

MsgStream AthHistogramming::m_msg
privateinherited

Cached Message Stream.

Definition at line 250 of file AthHistogramming.h.

◆ m_name

std::string AthHistogramming::m_name
privateinherited

Instance name.

Definition at line 247 of file AthHistogramming.h.

◆ m_outputHandle

SysWriteHandle<xAOD::IParticleContainer> CP::AsgViewFromSelectionAlg::m_outputHandle
private
Initial value:
{
this, "output", "", "the output view container to produce"}

the output view container we produce

Definition at line 51 of file AsgViewFromSelectionAlg.h.

51 {
52 this, "output", "", "the output view container to produce"};

◆ m_outputMetaStore

MetaStore_t EL::AnaAlgorithm::m_outputMetaStore
privateinherited

Object accessing the output metadata store.

Definition at line 555 of file AnaAlgorithm.h.

◆ m_prefix

std::string AthHistogramAlgorithm::m_prefix
privateinherited

Name of the ROOT output stream (file).

Definition at line 88 of file AthHistogramAlgorithm.h.

◆ m_rootDir

std::string AthHistogramAlgorithm::m_rootDir
privateinherited

Name of the ROOT directory.

Definition at line 91 of file AthHistogramAlgorithm.h.

◆ m_selection

Gaudi::Property<std::vector<std::string> > CP::AsgViewFromSelectionAlg::m_selection {this, "selection", {}, "the list of selection decorations"}
private
Todo
this would probably better be an std::map, but this isn't supported as a property type for AnaAlgorithm right now

Definition at line 57 of file AsgViewFromSelectionAlg.h.

57{this, "selection", {}, "the list of selection decorations"};

◆ m_sizeLimit

Gaudi::Property<std::size_t> CP::AsgViewFromSelectionAlg::m_sizeLimit {this, "sizeLimit", std::numeric_limits<std::size_t>::max(), "the limit on the size of the output container"}
private

Definition at line 75 of file AsgViewFromSelectionAlg.h.

75{this, "sizeLimit", std::numeric_limits<std::size_t>::max(), "the limit on the size of the output container"};

◆ m_sortPt

Gaudi::Property<bool> CP::AsgViewFromSelectionAlg::m_sortPt {this, "sortPt", false, "whether to sort objects in pt"}
private

Sort the output (view) container by pT.

Definition at line 64 of file AsgViewFromSelectionAlg.h.

64{this, "sortPt", false, "whether to sort objects in pt"};

◆ m_streamName

std::string AthHistogramming::m_streamName
privateinherited

Name of the ROOT output stream (file).

Definition at line 228 of file AthHistogramming.h.

◆ m_systematicsList

SysListHandle CP::AsgViewFromSelectionAlg::m_systematicsList {this}
private

the systematics list we run

Definition at line 42 of file AsgViewFromSelectionAlg.h.

42{this};

◆ m_treeMap

TreeMap_t AthHistogramming::m_treeMap
privateinherited

The map of TTree names to their pointers.

Definition at line 217 of file AthHistogramming.h.

◆ m_varHandleArraysDeclared

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

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

Definition at line 398 of file AthCommonDataStore.h.


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