![Logo](../../ATLAS-Logo-Square-Blue-RGB.png) |
ATLAS Offline Software
|
#include <JetVertexNNTagger.h>
|
| JetVertexNNTagger (const std::string &name) |
| Constructor with a tool name. More...
|
|
| ~JetVertexNNTagger () |
| Destructor. More...
|
|
virtual 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...
|
|
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...
|
|
|
std::unique_ptr< lwt::generic::FastGraph< double > > | m_lwnn {nullptr} |
| Internal members for interpreting jet inputs and NN configuration. More...
|
|
NNJvtCutMap | m_cutMap |
|
Gaudi::Property< std::string > | m_jetContainerName {this,"JetContainer", "", "SG key for the input jet container"} |
|
Gaudi::Property< bool > | m_suppressInputDeps {this, "SuppressInputDependence", false, "Will JVFCorr and SumPtTrk be created in the same algorithm that uses this tool?"} |
|
Gaudi::Property< bool > | m_suppressOutputDeps {this, "SuppressOutputDependence", false, "Ignore creating the output decoration dependency for data flow; for analysis"} |
|
Gaudi::Property< std::string > | m_NNConfigDir {this,"NNConfigDir", "JetPileupTag/NNJvt/2022-03-22", "PathResolver-accessible directory holding config files"} |
|
Gaudi::Property< std::string > | m_NNParamFileName {this,"NNParamFile", "NNJVT.Network.graph.Offline.Nonprompt_All_MaxWeight.json", "Name of json file containing network parameters"} |
|
Gaudi::Property< std::string > | m_NNCutFileName {this,"NNCutFile", "NNJVT.Cuts.FixedEffPt.Offline.Nonprompt_All_MaxW.json", "Name of json file containing network parameters"} |
|
Gaudi::Property< float > | m_maxpt_for_cut {this,"MaxPtForCut", 60*GeV, "Jet pt above which no cut is applied"} |
|
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_sumPtTrkKey {this, "SumPtTrkName", "SumPtTrkPt500", "SG key for input SumPtTrk decoration"} |
|
SG::WriteDecorHandleKey< xAOD::JetContainer > | m_jvtKey {this, "JVTName", "NNJvt", "SG key for output JVT decoration"} |
|
SG::WriteDecorHandleKey< xAOD::JetContainer > | m_rptKey {this, "RpTName", "NNJvtRpt", "SG key for output RpT decoration"} |
|
SG::WriteDecorHandleKey< xAOD::JetContainer > | m_passJvtKey {this, "passJvtName", "NNJvtPass", "SG key for output pass-JVT decoration"} |
|
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 |
|
Definition at line 44 of file JetVertexNNTagger.h.
◆ StoreGateSvc_t
◆ JetVertexNNTagger()
JetVertexNNTagger::JetVertexNNTagger |
( |
const std::string & |
name | ) |
|
◆ ~JetVertexNNTagger()
JetVertexNNTagger::~JetVertexNNTagger |
( |
| ) |
|
|
default |
◆ declareGaudiProperty() [1/4]
specialization for handling Gaudi::Property<SG::VarHandleKeyArray>
Definition at line 170 of file AthCommonDataStore.h.
175 hndl.documentation());
◆ declareGaudiProperty() [2/4]
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition at line 156 of file AthCommonDataStore.h.
161 hndl.documentation());
◆ declareGaudiProperty() [3/4]
specialization for handling Gaudi::Property<SG::VarHandleBase>
Definition at line 184 of file AthCommonDataStore.h.
189 hndl.documentation());
◆ declareGaudiProperty() [4/4]
◆ declareProperty() [1/6]
Declare a new Gaudi property.
- Parameters
-
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.
250 this->declare(hndl.
vhKey());
251 hndl.
vhKey().setOwner(
this);
◆ declareProperty() [2/6]
Declare a new Gaudi property.
- Parameters
-
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.
◆ declareProperty() [3/6]
◆ declareProperty() [4/6]
Declare a new Gaudi property.
- Parameters
-
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.
◆ declareProperty() [5/6]
Declare a new Gaudi property.
- Parameters
-
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.
◆ declareProperty() [6/6]
◆ decorate()
Decorate a jet collection without otherwise modifying it.
Implements IJetDecorator.
Definition at line 146 of file JetVertexNNTagger.cxx.
156 ATH_MSG_WARNING(
"Invalid primary vertex found, will not continue decorating with JVT.");
157 return StatusCode::FAILURE;
166 static constexpr
float invalidJvt = -1;
167 static constexpr
float invalidRpt = 0;
168 static constexpr
char invalidPassJvt =
true;
172 float jvt = invalidJvt;
173 float rpt = invalidRpt;
174 char passJvt = invalidPassJvt;
178 float jvfcorr = jvfCorrHandle(*
jet);
179 std::vector<float> sumpttrk = sumPtTrkHandle(*
jet);
180 rpt = sumpttrk[HSvertex->
index() - vertices[0]->index()]/
jet->pt();
182 size_t ptbin, etabin;
185 float jvtCut =
m_cutMap(ptbin, etabin);
186 passJvt = jvt > jvtCut;
190 ATH_MSG_VERBOSE(
" --> inputs: corrJVF " << jvfcorr <<
", rpt " << rpt );
191 ATH_MSG_VERBOSE(
"JVT cut for ptbin " << ptbin <<
", etabin " << etabin <<
" = " << jvtCut);
192 ATH_MSG_VERBOSE(
"Evaluated JVT = " << jvt <<
", jet " << (passJvt ?
"passes" :
"fails") <<
" working point" );
197 jvtHandle(*
jet) = jvt;
198 if (!rptHandle.key().empty())
199 rptHandle(*
jet) = rpt;
200 if (!passJvtHandle.key().empty())
201 passJvtHandle(*
jet) = passJvt;
204 return StatusCode::SUCCESS;
◆ detStore()
◆ evaluateJvt()
float JetVertexNNTagger::evaluateJvt |
( |
float |
rpt, |
|
|
float |
jvfcorr, |
|
|
size_t |
ptbin, |
|
|
size_t |
etabin |
|
) |
| const |
|
private |
Definition at line 116 of file JetVertexNNTagger.cxx.
119 lwt::VectorX<double> inputvals =
lwt::build_vector({rpt,jvfcorr,
static_cast<double>(ptbin),
static_cast<double>(etabin)});
120 std::vector<lwt::VectorX<double> > scalars{inputvals};
◆ evtStore() [1/2]
◆ evtStore() [2/2]
◆ extraDeps_update_handler()
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
◆ findHSVertex()
◆ getKey()
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.
- See also
- asg::AsgTool::getName
- Parameters
-
ptr | The bare pointer to the object that the event store should know about |
- Returns
- The hashed key of the object in the store. If not found, an invalid (zero) key.
Definition at line 119 of file AsgTool.cxx.
121 #ifdef XAOD_STANDALONE
124 return evtStore()->event()->getKey( ptr );
127 return (
proxy ==
nullptr ? 0 :
proxy->sgkey() );
128 #endif // XAOD_STANDALONE
◆ getName()
const std::string & asg::AsgTool::getName |
( |
const void * |
ptr | ) |
const |
|
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.
- See also
- asg::AsgTool::getKey
- Parameters
-
ptr | The bare pointer to the object that the event store should know about |
- Returns
- The string name of the object in the store. If not found, an empty string.
Definition at line 106 of file AsgTool.cxx.
108 #ifdef XAOD_STANDALONE
111 return evtStore()->event()->getName( ptr );
114 static const std::string
dummy =
"";
116 #endif // XAOD_STANDALONE
◆ getProperty()
template<class T >
const T* asg::AsgTool::getProperty |
( |
const std::string & |
name | ) |
const |
|
inherited |
Get one of the tool's properties.
◆ initialize()
StatusCode JetVertexNNTagger::initialize |
( |
| ) |
|
|
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 34 of file JetVertexNNTagger.cxx.
40 ATH_MSG_ERROR(
"JetVertexTaggerTool needs to have its input jet container configured!");
41 return StatusCode::FAILURE;
47 ATH_MSG_INFO(
" resolved in :\n " << configPath <<
"\n\n");
49 std::ifstream fconfig( configPath.c_str() );
50 if ( !fconfig.is_open() ) {
52 ATH_MSG_ERROR(
"Are you sure that the file exists at this path?" );
53 return StatusCode::FAILURE;
56 ATH_MSG_INFO(
"\n Reading JVT likelihood histogram from:\n " << configPath <<
"\n\n");
60 lwt::InputOrder
order;
62 std::vector<std::string>
inputs = {
"Rpt",
"JVFCorr",
"ptbin",
"etabin"};
64 node_order.emplace_back(
cfg.inputs[0].name,
inputs);
65 order.scalar = node_order;
69 m_lwnn = std::make_unique<lwt::generic::FastGraph<double> >(
cfg,
order);
74 std::ifstream fcuts( cutsPath.c_str() );
75 if ( !fcuts.is_open() ) {
77 ATH_MSG_ERROR(
"Are you sure that the file exists at this path?" );
78 return StatusCode::FAILURE;
91 #ifndef XAOD_STANDALONE
111 return StatusCode::SUCCESS;
◆ inputHandles()
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.
◆ modify()
|
inlinefinaloverridevirtualinherited |
◆ msg() [1/2]
◆ msg() [2/2]
◆ msg_level_name()
const std::string & asg::AsgTool::msg_level_name |
( |
| ) |
const |
|
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:
MSG::name( msg().level() )
This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.
- Returns
- The string name of the current minimum message level that's printed
Definition at line 101 of file AsgTool.cxx.
◆ msgLvl()
◆ outputHandles()
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.
◆ print()
void asg::AsgTool::print |
( |
| ) |
const |
|
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.
◆ renounce()
◆ renounceArray()
◆ sysInitialize()
◆ sysStart()
Handle START transition.
We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.
◆ updateVHKA()
◆ m_cutMap
◆ m_detStore
◆ m_evtStore
◆ m_jetContainerName
Gaudi::Property<std::string> JetPileupTag::JetVertexNNTagger::m_jetContainerName {this,"JetContainer", "", "SG key for the input jet container"} |
|
private |
◆ m_jvfCorrKey
◆ m_jvtKey
◆ m_lwnn
std::unique_ptr<lwt::generic::FastGraph<double> > JetPileupTag::JetVertexNNTagger::m_lwnn {nullptr} |
|
private |
Internal members for interpreting jet inputs and NN configuration.
Definition at line 72 of file JetVertexNNTagger.h.
◆ m_maxpt_for_cut
Gaudi::Property<float> JetPileupTag::JetVertexNNTagger::m_maxpt_for_cut {this,"MaxPtForCut", 60*GeV, "Jet pt above which no cut is applied"} |
|
private |
◆ m_NNConfigDir
Gaudi::Property<std::string> JetPileupTag::JetVertexNNTagger::m_NNConfigDir {this,"NNConfigDir", "JetPileupTag/NNJvt/2022-03-22", "PathResolver-accessible directory holding config files"} |
|
private |
◆ m_NNCutFileName
◆ m_NNParamFileName
◆ m_passJvtKey
◆ m_rptKey
◆ m_sumPtTrkKey
◆ m_suppressInputDeps
Gaudi::Property<bool> JetPileupTag::JetVertexNNTagger::m_suppressInputDeps {this, "SuppressInputDependence", false, "Will JVFCorr and SumPtTrk be created in the same algorithm that uses this tool?"} |
|
private |
◆ m_suppressOutputDeps
Gaudi::Property<bool> JetPileupTag::JetVertexNNTagger::m_suppressOutputDeps {this, "SuppressOutputDependence", false, "Ignore creating the output decoration dependency for data flow; for analysis"} |
|
private |
◆ m_varHandleArraysDeclared
◆ m_vertexContainer_key
◆ m_vhka
The documentation for this class was generated from the following files:
Gaudi::Property< float > m_maxpt_for_cut
float evaluateJvt(float rpt, float jvfcorr, size_t ptbin, size_t etabin) const
SG::WriteDecorHandleKey< xAOD::JetContainer > m_jvtKey
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
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)
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
std::vector< SG::VarHandleKeyArray * > m_vhka
const xAOD::Vertex * findHSVertex(const xAOD::VertexContainer &vertices) const
#define ATH_MSG_VERBOSE(x)
VxType::VertexType vertexType() const
The type of the vertex.
@ NoVtx
Dummy vertex. TrackParticle was not used in vertex fit.
Gaudi::Property< bool > m_suppressOutputDeps
virtual void setOwner(IDataHandleHolder *o)=0
static NNJvtCutMap fromJSON(std::istream &is)
SG::ReadCondHandle< T > makeHandle(const SG::ReadCondHandleKey< T > &key, const EventContext &ctx=Gaudi::Hive::currentContext())
ServiceHandle< StoreGateSvc > & evtStore()
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
Handle class for reading a decoration on an object.
SG::ReadHandleKey< xAOD::VertexContainer > m_vertexContainer_key
SG::WriteDecorHandleKey< xAOD::JetContainer > m_rptKey
Handle class for adding a decoration to an object.
std::vector< std::pair< std::string, std::vector< std::string > > > order_t
const std::string & name(Level lvl)
Convenience function for translating message levels to strings.
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
VectorXd build_vector(const std::vector< double > &bias)
size_t index() const
Return the index of this element within its container.
virtual void renounce()=0
std::conditional< std::is_base_of< SG::VarHandleKeyArray, T >::value, VarHandleKeyArrayType, type2 >::type type
Gaudi::Property< std::string > m_jetContainerName
Gaudi::Property< std::string > m_NNConfigDir
std::string PathResolverFindCalibFile(const std::string &logical_file_name)
GraphConfig parse_json_graph(std::istream &json)
Gaudi::Property< bool > m_suppressInputDeps
Class describing a Vertex.
virtual StatusCode decorate(const xAOD::JetContainer &jets) const =0
Decorate a jet collection without otherwise modifying it.
#define ATH_MSG_WARNING(x)
SG::ReadDecorHandleKey< xAOD::JetContainer > m_jvfCorrKey
SG::WriteDecorHandleKey< xAOD::JetContainer > m_passJvtKey
SG::ReadDecorHandleKey< xAOD::JetContainer > m_sumPtTrkKey
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
Gaudi::Property< std::string > m_NNCutFileName
std::unique_ptr< lwt::generic::FastGraph< double > > m_lwnn
Internal members for interpreting jet inputs and NN configuration.
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Gaudi::Property< std::string > m_NNParamFileName