![]() |
ATLAS Offline Software
|
James Frost
November 2014.
More...
#include <JetVertexTaggerTool.h>
Public Member Functions | |
JetVertexTaggerTool (const std::string &name) | |
virtual | ~JetVertexTaggerTool () |
StatusCode | initialize () override |
Dummy implementation of the initialisation function. More... | |
virtual StatusCode | decorate (const xAOD::JetContainer &jetCont) const override |
Decorate a jet collection without otherwise modifying it. More... | |
float | evaluateJvt (float rpt, float jvfcorr) const |
float | updateJvt (const xAOD::Jet &jet) const override |
Calculate the updated JVT. More... | |
const xAOD::Vertex * | findHSVertex () const |
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 | sysInitialize () override |
Perform system initialization for an algorithm. 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 |
virtual StatusCode | modify (xAOD::JetContainer &jets) const override final |
Concrete implementation of the function inherited from IJetModifier. More... | |
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 ServiceHandle< StoreGateSvc > | StoreGateSvc_t |
Private Member Functions | |
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 | |
Gaudi::Property< std::string > | m_jetContainerName {this,"JetContainer", "", "SG key for the input jet container"} |
Gaudi::Property< std::string > | m_jvtlikelihoodHistName {this, "JVTLikelihoodHistName", "JVTRootCore_kNN100trim_pt20to50_Likelihood", "JVT likelihood histogram name"} |
Gaudi::Property< std::string > | m_jvtfileName {this, "JVTFileName", "JetMomentTools/JVTlikelihood_20140805.root", "JVT likelihood file name"} |
Gaudi::Property< bool > | m_suppressInputDeps {this, "SuppressInputDependence", false, "Will JVFCorr and SumPtTrk be created in the same algorithm that uses this tool?"} |
SG::ReadHandleKey< xAOD::VertexContainer > | m_vertexContainer_key {this, "VertexContainer", "PrimaryVertices", "SG key for input vertex container"} |
SG::ReadDecorHandleKey< xAOD::JetContainer > | m_jvfCorrKey {this, "JVFCorrName", "JVFCorr", "SG key for input JVFCorr decoration"} |
SG::ReadDecorHandleKey< xAOD::JetContainer > | m_jvfCorrVtxKey |
SG::ReadDecorHandleKey< xAOD::JetContainer > | m_sumPtTrkKey {this, "SumPtTrkName", "SumPtTrkPt500", "SG key for input SumPtTrk decoration"} |
SG::WriteDecorHandleKey< xAOD::JetContainer > | m_jvtKey {this, "JVTName", "Jvt", "SG key for output JVT decoration"} |
SG::WriteDecorHandleKey< xAOD::JetContainer > | m_jvtVecKey |
SG::WriteDecorHandleKey< xAOD::JetContainer > | m_rptKey {this, "RpTName", "JvtRpt", "SG key for output RpT decoration"} |
SG::WriteDecorHandleKey< xAOD::JetContainer > | m_rptVecKey |
Gaudi::Property< bool > | m_useOriginVertex = {this, "UseOriginVertex", false, "use origin vertex for each jet"} |
TString | m_fn |
TH2F * | m_jvthisto |
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 |
James Frost
November 2014.
Updated for Run 3 by Bill Balunas March 2020
Tool to calculate the jet vertex tag (JVT) JVT is a float per jet
The JVT likelihood is parameterised in terms of: RPT: ratio of the primary vertex track sum to the jet pT JVFCorr: a corrected JVF calculation accounting for the number of PU tracks in the event.
Calculation requires three main types of information
Using this information, the procedure can be broken into three main steps:
Attributes added (each is a float per jet):
Properties: JetContainer - name of the jet container VertexContainer - name of the vertex container TrackParticleContainer - name of the track container AssociatedTracks - name for attribute holding the list of associated tracks TrackVertexAssociation - name for the container holding the track-vertex associations TrackSelector - tool to select tracks (none ==> no selection) JVTFileName - ROOT Filename containing JVT likelihood histogram JVTLikelihoodHistName - JVT Likelihood histogram name JVTName - name for the 3 JVT attributes (default is "JVT") K_JVFCorrScale - the scale factor for pileup tracks in the JVFCorr calculation (default is 0.01) Z0Cut - Z0 value (in mm) within which tracks associated to no vertex may be assigned to the primary vertex (default is 3.) PUTrkPtCut - the track pT (in MeV) below which tracks associated to no vertex may be assigned to the primary vertex (default is 30000.)
Definition at line 78 of file JetVertexTaggerTool.h.
|
privateinherited |
Definition at line 388 of file AthCommonDataStore.h.
JetVertexTaggerTool::JetVertexTaggerTool | ( | const std::string & | name | ) |
Definition at line 23 of file JetVertexTaggerTool.cxx.
|
virtual |
Definition at line 31 of file JetVertexTaggerTool.cxx.
|
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.
|
overridevirtual |
Decorate a jet collection without otherwise modifying it.
Implements IJetDecorator.
Definition at line 99 of file JetVertexTaggerTool.cxx.
|
inlineinherited |
The standard StoreGateSvc/DetectorStore
Returns (kind of) a pointer to the StoreGateSvc
.
Definition at line 95 of file AthCommonDataStore.h.
float JetVertexTaggerTool::evaluateJvt | ( | float | rpt, |
float | jvfcorr | ||
) | const |
Definition at line 184 of file JetVertexTaggerTool.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.
|
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
const xAOD::Vertex * JetVertexTaggerTool::findHSVertex | ( | ) | const |
Definition at line 234 of file JetVertexTaggerTool.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.
|
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 37 of file JetVertexTaggerTool.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.
|
inlinefinaloverridevirtualinherited |
Concrete implementation of the function inherited from IJetModifier.
Implements IJetModifier.
Definition at line 32 of file IJetDecorator.h.
|
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.
|
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.
|
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 DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.
|
overridevirtualinherited |
Handle START transition.
We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.
Calculate the updated JVT.
jet - jet for which JVT is updated The new value for JVT is returned.
Implements IJetUpdateJvt.
Definition at line 200 of file JetVertexTaggerTool.cxx.
|
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.
|
privateinherited |
Pointer to StoreGate (event store by default)
Definition at line 390 of file AthCommonDataStore.h.
|
private |
Definition at line 126 of file JetVertexTaggerTool.h.
|
private |
Definition at line 109 of file JetVertexTaggerTool.h.
|
private |
Definition at line 115 of file JetVertexTaggerTool.h.
|
private |
Definition at line 116 of file JetVertexTaggerTool.h.
|
private |
Definition at line 111 of file JetVertexTaggerTool.h.
|
private |
Definition at line 127 of file JetVertexTaggerTool.h.
|
private |
Definition at line 118 of file JetVertexTaggerTool.h.
|
private |
Definition at line 110 of file JetVertexTaggerTool.h.
|
private |
Definition at line 119 of file JetVertexTaggerTool.h.
|
private |
Definition at line 120 of file JetVertexTaggerTool.h.
|
private |
Definition at line 121 of file JetVertexTaggerTool.h.
|
private |
Definition at line 117 of file JetVertexTaggerTool.h.
|
private |
Definition at line 112 of file JetVertexTaggerTool.h.
|
private |
Definition at line 123 of file JetVertexTaggerTool.h.
|
privateinherited |
Definition at line 399 of file AthCommonDataStore.h.
|
private |
Definition at line 114 of file JetVertexTaggerTool.h.
|
privateinherited |
Definition at line 398 of file AthCommonDataStore.h.