![]() |
ATLAS Offline Software
|
top-level tool for performing overlap removal. More...
#include <OverlapRemovalTool.h>
Public Member Functions | |
| OverlapRemovalTool (const std::string &name) | |
| Create a proper constructor for Athena. | |
| virtual StatusCode | initialize () override |
| Initialize the tool. | |
| virtual StatusCode | removeOverlaps (const xAOD::ElectronContainer *electrons, const xAOD::MuonContainer *muons, const xAOD::JetContainer *jets, const xAOD::TauJetContainer *taus=0, const xAOD::PhotonContainer *photons=0, const xAOD::JetContainer *fatJets=0) const override |
| Top-level method for performing full overlap-removal. | |
| virtual void | print () const |
| Print the state of the tool. | |
| 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 | sysInitialize () override |
| Perform system initialization for an algorithm. | |
| 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 |
Additional helper functions, not directly mimicking Athena | |
| template<class T> | |
| const T * | getProperty (const std::string &name) const |
| Get one of the tool's properties. | |
| const std::string & | msg_level_name () const __attribute__((deprecated)) |
| A deprecated function for getting the message level's name. | |
| const std::string & | getName (const void *ptr) const |
| Get the name of an object that is / should be in the event store. | |
| SG::sgkey_t | getKey (const void *ptr) const |
| Get the (hashed) key of an object that is in the event store. | |
Protected Member Functions | |
| 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. | |
Private Types | |
| typedef ServiceHandle< StoreGateSvc > | StoreGateSvc_t |
Private Member Functions | |
| StatusCode | removeOverlap (const ToolHandle< IOverlapTool > &tool, const xAOD::IParticleContainer *cont1, const xAOD::IParticleContainer *cont2) const |
| Use one tool to remove overlaps. | |
| Gaudi::Details::PropertyBase & | declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &) |
| specialization for handling Gaudi::Property<SG::VarHandleKey> | |
Private Attributes | |
| std::string | m_inputLabel |
| Input object decoration which specifies which objects to look at. | |
| std::string | m_outputLabel |
| Output object decoration which specifies overlapping objects. | |
| bool | m_outputPassValue |
| Toggle the output flag logic. | |
| bool | m_requireExpectedPointers |
| Require non-null container pointers when expected; i.e., when corresponding overlap tools are configured. | |
| std::unique_ptr< OverlapDecorationHelper< columnar::ContainerId::particle1 > > | m_decHelper |
| Helper used to reset decorations. | |
| ToolHandle< IOverlapTool > | m_eleEleORT |
| Ele-ele overlap handle. | |
| ToolHandle< IOverlapTool > | m_eleMuORT |
| Ele-mu overlap handle. | |
| ToolHandle< IOverlapTool > | m_eleJetORT |
| Ele-jet overlap handle. | |
| ToolHandle< IOverlapTool > | m_muJetORT |
| Mu-jet overlap handle. | |
| ToolHandle< IOverlapTool > | m_tauEleORT |
| Tau-ele overlap handle. | |
| ToolHandle< IOverlapTool > | m_tauMuORT |
| Tau-mu overlap handle. | |
| ToolHandle< IOverlapTool > | m_tauJetORT |
| Tau-jet overlap handle. | |
| ToolHandle< IOverlapTool > | m_phoEleORT |
| Pho-ele overlap handle. | |
| ToolHandle< IOverlapTool > | m_phoMuORT |
| Pho-mu overlap handle. | |
| ToolHandle< IOverlapTool > | m_phoJetORT |
| Pho-jet overlap handle. | |
| ToolHandle< IOverlapTool > | m_eleFatJetORT |
| ele-fatjet overlap handle | |
| ToolHandle< IOverlapTool > | m_jetFatJetORT |
| jet-fatjet overlap handle | |
| 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 |
top-level tool for performing overlap removal.
This tool will apply the overlap removals specified by the user in the form of IOverlapTools in the recommended order.
Definition at line 33 of file OverlapRemovalTool.h.
|
privateinherited |
Definition at line 388 of file AthCommonDataStore.h.
| ORUtils::OverlapRemovalTool::OverlapRemovalTool | ( | const std::string & | name | ) |
Create a proper constructor for Athena.
Constructor for standalone usage
Definition at line 16 of file OverlapRemovalTool.cxx.
|
inlineprivateinherited |
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition at line 156 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.
|
inlineinherited |
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
Definition at line 85 of file AthCommonDataStore.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
|
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.
|
inherited |
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.
|
inherited |
Get one of the tool's properties.
|
overridevirtual |
Initialize the tool.
Reimplemented from asg::AsgTool.
Definition at line 51 of file OverlapRemovalTool.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.
|
inlineinherited |
Definition at line 24 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.
|
virtualinherited |
Print the state of the tool.
Implements asg::IAsgTool.
Reimplemented in AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, KtDeltaRTool, and LundVariablesTool.
Definition at line 131 of file AsgTool.cxx.
|
private |
Use one tool to remove overlaps.
Definition at line 134 of file OverlapRemovalTool.cxx.
|
overridevirtual |
Top-level method for performing full overlap-removal.
The individual OR methods will be called in the recommended order, and the considered objects will be decorated with the output result.
Implements ORUtils::IOverlapRemovalTool.
Definition at line 83 of file OverlapRemovalTool.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.
|
overridevirtualinherited |
Perform system initialization for an algorithm.
We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.
Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.
|
overridevirtualinherited |
Handle START transition.
We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.
|
inlineinherited |
Definition at line 308 of file AthCommonDataStore.h.
|
private |
Helper used to reset decorations.
Definition at line 90 of file OverlapRemovalTool.h.
|
privateinherited |
Pointer to StoreGate (detector store by default)
Definition at line 393 of file AthCommonDataStore.h.
|
private |
Ele-ele overlap handle.
Definition at line 97 of file OverlapRemovalTool.h.
|
private |
ele-fatjet overlap handle
Definition at line 127 of file OverlapRemovalTool.h.
|
private |
Ele-jet overlap handle.
Definition at line 103 of file OverlapRemovalTool.h.
|
private |
Ele-mu overlap handle.
Definition at line 100 of file OverlapRemovalTool.h.
|
privateinherited |
Pointer to StoreGate (event store by default)
Definition at line 390 of file AthCommonDataStore.h.
|
private |
Input object decoration which specifies which objects to look at.
Definition at line 73 of file OverlapRemovalTool.h.
|
private |
jet-fatjet overlap handle
Definition at line 130 of file OverlapRemovalTool.h.
|
private |
Mu-jet overlap handle.
Definition at line 106 of file OverlapRemovalTool.h.
|
private |
Output object decoration which specifies overlapping objects.
Definition at line 75 of file OverlapRemovalTool.h.
|
private |
Toggle the output flag logic.
If true, then non-overlapping objects will be assigned "true".
Definition at line 79 of file OverlapRemovalTool.h.
|
private |
Pho-ele overlap handle.
Definition at line 118 of file OverlapRemovalTool.h.
|
private |
Pho-jet overlap handle.
Definition at line 124 of file OverlapRemovalTool.h.
|
private |
Pho-mu overlap handle.
Definition at line 121 of file OverlapRemovalTool.h.
|
private |
Require non-null container pointers when expected; i.e., when corresponding overlap tools are configured.
On by default.
Definition at line 83 of file OverlapRemovalTool.h.
|
private |
Tau-ele overlap handle.
Definition at line 109 of file OverlapRemovalTool.h.
|
private |
Tau-jet overlap handle.
Definition at line 115 of file OverlapRemovalTool.h.
|
private |
Tau-mu overlap handle.
Definition at line 112 of file OverlapRemovalTool.h.
|
privateinherited |
Definition at line 399 of file AthCommonDataStore.h.
|
privateinherited |
Definition at line 398 of file AthCommonDataStore.h.