![]() |
ATLAS Offline Software
|
A tool implementing the recommended tau-muon overlap removal. More...
#include <TauLooseMuOverlapTool.h>
Classes | |
| struct | Accessors |
| Columnar accessors. More... | |
Public Member Functions | |
| TauLooseMuOverlapTool (const std::string &name) | |
| Create proper constructor for Athena. | |
| virtual StatusCode | findOverlaps (columnar::Particle1Range cont1, columnar::Particle2Range cont2, columnar::EventContextId eventContext) const override |
| Identify overlapping taus and loose muons. | |
| virtual StatusCode | internalFindOverlaps (columnar::Particle1Range taus, columnar::Particle2Range muons) const |
| Identify overlapping taus and loose muons. | |
| StatusCode | findOverlaps (const xAOD::IParticleContainer &cont1, const xAOD::IParticleContainer &cont2, const EventContext &eventContext=Gaudi::Hive::currentContext()) const |
| StatusCode | initialize () override final |
| Initialize base class functionality. | |
| virtual void | callEvents (columnar::EventContextRange events) const override |
| The callEvents() for columnar tools. | |
| 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 | |
| virtual StatusCode | initializeDerived () override |
| Initialize the tool. | |
| template<columnar::RegularContainerIdConcept CI1, columnar::RegularContainerIdConcept CI2, typename CM> | |
| StatusCode | handleOverlap (const columnar::ObjectId< CI1, CM > &testParticle, const columnar::ObjectId< CI2, CM > &refParticle) const |
| Common helper method to handle an overlap result. | |
| template<typename XAODContainer, columnar::RegularContainerIdConcept CI, typename CM> | |
| StatusCode | checkForXAODContainer (columnar::ObjectRange< CI, CM > cont, std::string_view message) const |
| check whether the container is of the right type | |
| 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. | |
Helper Functions | |
| void | initializeDecorations (columnar::Particle1Range container) const |
| void | initializeDecorations (columnar::Particle2Range container) const |
| char | getObjectPriority (columnar::Particle1Id obj) const |
| char | getObjectPriority (columnar::Particle2Id obj) const |
| bool | isSurvivingObject (columnar::Particle1Id obj) const |
| bool | isSurvivingObject (columnar::Particle2Id obj) const |
| bool | isRejectedObject (columnar::Particle1Id obj) const |
| bool | isRejectedObject (columnar::Particle2Id obj) const |
| void | setObjectFail (columnar::Particle1Id obj) const |
| void | setObjectFail (columnar::Particle2Id obj) const |
| template<columnar::ContainerIdConcept CI> | |
| StatusCode | addObjectLink (columnar::Particle1Id p1, columnar::ObjectId< CI > p2) const |
| template<columnar::ContainerIdConcept CI> | |
| StatusCode | addObjectLink (columnar::Particle2Id p1, columnar::ObjectId< CI > p2) const |
Protected Attributes | |
Common configurable properties | |
| 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_linkOverlapObjects |
| Flag to toggle overlap object links. | |
| bool | m_enableUserPrio |
| Enable user-priority scoring. | |
Utilities | |
| std::unique_ptr< BaseAccessors > | m_baseAccessors {std::make_unique<BaseAccessors> (this)} |
| std::unique_ptr< OverlapDecorationHelper< columnar::ContainerId::particle1 > > | m_decHelper1 |
| Helper for handling input/output decorations. | |
| std::unique_ptr< OverlapDecorationHelper< columnar::ContainerId::particle2 > > | m_decHelper2 |
| std::unique_ptr< OverlapLinkHelper< columnar::ContainerId::particle1 > > | m_objLinkHelper1 |
| Helper for linking overlap objects. | |
| std::unique_ptr< OverlapLinkHelper< columnar::ContainerId::particle2 > > | m_objLinkHelper2 |
Private Types | |
| typedef ServiceHandle< StoreGateSvc > | StoreGateSvc_t |
Private Member Functions | |
| Gaudi::Details::PropertyBase & | declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &) |
| specialization for handling Gaudi::Property<SG::VarHandleKey> | |
Private Attributes | |
| float | m_maxDR |
| Maximum dR for objects flagged as overlap. | |
| bool | m_useRapidity |
| Calculate delta-R using rapidity. | |
| float | m_minMuPt |
| Minimum muon PT to reject a tau. | |
| float | m_minTauPtMuComb |
| Tau PT threshold to compare to combined muons only. | |
| std::unique_ptr< Accessors > | m_accessors {std::make_unique<Accessors> (this)} |
| std::unique_ptr< DeltaRMatcher > | m_dRMatcher |
| Delta-R matcher. | |
| 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 |
A tool implementing the recommended tau-muon overlap removal.
This implementation has a custom loose-muon selection as recommended in the harmonization document. Note: this functionality should be already available in the TauAnalysisTools package, but I'm adding it here for compatibility with the old OverlapRemovalTool.
Definition at line 35 of file TauLooseMuOverlapTool.h.
|
privateinherited |
Definition at line 388 of file AthCommonDataStore.h.
| ORUtils::TauLooseMuOverlapTool::TauLooseMuOverlapTool | ( | const std::string & | name | ) |
Create proper constructor for Athena.
Standalone constructor
Definition at line 26 of file TauLooseMuOverlapTool.cxx.
|
inlineprotectedinherited |
Definition at line 163 of file BaseOverlapTool.h.
|
inlineprotectedinherited |
Definition at line 166 of file BaseOverlapTool.h.
|
overridevirtualinherited |
The callEvents() for columnar tools.
Definition at line 65 of file BaseOverlapTool.cxx.
|
inlineprotectedinherited |
check whether the container is of the right type
Definition at line 83 of file BaseOverlapTool.h.
|
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
|
inlineinherited |
Definition at line 46 of file IOverlapTool.h.
|
overridevirtual |
Identify overlapping taus and loose muons.
TODO: add description of the method.
Implements ORUtils::IOverlapTool.
Definition at line 56 of file TauLooseMuOverlapTool.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.
|
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.
|
inlinenodiscardprotectedinherited |
Definition at line 146 of file BaseOverlapTool.h.
|
inlinenodiscardprotectedinherited |
Definition at line 148 of file BaseOverlapTool.h.
|
inherited |
Get one of the tool's properties.
|
protectedinherited |
Common helper method to handle an overlap result.
This method for now applies the user-defined object priorities set as the input decoration, so if the testParticle is higher prio than the refParticle, nothing happens. Otherwise, this method prints a debug message, decorates the testParticle as overlap, and optionally sets the object element link.
Unit conversion constant
Definition at line 177 of file BaseOverlapTool.h.
|
finaloverridevirtualinherited |
Initialize base class functionality.
Concrete tool specific initialization can be implemented by overriding the initializeDerived() method.
Reimplemented from asg::AsgTool.
Definition at line 32 of file BaseOverlapTool.cxx.
|
inlineprotectedinherited |
Definition at line 142 of file BaseOverlapTool.h.
|
inlineprotectedinherited |
Definition at line 144 of file BaseOverlapTool.h.
|
overrideprotectedvirtual |
Initialize the tool.
Reimplemented from ORUtils::BaseOverlapTool.
Definition at line 42 of file TauLooseMuOverlapTool.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.
|
virtual |
Identify overlapping taus and loose muons.
See the documentation in the above method.
Definition at line 72 of file TauLooseMuOverlapTool.cxx.
|
inlinenodiscardprotectedinherited |
Definition at line 154 of file BaseOverlapTool.h.
|
inlinenodiscardprotectedinherited |
Definition at line 156 of file BaseOverlapTool.h.
|
inlinenodiscardprotectedinherited |
Definition at line 150 of file BaseOverlapTool.h.
|
inlinenodiscardprotectedinherited |
Definition at line 152 of file BaseOverlapTool.h.
|
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.
|
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.
|
inlineprotectedinherited |
Definition at line 158 of file BaseOverlapTool.h.
|
inlineprotectedinherited |
Definition at line 160 of file BaseOverlapTool.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 |
Definition at line 89 of file TauLooseMuOverlapTool.h.
|
protectedinherited |
Definition at line 125 of file BaseOverlapTool.h.
|
protectedinherited |
Helper for handling input/output decorations.
Definition at line 128 of file BaseOverlapTool.h.
|
protectedinherited |
Definition at line 129 of file BaseOverlapTool.h.
|
privateinherited |
Pointer to StoreGate (detector store by default)
Definition at line 393 of file AthCommonDataStore.h.
|
private |
Delta-R matcher.
Definition at line 96 of file TauLooseMuOverlapTool.h.
|
protectedinherited |
Enable user-priority scoring.
Definition at line 111 of file BaseOverlapTool.h.
|
privateinherited |
Pointer to StoreGate (event store by default)
Definition at line 390 of file AthCommonDataStore.h.
|
protectedinherited |
Input object decoration which specifies which objects to look at.
Definition at line 99 of file BaseOverlapTool.h.
|
protectedinherited |
Flag to toggle overlap object links.
Definition at line 108 of file BaseOverlapTool.h.
|
private |
Maximum dR for objects flagged as overlap.
Definition at line 72 of file TauLooseMuOverlapTool.h.
|
private |
Minimum muon PT to reject a tau.
Definition at line 77 of file TauLooseMuOverlapTool.h.
|
private |
Tau PT threshold to compare to combined muons only.
Definition at line 79 of file TauLooseMuOverlapTool.h.
|
protectedinherited |
Helper for linking overlap objects.
Definition at line 132 of file BaseOverlapTool.h.
|
protectedinherited |
Definition at line 133 of file BaseOverlapTool.h.
|
protectedinherited |
Output object decoration which specifies overlapping objects.
Definition at line 101 of file BaseOverlapTool.h.
|
protectedinherited |
Toggle the output flag logic.
If true, then non-overlapping objects will be assigned "true".
Definition at line 105 of file BaseOverlapTool.h.
|
private |
Calculate delta-R using rapidity.
Definition at line 74 of file TauLooseMuOverlapTool.h.
|
privateinherited |
Definition at line 399 of file AthCommonDataStore.h.
|
privateinherited |
Definition at line 398 of file AthCommonDataStore.h.