![]() |
ATLAS Offline Software
|
Write out the selected events in xAOD format. More...
#include <EventSaverxAODNext.h>
Public Member Functions | |
EventSaverxAODNext () | |
virtual | ~EventSaverxAODNext () |
virtual void | initialize (std::shared_ptr< top::TopConfig > config, TFile *file, const std::vector< std::string > &extraBranches) |
This does some configuration of the output file. More... | |
virtual StatusCode | initialize () |
Dummy implementation of the initialisation function. More... | |
virtual void | saveEventToxAOD () |
virtual void | finalize () |
xAOD needs to write some more stuff to the file at the end of a job More... | |
virtual void | execute () |
Method to execute any calculations common for reco/particle/parton level. More... | |
virtual void | saveEvent (const top::Event &) |
I guess you want to save an event sometimes to. More... | |
virtual void | saveTruthEvent () |
@breif Run for every event More... | |
virtual void | saveParticleLevelEvent (const top::ParticleLevelEvent &) |
Function to save the particle level event. More... | |
virtual void | saveUpgradeEvent (const top::ParticleLevelEvent &) |
Function to save the upgrade event. More... | |
ClassDef (top::EventSaverBase, 0) | |
virtual StatusCode | sysInitialize () |
Function initialising the tool in the correct way in Athena. More... | |
virtual void | print () const |
Print the state of the tool. More... | |
ServiceHandle< StoreGateSvc > & | evtStore () |
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc . More... | |
const ServiceHandle< StoreGateSvc > & | evtStore () const |
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc . More... | |
const ServiceHandle< StoreGateSvc > & | detStore () const |
The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc . More... | |
virtual StatusCode | sysStart () override |
Handle START transition. More... | |
virtual std::vector< Gaudi::DataHandle * > | inputHandles () const override |
Return this algorithm's input handles. More... | |
virtual std::vector< Gaudi::DataHandle * > | outputHandles () const override |
Return this algorithm's output handles. More... | |
Gaudi::Details::PropertyBase & | declareProperty (Gaudi::Property< T > &t) |
Gaudi::Details::PropertyBase * | declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &) |
Declare a new Gaudi property. More... | |
Gaudi::Details::PropertyBase * | declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &) |
Declare a new Gaudi property. More... | |
Gaudi::Details::PropertyBase * | declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &) |
Gaudi::Details::PropertyBase * | declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &) |
Declare a new Gaudi property. More... | |
Gaudi::Details::PropertyBase * | declareProperty (const std::string &name, T &property, const std::string &doc="none") |
Declare a new Gaudi property. More... | |
void | updateVHKA (Gaudi::Details::PropertyBase &) |
MsgStream & | msg () const |
MsgStream & | msg (const MSG::Level lvl) const |
bool | msgLvl (const MSG::Level lvl) const |
Protected Member Functions | |
void | renounceArray (SG::VarHandleKeyArray &handlesArray) |
remove all handles from I/O resolution More... | |
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > | renounce (T &h) |
void | extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps) |
Add StoreName to extra input/output deps as needed. More... | |
Private Types | |
typedef std::map< std::size_t, std::map< unsigned int, unsigned int > > | ThinningMap_t |
typedef ThinningMap_t::const_iterator | ThinningMap_Itr |
typedef ServiceHandle< StoreGateSvc > | StoreGateSvc_t |
Private Member Functions | |
std::shared_ptr< ThinningMap_t > | savePhotons (const bool saveEventObjects) |
All the saveObject functions work the same way. More... | |
std::shared_ptr< ThinningMap_t > | saveElectrons (const bool saveEventObjects) |
std::shared_ptr< ThinningMap_t > | saveMuons (const bool saveEventObjects) |
std::shared_ptr< ThinningMap_t > | saveTaus (const bool saveEventObjects) |
std::shared_ptr< ThinningMap_t > | saveJets (const bool saveEventObjects) |
std::shared_ptr< ThinningMap_t > | saveLargeRJets (const bool saveEventObjects) |
std::shared_ptr< ThinningMap_t > | saveTrackJets (const bool saveEventObjects) |
std::vector< unsigned int > | thinObjectSelection (const std::size_t hashValue, const std::vector< unsigned int > &objectList, const std::shared_ptr< ThinningMap_t > &thinningMap) const |
ClassDef (top::EventSaverxAODNext, 0) | |
Gaudi::Details::PropertyBase & | declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &) |
specialization for handling Gaudi::Property<SG::VarHandleKey> More... | |
Gaudi::Details::PropertyBase & | declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &) |
specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More... | |
Gaudi::Details::PropertyBase & | declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &) |
specialization for handling Gaudi::Property<SG::VarHandleBase> More... | |
Gaudi::Details::PropertyBase & | declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &) |
specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More... | |
Private Attributes | |
std::shared_ptr< top::TopConfig > | m_config |
We need access to the configuration file to get the container names. More... | |
TFile * | m_outputFile |
We need to hold on to the output file. More... | |
bool | m_saveAllObjects |
MetaStore_t | m_inputMetaStore |
Object accessing the input metadata store. More... | |
MetaStore_t | m_outputMetaStore |
Object accessing the output metadata store. More... | |
bool | m_beginInputFileCalled |
Flag helping to discover when the tool misses the opening of the first input file. More... | |
bool | m_useIncidents |
StoreGateSvc_t | m_evtStore |
Pointer to StoreGate (event store by default) More... | |
StoreGateSvc_t | m_detStore |
Pointer to StoreGate (detector store by default) More... | |
std::vector< SG::VarHandleKeyArray * > | m_vhka |
bool | m_varHandleArraysDeclared |
Callback functions helping in metadata reading/writing | |
void | setUseIncidents (const bool flag) |
virtual void | handle (const Incident &inc) |
Function receiving incidents from IncidentSvc/TEvent. More... | |
virtual StatusCode | beginInputFile () |
Function called when a new input file is opened. More... | |
virtual StatusCode | endInputFile () |
Function called when the currently open input file got completely processed. More... | |
virtual StatusCode | beginEvent () |
Function called when a new events is loaded. More... | |
virtual StatusCode | metaDataStop () |
Function called when the tool should write out its metadata. More... | |
Write out the selected events in xAOD format.
Next generation xAOD output - still in development
Definition at line 20 of file EventSaverxAODNext.h.
|
inherited |
Type of the metadata store object in Athena.
Definition at line 66 of file AsgMetadataTool.h.
|
inherited |
Type of the metadata store pointer in standalone mode.
Definition at line 68 of file AsgMetadataTool.h.
|
privateinherited |
Definition at line 388 of file AthCommonDataStore.h.
|
private |
Definition at line 65 of file EventSaverxAODNext.h.
|
private |
Definition at line 64 of file EventSaverxAODNext.h.
top::EventSaverxAODNext::EventSaverxAODNext | ( | ) |
Definition at line 29 of file EventSaverxAODNext.cxx.
|
virtual |
Definition at line 36 of file EventSaverxAODNext.cxx.
|
protectedvirtualinherited |
Function called when a new events is loaded.
Dummy implementation that can be overridden by the derived tool.
Reimplemented in AsgElectronEfficiencyCorrectionTool, TrigConf::xAODConfigTool, TauAnalysisTools::TauSelectionTool, TauAnalysisTools::DiTauSelectionTool, TauAnalysisTools::CommonSmearingTool, TauAnalysisTools::DiTauEfficiencyCorrectionsTool, Trig::TrigDecisionTool, TauAnalysisTools::TauEfficiencyCorrectionsTool, Trig::TrigConfBunchCrossingTool, xAODMaker::TriggerMenuMetaDataTool, and Trig::xAODBunchCrossingTool.
Definition at line 196 of file AsgMetadataTool.cxx.
|
protectedvirtualinherited |
Function called when a new input file is opened.
Dummy implementation that can be overridden by the derived tool.
Reimplemented in AsgElectronEfficiencyCorrectionTool, TrigConf::xAODConfigTool, PMGTools::PMGTruthWeightTool, BookkeeperTool, HFORSelectionTool, xAODMaker::FileMetaDataTool, BookkeeperDumperTool, Trig::TrigDecisionTool, xAODMaker::TriggerMenuMetaDataTool, xAODMaker::TruthMetaDataTool, Trig::xAODBunchCrossingTool, TauAnalysisTools::TauEfficiencyCorrectionsTool, and TauAnalysisTools::TauSmearingTool.
Definition at line 180 of file AsgMetadataTool.cxx.
|
inherited |
|
private |
|
inlineprivateinherited |
specialization for handling Gaudi::Property<SG::VarHandleKeyArray>
Definition at line 170 of file AthCommonDataStore.h.
|
inlineprivateinherited |
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition at line 156 of file AthCommonDataStore.h.
|
inlineprivateinherited |
specialization for handling Gaudi::Property<SG::VarHandleBase>
Definition at line 184 of file AthCommonDataStore.h.
|
inlineprivateinherited |
specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>
Definition at line 199 of file AthCommonDataStore.h.
|
inlineinherited |
Declare a new Gaudi property.
name | Name of the property. |
hndl | Object holding the property value. |
doc | Documentation string for the property. |
This is the version for types that derive from SG::VarHandleBase
. The property value object is put on the input and output lists as appropriate; then we forward to the base class.
Definition at line 245 of file AthCommonDataStore.h.
|
inlineinherited |
Declare a new Gaudi property.
name | Name of the property. |
hndl | Object holding the property value. |
doc | Documentation string for the property. |
This is the version for types that derive from SG::VarHandleKey
. The property value object is put on the input and output lists as appropriate; then we forward to the base class.
Definition at line 221 of file AthCommonDataStore.h.
|
inlineinherited |
Definition at line 259 of file AthCommonDataStore.h.
|
inlineinherited |
Declare a new Gaudi property.
name | Name of the property. |
property | Object holding the property value. |
doc | Documentation string for the property. |
This is the generic version, for types that do not derive from SG::VarHandleKey
. It just forwards to the base class version of declareProperty
.
Definition at line 333 of file AthCommonDataStore.h.
|
inlineinherited |
Declare a new Gaudi property.
name | Name of the property. |
property | Object holding the property value. |
doc | Documentation string for the property. |
This dispatches to either the generic declareProperty
or the one for VarHandle/Key/KeyArray.
Definition at line 352 of file AthCommonDataStore.h.
|
inlineinherited |
Definition at line 145 of file AthCommonDataStore.h.
|
inlineinherited |
The standard StoreGateSvc/DetectorStore
Returns (kind of) a pointer to the StoreGateSvc
.
Definition at line 95 of file AthCommonDataStore.h.
|
protectedvirtualinherited |
Function called when the currently open input file got completely processed.
Dummy implementation that can be overridden by the derived tool.
Reimplemented in BookkeeperTool, HFORSelectionTool, xAODMaker::FileMetaDataTool, BookkeeperDumperTool, xAODMaker::TriggerMenuMetaDataTool, and xAODMaker::TruthMetaDataTool.
Definition at line 188 of file AsgMetadataTool.cxx.
|
inlineinherited |
The standard StoreGateSvc
(event store) Returns (kind of) a pointer to the StoreGateSvc
.
Definition at line 85 of file AthCommonDataStore.h.
|
inlineinherited |
The standard StoreGateSvc
(event store) Returns (kind of) a pointer to the StoreGateSvc
.
Definition at line 90 of file AthCommonDataStore.h.
|
inlinevirtualinherited |
Method to execute any calculations common for reco/particle/parton level.
Reimplemented in top::EventSaverFlatNtuple.
Definition at line 48 of file EventSaverBase.h.
|
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
|
virtual |
xAOD needs to write some more stuff to the file at the end of a job
Reimplemented from top::EventSaverBase.
Definition at line 653 of file EventSaverxAODNext.cxx.
|
inherited |
Get the (hashed) key of an object that is in the event store.
This is a bit of a special one. StoreGateSvc
and xAOD::TEvent
both provide ways for getting the SG::sgkey_t
key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.
In order to allow tools to efficiently perform this operation, they can use this helper function.
ptr | The bare pointer to the object that the event store should know about |
Definition at line 119 of file AsgTool.cxx.
Get the name of an object that is / should be in the event store.
This is a bit of a special one. StoreGateSvc
and xAOD::TEvent
both provide ways for getting the std::string
name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.
In order to allow tools to efficiently perform this operation, they can use this helper function.
ptr | The bare pointer to the object that the event store should know about |
Definition at line 106 of file AsgTool.cxx.
Get one of the tool's properties.
|
protectedvirtualinherited |
Function receiving incidents from IncidentSvc/TEvent.
Reimplemented in Trig::TrigDecisionTool.
Definition at line 130 of file AsgMetadataTool.cxx.
|
inlinevirtual |
Dummy implementation of the initialisation function.
It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...
Reimplemented from asg::AsgTool.
Definition at line 47 of file EventSaverxAODNext.h.
|
virtual |
This does some configuration of the output file.
It also keeps track of which branches should be saved.
You surely don't need all the branches, but if you do remove the corresponding line.
We can't do much in the constructor, like I would like, because we're letting root make this. So instead we have a function here.
config | The top::TopConfig object that contains lots of settings and stuff. |
file | The output TFile that you want to save things to. |
extraBranches | List of extra branches that (currently) are attached to EventInfo. e.g. the branch that tells you if an event passed a certain selection. If you add it here, it'll be written to the output file. |
Implements top::EventSaverBase.
Definition at line 39 of file EventSaverxAODNext.cxx.
|
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.
|
inherited |
|
protectedvirtualinherited |
Function called when the tool should write out its metadata.
Dummy implementation that can be overridden by the derived tool.
Reimplemented in xAODMaker::FileMetaDataTool, BookkeeperTool, BookkeeperDumperTool, xAODMaker::TriggerMenuMetaDataTool, and xAODMaker::TruthMetaDataTool.
Definition at line 204 of file AsgMetadataTool.cxx.
|
inlineinherited |
Definition at line 24 of file AthCommonMsg.h.
|
inlineinherited |
Definition at line 27 of file AthCommonMsg.h.
|
inherited |
A deprecated function for getting the message level's name.
Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:
This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.
Definition at line 101 of file AsgTool.cxx.
|
inlineinherited |
Definition at line 30 of file AthCommonMsg.h.
|
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.
|
inherited |
|
virtualinherited |
Print the state of the tool.
Implements asg::IAsgTool.
Reimplemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, top::TopObjectSelection, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.
Definition at line 131 of file AsgTool.cxx.
|
inlineprotectedinherited |
Definition at line 380 of file AthCommonDataStore.h.
|
inlineprotectedinherited |
remove all handles from I/O resolution
Definition at line 364 of file AthCommonDataStore.h.
|
private |
Definition at line 344 of file EventSaverxAODNext.cxx.
|
inlinevirtualinherited |
I guess you want to save an event sometimes to.
There are multiple ways you might want to do this All methods below are implemented with a simple return This means that you do not need to implement them in your derived class
event | The event in question, in the format used internally. |
Reimplemented in top::EventSaverFlatNtuple, and top::EventSaverxAOD.
Definition at line 59 of file EventSaverBase.h.
|
virtual |
Reimplemented from top::EventSaverBase.
Definition at line 148 of file EventSaverxAODNext.cxx.
|
private |
Definition at line 490 of file EventSaverxAODNext.cxx.
|
private |
Definition at line 545 of file EventSaverxAODNext.cxx.
|
private |
Definition at line 396 of file EventSaverxAODNext.cxx.
|
inlinevirtualinherited |
Function to save the particle level event.
This function has a default implementation that does ... nothing! This is deliberate since doing so does not force developers of custom EventSaver tools to implement particle level saving.
plEvent | The particle level event whose contents will be saved. |
Reimplemented in top::EventSaverFlatNtuple.
Definition at line 79 of file EventSaverBase.h.
|
private |
All the saveObject functions work the same way.
We only save objects that pass the pre overlap removal selection
We need to consider every calibration systematic variation
Definition at line 297 of file EventSaverxAODNext.cxx.
|
private |
Definition at line 443 of file EventSaverxAODNext.cxx.
|
private |
Definition at line 599 of file EventSaverxAODNext.cxx.
|
inlinevirtualinherited |
@breif Run for every event
This fills, if requested, the: MC truth record PDF info TopPartons
Reimplemented in top::EventSaverFlatNtuple.
Definition at line 70 of file EventSaverBase.h.
|
inlinevirtualinherited |
Function to save the upgrade event.
This function has a default implementation that does ... nothing! This is deliberate since doing so does not force developers of custom EventSaver tools to implement upgrade saving.
upgradeEvent | The upgrade event whose contents will be saved. |
Definition at line 91 of file EventSaverBase.h.
|
inlineprotectedinherited |
Definition at line 132 of file AsgMetadataTool.h.
|
virtualinherited |
Function initialising the tool in the correct way in Athena.
This function is used to set up the callbacks from IncidentSvc in Athena at the right time during initialisation, without the user having to do anything special in his/her code.
Reimplemented from AthCommonDataStore< AthCommonMsg< AlgTool > >.
Definition at line 110 of file AsgMetadataTool.cxx.
|
overridevirtualinherited |
Handle START transition.
We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.
|
private |
Definition at line 244 of file EventSaverxAODNext.cxx.
|
inlineinherited |
Definition at line 308 of file AthCommonDataStore.h.
|
privateinherited |
Flag helping to discover when the tool misses the opening of the first input file.
Definition at line 126 of file AsgMetadataTool.h.
|
private |
We need access to the configuration file to get the container names.
Definition at line 56 of file EventSaverxAODNext.h.
|
privateinherited |
Pointer to StoreGate (detector store by default)
Definition at line 393 of file AthCommonDataStore.h.
|
privateinherited |
Pointer to StoreGate (event store by default)
Definition at line 390 of file AthCommonDataStore.h.
|
privateinherited |
Object accessing the input metadata store.
Definition at line 119 of file AsgMetadataTool.h.
|
private |
We need to hold on to the output file.
Definition at line 59 of file EventSaverxAODNext.h.
|
privateinherited |
Object accessing the output metadata store.
Definition at line 121 of file AsgMetadataTool.h.
|
private |
Definition at line 61 of file EventSaverxAODNext.h.
|
privateinherited |
Definition at line 128 of file AsgMetadataTool.h.
|
privateinherited |
Definition at line 399 of file AthCommonDataStore.h.
|
privateinherited |
Definition at line 398 of file AthCommonDataStore.h.