![]() |
ATLAS Offline Software
|
Evaluates the TausRUs network and decorates its predictions on the tau and on its tracks. More...
#include <TausRUsEvaluator.h>
Classes | |
| struct | Output |
Public Types | |
| enum | PrimaryClass : size_t { QCD = 0 , Tau = 1 , Electron = 2 } |
| Class order of the 'primary' head, which is three raw logits. More... | |
| enum | PhiComponent : size_t { PHI_SIN = 0 , PHI_COS = 1 } |
| The two components of a phi head, which regresses the angle as a point on the unit circle: phi = atan2(sin, cos). More... | |
Public Member Functions | |
| TausRUsEvaluator (const std::string &name="TausRUsEvaluator") | |
| virtual | ~TausRUsEvaluator () |
| virtual StatusCode | initialize () override |
| Tool initializer. | |
| virtual StatusCode | execute (xAOD::TauJet &tau) const override |
| Execute - called for each tau candidate. | |
| virtual StatusCode | eventInitialize () override |
| Event initializer - called at the beginning of each event. | |
| virtual StatusCode | executePi0CreateROI (xAOD::TauJet &pTau, CaloConstCellContainer &caloCellContainer, boost::dynamic_bitset<> &map) const override |
| virtual StatusCode | executeVertexFinder (xAOD::TauJet &pTau, const xAOD::VertexContainer *vertexContainer=nullptr) const override |
| virtual StatusCode | executeTrackFinder (xAOD::TauJet &pTau, xAOD::TauTrackContainer &tauTrackContainer) const override |
| virtual StatusCode | executeTrackClassifier (xAOD::TauJet &pTau, xAOD::TauTrackContainer &tauTrackContainer) const override |
| virtual StatusCode | executeShotFinder (xAOD::TauJet &pTau, xAOD::CaloClusterContainer &shotClusterContainer, xAOD::PFOContainer &PFOContainer) const override |
| virtual StatusCode | executePi0ClusterCreator (xAOD::TauJet &pTau, xAOD::PFOContainer &neutralPFOContainer, xAOD::PFOContainer &hadronicPFOContainer, const xAOD::CaloClusterContainer &pCaloClusterContainer) const override |
| virtual StatusCode | executeVertexVariables (xAOD::TauJet &pTau, xAOD::VertexContainer &vertexContainer) const override |
| virtual StatusCode | executePi0ClusterScaler (xAOD::TauJet &pTau, xAOD::PFOContainer &neutralPFOContainer, xAOD::PFOContainer &chargedPFOContainer) const override |
| virtual StatusCode | executePi0nPFO (xAOD::TauJet &pTau, xAOD::PFOContainer &neutralPFOContainer) const override |
| virtual StatusCode | executePanTau (xAOD::TauJet &pTau, xAOD::ParticleContainer &particleContainer, xAOD::PFOContainer &neutralPFOContainer) const override |
| virtual StatusCode | eventFinalize () override |
| Event finalizer - called at the end of each event. | |
| virtual StatusCode | finalize () override |
| Finalizer. | |
| std::string | find_file (const std::string &fname) const |
| 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. | |
Static Public Attributes | |
| static constexpr float | DEFAULT_VALUE = -1111.0f |
| initialized with these default values | |
| static constexpr int | DEFAULT_CLASS = -1 |
| static constexpr int | TAU_TRACK_CLASS = 0 |
| Class for true-tau track from tau_track_class head. | |
Protected Member Functions | |
| bool | inTrigger () const |
| bool | inAOD () const |
| bool | inEleRM () const |
| 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. | |
Protected Attributes | |
| Gaudi::Property< bool > | m_in_trigger {this, "inTrigger", false, "Indicate if the tool is running on trigger"} |
| Gaudi::Property< bool > | m_in_AOD {this, "inAOD", false, "Indicate if the tool is running on AOD"} |
| Gaudi::Property< bool > | m_in_EleRM {this, "inEleRM", false, "Indicate if the tool is running on EleRM routine"} |
| Gaudi::Property< std::string > | m_tauRecToolsTag {this, "calibFolder", "tauRecTools/R22_preprod", "CVMFS path to the tau calibration folder"} |
Private Types | |
| using | FourMomDecorators = std::vector<SG::Accessor<float>> |
| typedef ServiceHandle< StoreGateSvc > | StoreGateSvc_t |
Private Member Functions | |
| StatusCode | readModel (const std::string &path) |
| Configure the data loader and build m_outputs from the metadata and node shapes of the model. | |
| void | setDefaults (xAOD::TauJet &tau) const |
| void | decorateFourMomentum (xAOD::TauJet &tau, const FourMomDecorators &decorators, std::span< const float > ptQuantiles, std::span< const float > etaValues, std::span< const float > phiValues, float mass) const |
Decorate the four floats of decorators from a pt, an eta and a phi head, taking the mass from mass. | |
| void | decorateVertex (xAOD::TauJet &tau, std::span< const float > scoresscores, const std::vector< const xAOD::Vertex * > &vertices) const |
Decorate the position of the vertex that scores picks out of vertices, which must be the list the input tensor was built from. | |
| void | decorateTracks (xAOD::TauJet &tau, std::span< const float > scoresscores) const |
Decorate each track of tau with its slot of the per-track head. | |
| std::vector< std::string > | tauDecorationNames () const |
| Every decoration written on the tau, and every one written on its tracks, which is what the output data dependencies are declared from. | |
| std::vector< std::string > | trackDecorationNames () const |
| Gaudi::Details::PropertyBase & | declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &) |
| specialization for handling Gaudi::Property<SG::VarHandleKey> | |
Evaluates the TausRUs network and decorates its predictions on the tau and on its tracks.
The input and output nodes are read from the "metadata" JSON the model carries. Inputs are built by TausRUsDataLoader.
Nothing is decorated as it comes out of the graph. This tool owns the whole translation into quantities that stand on their own:
TausRUsTauIDScore tau vs QCD, a two-class softmax over those two logits of the 'primary' head TausRUsEleRejScore tau vs electron, the same over that pair TausRUsDecayMode decay mode decision, and TausRUsDecayModeScore the raw scores it is the argmax of TausRUsTauP4_* the regressed tau four-momentum, and TausRUsChargedPionP4_* the two pion four-momenta, each four floats, TausRUsNeutralPionP4_* _pt, _eta, _phi and _m. The mass is the PDG mass of the particle. TausRUsVertex_x/_y/_z position of the vertex the 'vertex_classification' head picks out of the event vertex collection TausRUsTauCharge sum of the charges of the tracks classified as tau tracks, kept only when it is -1 or +1, else 0
Then, per xAOD::TauTrack the following are parsed
TausRUsTrackClass track class decision, and TausRUsTrackScore the raw scores it is the argmax of
Definition at line 60 of file TausRUsEvaluator.h.
|
private |
Definition at line 93 of file TausRUsEvaluator.h.
|
privateinherited |
Definition at line 388 of file AthCommonDataStore.h.
| enum TausRUsEvaluator::PhiComponent : size_t |
The two components of a phi head, which regresses the angle as a point on the unit circle: phi = atan2(sin, cos).
| Enumerator | |
|---|---|
| PHI_SIN | |
| PHI_COS | |
Definition at line 89 of file TausRUsEvaluator.h.
| enum TausRUsEvaluator::PrimaryClass : size_t |
Class order of the 'primary' head, which is three raw logits.
| Enumerator | |
|---|---|
| QCD | |
| Tau | |
| Electron | |
Definition at line 82 of file TausRUsEvaluator.h.
| TausRUsEvaluator::TausRUsEvaluator | ( | const std::string & | name = "TausRUsEvaluator" | ) |
Definition at line 85 of file TausRUsEvaluator.cxx.
|
virtual |
Definition at line 93 of file TausRUsEvaluator.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.
|
private |
Decorate the four floats of decorators from a pt, an eta and a phi head, taking the mass from mass.
Definition at line 349 of file TausRUsEvaluator.cxx.
|
private |
Decorate each track of tau with its slot of the per-track head.
Definition at line 390 of file TausRUsEvaluator.cxx.
|
private |
Decorate the position of the vertex that scores picks out of vertices, which must be the list the input tensor was built from.
Definition at line 371 of file TausRUsEvaluator.cxx.
|
inlineinherited |
The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
Definition at line 95 of file AthCommonDataStore.h.
|
overridevirtualinherited |
Event finalizer - called at the end of each event.
Implements ITauToolBase.
Definition at line 105 of file TauRecToolBase.cxx.
|
overridevirtualinherited |
Event initializer - called at the beginning of each event.
Implements ITauToolBase.
Definition at line 36 of file TauRecToolBase.cxx.
|
inlineinherited |
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
Definition at line 85 of file AthCommonDataStore.h.
|
overridevirtual |
Execute - called for each tau candidate.
Reimplemented from TauRecToolBase.
Definition at line 416 of file TausRUsEvaluator.cxx.
|
overridevirtualinherited |
Implements ITauToolBase.
Reimplemented in PanTau::PanTauProcessor.
Definition at line 100 of file TauRecToolBase.cxx.
|
overridevirtualinherited |
Implements ITauToolBase.
Reimplemented in TauPi0ClusterCreator.
Definition at line 78 of file TauRecToolBase.cxx.
|
overridevirtualinherited |
Implements ITauToolBase.
Reimplemented in TauPi0ClusterScaler.
Definition at line 90 of file TauRecToolBase.cxx.
|
overridevirtualinherited |
Implements ITauToolBase.
Reimplemented in TauPi0CreateROI.
Definition at line 52 of file TauRecToolBase.cxx.
|
overridevirtualinherited |
Implements ITauToolBase.
Reimplemented in TauPi0ScoreCalculator, and TauPi0Selector.
Definition at line 95 of file TauRecToolBase.cxx.
|
overridevirtualinherited |
Implements ITauToolBase.
Reimplemented in TauShotFinder.
Definition at line 73 of file TauRecToolBase.cxx.
|
overridevirtualinherited |
Implements ITauToolBase.
Reimplemented in tauRecTools::TauTrackRNNClassifier.
Definition at line 68 of file TauRecToolBase.cxx.
|
overridevirtualinherited |
Implements ITauToolBase.
Reimplemented in TauTrackFinder.
Definition at line 63 of file TauRecToolBase.cxx.
|
overridevirtualinherited |
Implements ITauToolBase.
Reimplemented in TauVertexFinder.
Definition at line 58 of file TauRecToolBase.cxx.
|
overridevirtualinherited |
Implements ITauToolBase.
Reimplemented in TauVertexVariables.
Definition at line 85 of file TauRecToolBase.cxx.
|
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
|
overridevirtualinherited |
Finalizer.
Implements ITauToolBase.
Reimplemented in PanTau::PanTauProcessor.
Definition at line 109 of file TauRecToolBase.cxx.
|
inherited |
Definition at line 19 of file TauRecToolBase.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::Event 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::Event 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.
|
inlineprotectedinherited |
Definition at line 87 of file TauRecToolBase.h.
|
inlineprotectedinherited |
Definition at line 88 of file TauRecToolBase.h.
|
overridevirtual |
Tool initializer.
Reimplemented from TauRecToolBase.
Definition at line 189 of file TausRUsEvaluator.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.
|
inlineprotectedinherited |
Definition at line 86 of file TauRecToolBase.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, and KtDeltaRTool.
Definition at line 131 of file AsgTool.cxx.
|
private |
Configure the data loader and build m_outputs from the metadata and node shapes of the model.
Definition at line 99 of file TausRUsEvaluator.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 321 of file TausRUsEvaluator.cxx.
|
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 >, and AthCheckedComponent<::AthAlgTool >.
|
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 |
Every decoration written on the tau, and every one written on its tracks, which is what the output data dependencies are declared from.
Definition at line 297 of file TausRUsEvaluator.cxx.
|
private |
Definition at line 313 of file TausRUsEvaluator.cxx.
|
inlineinherited |
Definition at line 308 of file AthCommonDataStore.h.
|
staticconstexpr |
Definition at line 72 of file TausRUsEvaluator.h.
|
staticconstexpr |
initialized with these default values
Definition at line 71 of file TausRUsEvaluator.h.
|
private |
Definition at line 162 of file TausRUsEvaluator.h.
|
private |
Definition at line 158 of file TausRUsEvaluator.h.
|
private |
Definition at line 160 of file TausRUsEvaluator.h.
|
private |
Definition at line 169 of file TausRUsEvaluator.h.
|
privateinherited |
Pointer to StoreGate (detector store by default).
Definition at line 393 of file AthCommonDataStore.h.
|
private |
Definition at line 157 of file TausRUsEvaluator.h.
|
privateinherited |
Pointer to StoreGate (event store by default).
Definition at line 390 of file AthCommonDataStore.h.
|
protectedinherited |
Definition at line 76 of file TauRecToolBase.h.
|
protectedinherited |
Definition at line 77 of file TauRecToolBase.h.
|
protectedinherited |
Definition at line 75 of file TauRecToolBase.h.
|
private |
Definition at line 121 of file TausRUsEvaluator.h.
|
private |
Definition at line 139 of file TausRUsEvaluator.h.
|
private |
Definition at line 136 of file TausRUsEvaluator.h.
|
private |
Definition at line 127 of file TausRUsEvaluator.h.
|
private |
|
private |
Definition at line 163 of file TausRUsEvaluator.h.
|
private |
Definition at line 147 of file TausRUsEvaluator.h.
|
private |
Definition at line 146 of file TausRUsEvaluator.h.
|
private |
The model's output nodes, from its metadata.
Definition at line 142 of file TausRUsEvaluator.h.
|
private |
The pt heads ('tes', 'charged_pion_pt', 'neutral_pion_pt') regress quantiles of the log response, log(pt_seedjet / pt_true).
This is the index of the median, the one to take as the point estimate; the pt then follows as pt = exp(log(ptJetSeed) - quantile[m_ptMedianQuantile]).
Definition at line 152 of file TausRUsEvaluator.h.
|
private |
Definition at line 159 of file TausRUsEvaluator.h.
|
private |
Definition at line 130 of file TausRUsEvaluator.h.
|
private |
The decorators.
The scalar ones are named in the constructor and the rest, which are one decoration per class or per component, in initialize().
Definition at line 156 of file TausRUsEvaluator.h.
|
private |
Definition at line 161 of file TausRUsEvaluator.h.
|
protectedinherited |
Definition at line 78 of file TauRecToolBase.h.
|
private |
Definition at line 133 of file TausRUsEvaluator.h.
|
private |
Definition at line 166 of file TausRUsEvaluator.h.
|
private |
Definition at line 170 of file TausRUsEvaluator.h.
|
private |
Definition at line 167 of file TausRUsEvaluator.h.
|
privateinherited |
Definition at line 399 of file AthCommonDataStore.h.
|
private |
Definition at line 124 of file TausRUsEvaluator.h.
|
private |
Definition at line 164 of file TausRUsEvaluator.h.
|
privateinherited |
Definition at line 398 of file AthCommonDataStore.h.
|
staticconstexpr |
Class for true-tau track from tau_track_class head.
Definition at line 85 of file TausRUsEvaluator.h.