ATLAS Offline Software
Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
JetPileupTag::JetVertexNNTagger Class Reference

#include <JetVertexNNTagger.h>

Inheritance diagram for JetPileupTag::JetVertexNNTagger:
Collaboration diagram for JetPileupTag::JetVertexNNTagger:

Public Member Functions

 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...
 

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< StoreGateSvcStoreGateSvc_t
 

Private Member Functions

const xAOD::VertexfindHSVertex (const xAOD::VertexContainer &vertices) const
 
float evaluateJvt (float rpt, float jvfcorr, size_t ptbin, size_t etabin) const
 
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

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::VertexContainerm_vertexContainer_key {this, "VertexContainer", "PrimaryVertices", "SG key for input vertex container"}
 
SG::ReadDecorHandleKey< xAOD::JetContainerm_jvfCorrKey {this, "JVFCorrName", "JVFCorr", "SG key for input JVFCorr decoration"}
 
SG::ReadDecorHandleKey< xAOD::JetContainerm_sumPtTrkKey {this, "SumPtTrkName", "SumPtTrkPt500", "SG key for input SumPtTrk decoration"}
 
SG::WriteDecorHandleKey< xAOD::JetContainerm_jvtKey {this, "JVTName", "NNJvt", "SG key for output JVT decoration"}
 
SG::WriteDecorHandleKey< xAOD::JetContainerm_rptKey {this, "RpTName", "NNJvtRpt", "SG key for output RpT decoration"}
 
SG::WriteDecorHandleKey< xAOD::JetContainerm_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
 

Detailed Description

Definition at line 44 of file JetVertexNNTagger.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t
privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ JetVertexNNTagger()

JetVertexNNTagger::JetVertexNNTagger ( const std::string &  name)

Constructor with a tool name.

Definition at line 29 of file JetVertexNNTagger.cxx.

30  : asg::AsgTool(name) {}

◆ ~JetVertexNNTagger()

JetVertexNNTagger::~JetVertexNNTagger ( )
default

Destructor.

Member Function Documentation

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl,
const SG::VarHandleKeyArrayType  
)
inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

172  {
173  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
174  hndl.value(),
175  hndl.documentation());
176 
177  }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl,
const SG::VarHandleKeyType  
)
inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

158  {
159  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
160  hndl.value(),
161  hndl.documentation());
162 
163  }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl,
const SG::VarHandleType  
)
inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

186  {
187  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
188  hndl.value(),
189  hndl.documentation());
190  }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  t,
const SG::NotHandleType  
)
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.

200  {
201  return PBASE::declareProperty(t);
202  }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
SG::VarHandleBase hndl,
const std::string &  doc,
const SG::VarHandleType  
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
hndlObject holding the property value.
docDocumentation 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.

249  {
250  this->declare(hndl.vhKey());
251  hndl.vhKey().setOwner(this);
252 
253  return PBASE::declareProperty(name,hndl,doc);
254  }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
SG::VarHandleKey hndl,
const std::string &  doc,
const SG::VarHandleKeyType  
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
hndlObject holding the property value.
docDocumentation 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.

225  {
226  this->declare(hndl);
227  hndl.setOwner(this);
228 
229  return PBASE::declareProperty(name,hndl,doc);
230  }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
SG::VarHandleKeyArray hndArr,
const std::string &  doc,
const SG::VarHandleKeyArrayType  
)
inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

263  {
264 
265  // std::ostringstream ost;
266  // ost << Algorithm::name() << " VHKA declareProp: " << name
267  // << " size: " << hndArr.keys().size()
268  // << " mode: " << hndArr.mode()
269  // << " vhka size: " << m_vhka.size()
270  // << "\n";
271  // debug() << ost.str() << endmsg;
272 
273  hndArr.setOwner(this);
274  m_vhka.push_back(&hndArr);
275 
276  Gaudi::Details::PropertyBase* p = PBASE::declareProperty(name, hndArr, doc);
277  if (p != 0) {
278  p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
279  } else {
280  ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray "
281  << name);
282  }
283 
284  return p;
285 
286  }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
T &  property,
const std::string &  doc,
const SG::NotHandleType  
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
propertyObject holding the property value.
docDocumentation 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.

337  {
338  return PBASE::declareProperty(name, property, doc);
339  }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
T &  property,
const std::string &  doc = "none" 
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
propertyObject holding the property value.
docDocumentation 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.

355  {
356  typedef typename SG::HandleClassifier<T>::type htype;
357  return declareProperty (name, property, doc, htype());
358  }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > &  t)
inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

145  {
146  typedef typename SG::HandleClassifier<T>::type htype;
148  }

◆ decorate()

StatusCode JetVertexNNTagger::decorate ( const xAOD::JetContainer jets) const
overridevirtual

Decorate a jet collection without otherwise modifying it.

Implements IJetDecorator.

Definition at line 146 of file JetVertexNNTagger.cxx.

147  {
148 
149  // Grab vertices for index bookkeeping
151  const xAOD::VertexContainer& vertices = *vertexHandle;
152  ATH_MSG_DEBUG("Successfully retrieved VertexContainer: " << m_vertexContainer_key.key());
153 
154  const xAOD::Vertex *HSvertex = findHSVertex(vertices);
155  if(!HSvertex) {
156  ATH_MSG_WARNING("Invalid primary vertex found, will not continue decorating with JVT.");
157  return StatusCode::FAILURE;
158  }
159 
165 
166  static constexpr float invalidJvt = -1;
167  static constexpr float invalidRpt = 0;
168  static constexpr char invalidPassJvt = true;
169 
170 
171  for(const xAOD::Jet* jet : jetCont) {
172  float jvt = invalidJvt;
173  float rpt = invalidRpt;
174  char passJvt = invalidPassJvt;
175  if (HSvertex->vertexType() == xAOD::VxType::PriVtx) {
176  // Calculate RpT and JVFCorr
177  // Default JVFcorr to -1 when no tracks are associated.
178  float jvfcorr = jvfCorrHandle(*jet);
179  std::vector<float> sumpttrk = sumPtTrkHandle(*jet);
180  rpt = sumpttrk[HSvertex->index() - vertices[0]->index()]/jet->pt();
181 
182  size_t ptbin, etabin;
183  if (jet->pt() <= m_maxpt_for_cut && m_cutMap.edges(*jet, ptbin, etabin)) {
184  jvt = evaluateJvt(rpt, jvfcorr, ptbin, etabin);
185  float jvtCut = m_cutMap(ptbin, etabin);
186  passJvt = jvt > jvtCut;
187 
188  ATH_MSG_VERBOSE("Jet with pt " << jet->pt() << ", eta " << jet->eta() );
189  ATH_MSG_VERBOSE(" --> ptbin " << ptbin << ", etabin " << etabin);
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" );
193  }
194  }
195 
196  // Decorate jet
197  jvtHandle(*jet) = jvt;
198  if (!rptHandle.key().empty())
199  rptHandle(*jet) = rpt;
200  if (!passJvtHandle.key().empty())
201  passJvtHandle(*jet) = passJvt;
202  }
203 
204  return StatusCode::SUCCESS;
205  }

◆ detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const
inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_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.

117  {
118 
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};
121  lwt::VectorX<double> output = m_lwnn->compute(scalars);
122 
123  return output(0);
124 
125  }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )
inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const
inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase &  ExtraDeps)
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

◆ findHSVertex()

const xAOD::Vertex * JetVertexNNTagger::findHSVertex ( const xAOD::VertexContainer vertices) const
private

Definition at line 128 of file JetVertexNNTagger.cxx.

129  {
130 
131  for ( const xAOD::Vertex* vertex : vertices ) {
132  if(vertex->vertexType() == xAOD::VxType::PriVtx) {
133  ATH_MSG_VERBOSE("JetVertexTaggerTool " << name() << " Found HS vertex at index: "<< vertex->index());
134  return vertex;
135  }
136  }
137  if (vertices.size()==1) {
138  ATH_MSG_VERBOSE("JetVertexTaggerTool " << name() << " Found no HS vertex, return dummy");
139  if (vertices.back()->vertexType() == xAOD::VxType::NoVtx)
140  return vertices.back();
141  }
142  ATH_MSG_VERBOSE("No vertex found in container.");
143  return nullptr;
144  }

◆ getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void *  ptr) const
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.

See also
asg::AsgTool::getName
Parameters
ptrThe 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.

119  {
120 
121 #ifdef XAOD_STANDALONE
122  // In case we use @c xAOD::TEvent, we have a direct function call
123  // for this.
124  return evtStore()->event()->getKey( ptr );
125 #else
126  const SG::DataProxy* proxy = evtStore()->proxy( ptr );
127  return ( proxy == nullptr ? 0 : proxy->sgkey() );
128 #endif // XAOD_STANDALONE
129  }

◆ 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
ptrThe 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.

106  {
107 
108 #ifdef XAOD_STANDALONE
109  // In case we use @c xAOD::TEvent, we have a direct function call
110  // for this.
111  return evtStore()->event()->getName( ptr );
112 #else
113  const SG::DataProxy* proxy = evtStore()->proxy( ptr );
114  static const std::string dummy = "";
115  return ( proxy == nullptr ? dummy : proxy->name() );
116 #endif // XAOD_STANDALONE
117  }

◆ 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.

35  {
36 
37  ATH_MSG_DEBUG("Initializing...");
38 
39  if(m_jetContainerName.empty()){
40  ATH_MSG_ERROR("JetVertexTaggerTool needs to have its input jet container configured!");
41  return StatusCode::FAILURE;
42  }
43 
44  // Use the Path Resolver to find the jvt file and retrieve the likelihood histogram
45  std::string configPath = PathResolverFindCalibFile(m_NNConfigDir+"/"+m_NNParamFileName);
46  ATH_MSG_INFO(" Reading JVT NN file from:\n " << m_NNParamFileName << "\n");
47  ATH_MSG_INFO(" resolved in :\n " << configPath << "\n\n");
48 
49  std::ifstream fconfig( configPath.c_str() );
50  if ( !fconfig.is_open() ) {
51  ATH_MSG_ERROR( "Error opening config file: " << m_NNParamFileName );
52  ATH_MSG_ERROR( "Are you sure that the file exists at this path?" );
53  return StatusCode::FAILURE;
54  }
55 
56  ATH_MSG_INFO("\n Reading JVT likelihood histogram from:\n " << configPath << "\n\n");
57  lwt::GraphConfig cfg = lwt::parse_json_graph( fconfig );
58  // FastGraph is initialised with the order in which inputs will be
59  // provided, to avoid map lookup
60  lwt::InputOrder order;
61  lwt::order_t node_order;
62  std::vector<std::string> inputs = {"Rpt","JVFCorr","ptbin","etabin"};
63  // Single input block
64  node_order.emplace_back(cfg.inputs[0].name,inputs);
65  order.scalar = node_order;
66  ATH_MSG_DEBUG( "Network NLayers: " << cfg.layers.size() );
67 
68  // Primarily using double to take advantage of build_vector later
69  m_lwnn = std::make_unique<lwt::generic::FastGraph<double> >(cfg,order);
70 
71  std::string cutsPath = PathResolverFindCalibFile(m_NNConfigDir+"/"+m_NNCutFileName);
72  ATH_MSG_INFO(" Reading JVT NN cut file from:\n " << m_NNCutFileName << "\n");
73  ATH_MSG_INFO(" resolved in :\n " << cutsPath << "\n\n");
74  std::ifstream fcuts( cutsPath.c_str() );
75  if ( !fcuts.is_open() ) {
76  ATH_MSG_ERROR( "Error opening cuts file: " << m_NNCutFileName );
77  ATH_MSG_ERROR( "Are you sure that the file exists at this path?" );
78  return StatusCode::FAILURE;
79  }
81 
84  m_jvtKey = m_jetContainerName + "." + m_jvtKey.key();
85  if (!m_rptKey.empty())
86  m_rptKey = m_jetContainerName + "." + m_rptKey.key();
87  if (!m_passJvtKey.empty())
89 
90  ATH_CHECK(m_vertexContainer_key.initialize());
91 #ifndef XAOD_STANDALONE
93  // The user has promised that this will be produced by the same alg.
94  // Tell the scheduler to ignore it to avoid circular dependencies.
97  }
99  // For analysis applications, may not enforce scheduling via data deps
103  }
104 #endif
105  ATH_CHECK(m_jvfCorrKey.initialize());
106  ATH_CHECK(m_sumPtTrkKey.initialize());
107  ATH_CHECK(m_jvtKey.initialize());
108  ATH_CHECK(m_rptKey.initialize(SG::AllowEmpty));
110 
111  return StatusCode::SUCCESS;
112  }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const
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.

◆ modify()

virtual StatusCode IJetDecorator::modify ( xAOD::JetContainer jets) const
inlinefinaloverridevirtualinherited

Concrete implementation of the function inherited from IJetModifier.

Implements IJetModifier.

Definition at line 32 of file IJetDecorator.h.

32 {return decorate(jets);};

◆ msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const
inlineinherited

Definition at line 24 of file AthCommonMsg.h.

24  {
25  return this->msgStream();
26  }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level  lvl) const
inlineinherited

Definition at line 27 of file AthCommonMsg.h.

27  {
28  return this->msgStream(lvl);
29  }

◆ 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.

101  {
102 
103  return MSG::name( msg().level() );
104  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level  lvl) const
inlineinherited

Definition at line 30 of file AthCommonMsg.h.

30  {
31  return this->msgLevel(lvl);
32  }

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const
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.

◆ print()

void asg::AsgTool::print ( ) const
virtualinherited

◆ renounce()

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> AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T &  h)
inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

381  {
382  h.renounce();
383  PBASE::renounce (h);
384  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray handlesArray)
inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

364  {
365  handlesArray.renounce();
366  }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )
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.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )
overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase &  )
inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

308  {
309  // debug() << "updateVHKA for property " << p.name() << " " << p.toString()
310  // << " size: " << m_vhka.size() << endmsg;
311  for (auto &a : m_vhka) {
312  std::vector<SG::VarHandleKey*> keys = a->keys();
313  for (auto k : keys) {
314  k->setOwner(this);
315  }
316  }
317  }

Member Data Documentation

◆ m_cutMap

NNJvtCutMap JetPileupTag::JetVertexNNTagger::m_cutMap
private

Definition at line 74 of file JetVertexNNTagger.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore
privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore
privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_jetContainerName

Gaudi::Property<std::string> JetPileupTag::JetVertexNNTagger::m_jetContainerName {this,"JetContainer", "", "SG key for the input jet container"}
private

Definition at line 77 of file JetVertexNNTagger.h.

◆ m_jvfCorrKey

SG::ReadDecorHandleKey<xAOD::JetContainer> JetPileupTag::JetVertexNNTagger::m_jvfCorrKey {this, "JVFCorrName", "JVFCorr", "SG key for input JVFCorr decoration"}
private

Definition at line 91 of file JetVertexNNTagger.h.

◆ m_jvtKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetPileupTag::JetVertexNNTagger::m_jvtKey {this, "JVTName", "NNJvt", "SG key for output JVT decoration"}
private

Definition at line 93 of file JetVertexNNTagger.h.

◆ 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

Definition at line 86 of file JetVertexNNTagger.h.

◆ m_NNConfigDir

Gaudi::Property<std::string> JetPileupTag::JetVertexNNTagger::m_NNConfigDir {this,"NNConfigDir", "JetPileupTag/NNJvt/2022-03-22", "PathResolver-accessible directory holding config files"}
private

Definition at line 82 of file JetVertexNNTagger.h.

◆ m_NNCutFileName

Gaudi::Property<std::string> JetPileupTag::JetVertexNNTagger::m_NNCutFileName {this,"NNCutFile", "NNJVT.Cuts.FixedEffPt.Offline.Nonprompt_All_MaxW.json", "Name of json file containing network parameters"}
private

Definition at line 84 of file JetVertexNNTagger.h.

◆ m_NNParamFileName

Gaudi::Property<std::string> JetPileupTag::JetVertexNNTagger::m_NNParamFileName {this,"NNParamFile", "NNJVT.Network.graph.Offline.Nonprompt_All_MaxWeight.json", "Name of json file containing network parameters"}
private

Definition at line 83 of file JetVertexNNTagger.h.

◆ m_passJvtKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetPileupTag::JetVertexNNTagger::m_passJvtKey {this, "passJvtName", "NNJvtPass", "SG key for output pass-JVT decoration"}
private

Definition at line 95 of file JetVertexNNTagger.h.

◆ m_rptKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetPileupTag::JetVertexNNTagger::m_rptKey {this, "RpTName", "NNJvtRpt", "SG key for output RpT decoration"}
private

Definition at line 94 of file JetVertexNNTagger.h.

◆ m_sumPtTrkKey

SG::ReadDecorHandleKey<xAOD::JetContainer> JetPileupTag::JetVertexNNTagger::m_sumPtTrkKey {this, "SumPtTrkName", "SumPtTrkPt500", "SG key for input SumPtTrk decoration"}
private

Definition at line 92 of file JetVertexNNTagger.h.

◆ 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

Definition at line 78 of file JetVertexNNTagger.h.

◆ m_suppressOutputDeps

Gaudi::Property<bool> JetPileupTag::JetVertexNNTagger::m_suppressOutputDeps {this, "SuppressOutputDependence", false, "Ignore creating the output decoration dependency for data flow; for analysis"}
private

Definition at line 79 of file JetVertexNNTagger.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared
privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vertexContainer_key

SG::ReadHandleKey<xAOD::VertexContainer> JetPileupTag::JetVertexNNTagger::m_vertexContainer_key {this, "VertexContainer", "PrimaryVertices", "SG key for input vertex container"}
private

Definition at line 90 of file JetVertexNNTagger.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka
privateinherited

Definition at line 398 of file AthCommonDataStore.h.


The documentation for this class was generated from the following files:
JetPileupTag::JetVertexNNTagger::m_maxpt_for_cut
Gaudi::Property< float > m_maxpt_for_cut
Definition: JetVertexNNTagger.h:86
asg::AsgTool
Base class for the dual-use tool implementation classes.
Definition: AsgTool.h:47
StateLessPT_NewConfig.proxy
proxy
Definition: StateLessPT_NewConfig.py:392
python.PerfMonSerializer.p
def p
Definition: PerfMonSerializer.py:743
JetPileupTag::JetVertexNNTagger::evaluateJvt
float evaluateJvt(float rpt, float jvfcorr, size_t ptbin, size_t etabin) const
Definition: JetVertexNNTagger.cxx:116
JetPileupTag::JetVertexNNTagger::m_jvtKey
SG::WriteDecorHandleKey< xAOD::JetContainer > m_jvtKey
Definition: JetVertexNNTagger.h:93
ATH_MSG_INFO
#define ATH_MSG_INFO(x)
Definition: AthMsgStreamMacros.h:31
JetPileupTag::JetVertexNNTagger::m_cutMap
NNJvtCutMap m_cutMap
Definition: JetVertexNNTagger.h:74
SG::ReadHandle
Definition: StoreGate/StoreGate/ReadHandle.h:70
AthCommonDataStore::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
Definition: AthCommonDataStore.h:145
AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce
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)
Definition: AthCommonDataStore.h:380
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
Definition: AthCommonDataStore.h:390
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka
std::vector< SG::VarHandleKeyArray * > m_vhka
Definition: AthCommonDataStore.h:398
JetPileupTag::JetVertexNNTagger::findHSVertex
const xAOD::Vertex * findHSVertex(const xAOD::VertexContainer &vertices) const
Definition: JetVertexNNTagger.cxx:128
read_hist_ntuple.t
t
Definition: read_hist_ntuple.py:5
ATH_MSG_VERBOSE
#define ATH_MSG_VERBOSE(x)
Definition: AthMsgStreamMacros.h:28
xAOD::Vertex_v1::vertexType
VxType::VertexType vertexType() const
The type of the vertex.
xAOD::VxType::NoVtx
@ NoVtx
Dummy vertex. TrackParticle was not used in vertex fit.
Definition: TrackingPrimitives.h:570
postInclude.inputs
inputs
Definition: postInclude.SortInput.py:15
JetPileupTag::JetVertexNNTagger::m_suppressOutputDeps
Gaudi::Property< bool > m_suppressOutputDeps
Definition: JetVertexNNTagger.h:79
python.iconfTool.models.loaders.level
level
Definition: loaders.py:20
SG::VarHandleKeyArray::setOwner
virtual void setOwner(IDataHandleHolder *o)=0
JetPileupTag::NNJvtCutMap::fromJSON
static NNJvtCutMap fromJSON(std::istream &is)
Definition: NNJvtBinning.cxx:90
SG::makeHandle
SG::ReadCondHandle< T > makeHandle(const SG::ReadCondHandleKey< T > &key, const EventContext &ctx=Gaudi::Hive::currentContext())
Definition: ReadCondHandle.h:269
AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore
ServiceHandle< StoreGateSvc > & evtStore()
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
Definition: AthCommonDataStore.h:85
jet
Definition: JetCalibTools_PlotJESFactors.cxx:23
AthCommonDataStore
Definition: AthCommonDataStore.h:52
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
SG::ReadDecorHandle
Handle class for reading a decoration on an object.
Definition: StoreGate/StoreGate/ReadDecorHandle.h:94
JetPileupTag::JetVertexNNTagger::m_vertexContainer_key
SG::ReadHandleKey< xAOD::VertexContainer > m_vertexContainer_key
Definition: JetVertexNNTagger.h:90
ATH_MSG_DEBUG
#define ATH_MSG_DEBUG(x)
Definition: AthMsgStreamMacros.h:29
mc.order
order
Configure Herwig7.
Definition: mc.Herwig7_Dijet.py:12
JetPileupTag::JetVertexNNTagger::m_rptKey
SG::WriteDecorHandleKey< xAOD::JetContainer > m_rptKey
Definition: JetVertexNNTagger.h:94
SG::WriteDecorHandle
Handle class for adding a decoration to an object.
Definition: StoreGate/StoreGate/WriteDecorHandle.h:99
lwt::atlas::order_t
std::vector< std::pair< std::string, std::vector< std::string > > > order_t
Definition: InputOrder.h:25
JetPileupTag::NNJvtCutMap::edges
NNJvtBinning edges
Definition: NNJvtBinning.h:51
xAOD::VxType::PriVtx
@ PriVtx
Primary vertex.
Definition: TrackingPrimitives.h:571
python.xAODType.dummy
dummy
Definition: xAODType.py:4
ATH_CHECK
#define ATH_CHECK
Definition: AthCheckMacros.h:40
MSG::name
const std::string & name(Level lvl)
Convenience function for translating message levels to strings.
Definition: MsgLevel.cxx:19
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
Definition: AthCommonDataStore.h:393
lwtDev::build_vector
VectorXd build_vector(const std::vector< double > &bias)
Definition: Stack.cxx:760
SG::AuxElement::index
size_t index() const
Return the index of this element within its container.
DataVector
Derived DataVector<T>.
Definition: DataVector.h:581
SG::VarHandleKeyArray::renounce
virtual void renounce()=0
SG::HandleClassifier::type
std::conditional< std::is_base_of< SG::VarHandleKeyArray, T >::value, VarHandleKeyArrayType, type2 >::type type
Definition: HandleClassifier.h:54
merge.output
output
Definition: merge.py:17
JetPileupTag::JetVertexNNTagger::m_jetContainerName
Gaudi::Property< std::string > m_jetContainerName
Definition: JetVertexNNTagger.h:77
merge_scale_histograms.doc
string doc
Definition: merge_scale_histograms.py:9
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:192
WriteCaloSwCorrections.cfg
cfg
Definition: WriteCaloSwCorrections.py:23
JetPileupTag::JetVertexNNTagger::m_NNConfigDir
Gaudi::Property< std::string > m_NNConfigDir
Definition: JetVertexNNTagger.h:82
PathResolverFindCalibFile
std::string PathResolverFindCalibFile(const std::string &logical_file_name)
Definition: PathResolver.cxx:431
xAOD::Jet_v1
Class describing a jet.
Definition: Jet_v1.h:57
lwtDev::parse_json_graph
GraphConfig parse_json_graph(std::istream &json)
Definition: parse_json.cxx:71
Trk::vertex
@ vertex
Definition: MeasurementType.h:21
JetPileupTag::JetVertexNNTagger::m_suppressInputDeps
Gaudi::Property< bool > m_suppressInputDeps
Definition: JetVertexNNTagger.h:78
a
TList * a
Definition: liststreamerinfos.cxx:10
h
xAOD::Vertex_v1
Class describing a Vertex.
Definition: Vertex_v1.h:42
IJetDecorator::decorate
virtual StatusCode decorate(const xAOD::JetContainer &jets) const =0
Decorate a jet collection without otherwise modifying it.
ATH_MSG_WARNING
#define ATH_MSG_WARNING(x)
Definition: AthMsgStreamMacros.h:32
JetPileupTag::JetVertexNNTagger::m_jvfCorrKey
SG::ReadDecorHandleKey< xAOD::JetContainer > m_jvfCorrKey
Definition: JetVertexNNTagger.h:91
JetPileupTag::JetVertexNNTagger::m_passJvtKey
SG::WriteDecorHandleKey< xAOD::JetContainer > m_passJvtKey
Definition: JetVertexNNTagger.h:95
JetPileupTag::JetVertexNNTagger::m_sumPtTrkKey
SG::ReadDecorHandleKey< xAOD::JetContainer > m_sumPtTrkKey
Definition: JetVertexNNTagger.h:92
AthCommonMsg< AlgTool >::msg
MsgStream & msg() const
Definition: AthCommonMsg.h:24
SG::VarHandleBase::vhKey
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
Definition: StoreGate/src/VarHandleBase.cxx:616
declareProperty
#define declareProperty(n, p, h)
Definition: BaseFakeBkgTool.cxx:15
defineDB.jets
list jets
Definition: JetTagCalibration/share/defineDB.py:24
JetPileupTag::JetVertexNNTagger::m_NNCutFileName
Gaudi::Property< std::string > m_NNCutFileName
Definition: JetVertexNNTagger.h:84
python.Bindings.keys
keys
Definition: Control/AthenaPython/python/Bindings.py:790
SG::DataProxy
Definition: DataProxy.h:44
SG::AllowEmpty
@ AllowEmpty
Definition: StoreGate/StoreGate/VarHandleKey.h:30
JetPileupTag::JetVertexNNTagger::m_lwnn
std::unique_ptr< lwt::generic::FastGraph< double > > m_lwnn
Internal members for interpreting jet inputs and NN configuration.
Definition: JetVertexNNTagger.h:72
AthCommonDataStore::declareGaudiProperty
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition: AthCommonDataStore.h:156
fitman.k
k
Definition: fitman.py:528
JetPileupTag::JetVertexNNTagger::m_NNParamFileName
Gaudi::Property< std::string > m_NNParamFileName
Definition: JetVertexNNTagger.h:83