![]() |
ATLAS Offline Software
|
JetModifier that actual does the background subtraction. This tool is the most important one applied to HI jets! More...
#include <HIJetConstituentSubtractionTool.h>
Public Member Functions | |
| HIJetConstituentSubtractionTool (const std::string &t) | |
| virtual StatusCode | initialize () override |
| Dummy implementation of the initialisation function. | |
| virtual StatusCode | modify (xAOD::JetContainer &jets) const override |
| Implementing abstract methods from base. | |
| virtual int | modifyJet (xAOD::Jet &) const override |
| Implementing abstract methods from base, not used. | |
| 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 | |
| const SG::ReadHandleKey< xAOD::HIEventShapeContainer > & | EventShapeKey () |
| Protected set/get functions provide access to private data members in derived classes. | |
| const std::string & | momentName () const |
| bool | momentOnly () const |
| void | setEventShapeKey (const SG::ReadHandleKey< xAOD::HIEventShapeContainer > &key) |
| void | setMomentName (const std::string &key) |
| void | setMomentOnly (bool x) |
| 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 | |
| ASG_TOOL_CLASS0 (HIJetConstituentSubtractionTool) | |
| Gaudi::Details::PropertyBase & | declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &) |
| specialization for handling Gaudi::Property<SG::VarHandleKey> | |
Private Attributes | |
| SG::ReadHandleKey< xAOD::HIEventShapeContainer > | m_eventShapeKey { this, "EventShapeKey", "", "The input HI Event Shape"} |
| Name of HIEventShapeContainer. | |
| Gaudi::Property< std::string > | m_momentName { this, "MomentName", HIJetRec::subtractedJetState(), "Subtracted Jet Kineamtics are stored using this string like a signal/state moment" } |
| Subtracted jet kinematics are stored using this string like a signal state/moment Jet::setJetP4 ( std::string, JetFourMom_t) not a key - but we bring it. | |
| Gaudi::Property< bool > | m_momentOnly |
| if this flag is set, the primary jet kinematics are also set to reflect this subtraction eventually do this w/ a signal state | |
| ToolHandle< IHISubtractorTool > | m_subtractorTool { this, "Subtractor", "HIJetClusterSubtractorTool", "" } |
| handle to IHISubtractorTool that determines the subtracted kinematics for each constituent | |
| ToolHandle< IHIUEModulatorTool > | m_modulatorTool { this, "Modulator" , "HIUEModulatorTool ", "" } |
| ToolHandle< IHIEventShapeMapTool > | m_eventShapeMapTool { this, "EventShapeMapTool", "HIEventShapeMapTool", "Handle to Event Shape Map Tool"} |
| Gaudi::Property< bool > | m_originCorrection { this, "ApplyOriginCorrection", false, "Apply Origin Correction boolean switch"} |
| 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 |
JetModifier that actual does the background subtraction. This tool is the most important one applied to HI jets!
Given an HIEventShapeContainer and subtractor tool it gets the subtracted kinematics for each constituent in a jet. The details of how the subtraction actually happens, e.g. navigating back to cells, is encapsulated in the subtractor tool.
Forseen that this may serve as a base class, thus private members have protected set/get functions. Initialization of these members is unambiguous as it is done by the base class.
Definition at line 43 of file HIJetConstituentSubtractionTool.h.
|
privateinherited |
Definition at line 388 of file AthCommonDataStore.h.
| HIJetConstituentSubtractionTool::HIJetConstituentSubtractionTool | ( | const std::string & | t | ) |
Definition at line 17 of file HIJetConstituentSubtractionTool.cxx.
|
private |
|
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.
|
inlineprotected |
Protected set/get functions provide access to private data members in derived classes.
Definition at line 90 of file HIJetConstituentSubtractionTool.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 |
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 23 of file HIJetConstituentSubtractionTool.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.
|
overridevirtual |
Implementing abstract methods from base.
Reimplemented from JetModifierBase.
Definition at line 33 of file HIJetConstituentSubtractionTool.cxx.
|
inlineoverridevirtual |
Implementing abstract methods from base, not used.
Reimplemented from JetModifierBase.
Definition at line 58 of file HIJetConstituentSubtractionTool.h.
|
inlineprotected |
Definition at line 93 of file HIJetConstituentSubtractionTool.h.
|
inlineprotected |
Definition at line 94 of file HIJetConstituentSubtractionTool.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.
|
inlineprotected |
Definition at line 96 of file HIJetConstituentSubtractionTool.h.
|
inlineprotected |
Definition at line 97 of file HIJetConstituentSubtractionTool.h.
|
inlineprotected |
Definition at line 98 of file HIJetConstituentSubtractionTool.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.
|
privateinherited |
Pointer to StoreGate (detector store by default)
Definition at line 393 of file AthCommonDataStore.h.
|
private |
Name of HIEventShapeContainer.
Definition at line 64 of file HIJetConstituentSubtractionTool.h.
|
private |
Definition at line 83 of file HIJetConstituentSubtractionTool.h.
|
privateinherited |
Pointer to StoreGate (event store by default)
Definition at line 390 of file AthCommonDataStore.h.
|
private |
Definition at line 82 of file HIJetConstituentSubtractionTool.h.
|
private |
Subtracted jet kinematics are stored using this string like a signal state/moment Jet::setJetP4 ( std::string, JetFourMom_t) not a key - but we bring it.
Definition at line 72 of file HIJetConstituentSubtractionTool.h.
|
private |
if this flag is set, the primary jet kinematics are also set to reflect this subtraction eventually do this w/ a signal state
Definition at line 77 of file HIJetConstituentSubtractionTool.h.
|
private |
Definition at line 85 of file HIJetConstituentSubtractionTool.h.
|
private |
handle to IHISubtractorTool that determines the subtracted kinematics for each constituent
Definition at line 81 of file HIJetConstituentSubtractionTool.h.
|
privateinherited |
Definition at line 399 of file AthCommonDataStore.h.
|
privateinherited |
Definition at line 398 of file AthCommonDataStore.h.