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

Properties: VertexContainer - name of the vertex container EventInfo - name of EventInfo container AssociatedTracks - name for attribute holding the list of associated tracks TVATool - tool to do track-vertex association TrkSelTool - tool to select tracks (none ==> no selection) More...

#include <JetQGTaggerVariableTool.h>

Inheritance diagram for JetQGTaggerVariableTool:
Collaboration diagram for JetQGTaggerVariableTool:

Public Member Functions

 JetQGTaggerVariableTool (const std::string &name)
 
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...
 
const xAOD::VertexfindHSVertex (const xAOD::VertexContainer *&) 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< StoreGateSvcStoreGateSvc_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"}
 
SG::ReadHandleKey< xAOD::VertexContainerm_vertexContainer_key {this, "VertexContainer", "PrimaryVertices", "SG key for input vertex container"}
 
SG::ReadHandleKey< xAOD::EventInfom_eventInfo_key {this, "EventInfo", "EventInfo", "SG key for input EventInfo"}
 
ToolHandle< InDet::IInDetTrackSelectionToolm_trkSelectionTool {this, "TrackSelector", "", "Track selector"}
 
SG::ReadHandleKey< jet::TrackVertexAssociationm_tva_key {this, "TrackVertexAssociation", "", "Track vertex association key"}
 
SG::WriteDecorHandleKey< xAOD::JetContainerm_nTrkKey {this, "NTrksDecorName", "DFCommonJets_QGTagger_NTracks", "SG key for output NTracks decoration"}
 
SG::WriteDecorHandleKey< xAOD::JetContainerm_trkWidthKey {this, "TracksWidthDecorName", "DFCommonJets_QGTagger_TracksWidth", "SG key for output TracksWidth decoration"}
 
SG::WriteDecorHandleKey< xAOD::JetContainerm_trkC1Key {this, "TracksC1DecorName", "DFCommonJets_QGTagger_TracksC1", "SG key for output TracksC1 decoration"}
 
SG::WriteDecorHandleKey< xAOD::JetContainerm_nChargedKey {this, "nChargedDecorName", "DFCommonJets_QGTagger_truthjet_nCharged", "SG key for output truthjet_nCharged decoration"}
 
SG::WriteDecorHandleKey< xAOD::JetContainerm_truthPtKey {this, "truthPtDecorName", "DFCommonJets_QGTagger_truthjet_pt", "SG key for output truthjet_pt decoration"}
 
SG::WriteDecorHandleKey< xAOD::JetContainerm_truthEtaKey {this, "truthEtaDecorName", "DFCommonJets_QGTagger_truthjet_eta", "SG key for output truthjet_eta 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

Properties: VertexContainer - name of the vertex container EventInfo - name of EventInfo container AssociatedTracks - name for attribute holding the list of associated tracks TVATool - tool to do track-vertex association TrkSelTool - tool to select tracks (none ==> no selection)

Definition at line 41 of file JetQGTaggerVariableTool.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

◆ JetQGTaggerVariableTool()

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

Definition at line 23 of file JetQGTaggerVariableTool.cxx.

25 }

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 JetQGTaggerVariableTool::decorate ( const xAOD::JetContainer jets) const
overridevirtual

Decorate a jet collection without otherwise modifying it.

Implements IJetDecorator.

Definition at line 61 of file JetQGTaggerVariableTool.cxx.

61  {
62 
63 
70 
71  // Get input vertex collection
72  auto vertexContainer = SG::makeHandle (m_vertexContainer_key);
73  if (!vertexContainer.isValid()){
74  ATH_MSG_ERROR("Invalid VertexContainer datahandle: " << m_vertexContainer_key.key());
75  return StatusCode::FAILURE;
76  }
77 
78  const auto *vertices = vertexContainer.cptr();
79 
80  ATH_MSG_DEBUG("Successfully retrieved VertexContainer: " << m_vertexContainer_key.key());
81 
82  if (vertices->empty() ) {
83  ATH_MSG_WARNING("There are no vertices in the container. Exiting");
84 
85  for(const xAOD::Jet* jet : jetCont){
86  nTrkHandle(*jet) = -1;
87  trkWidthHandle(*jet) = -1.;
88  trkC1Handle(*jet) = -1.;
89  nChargedHandle(*jet) = -1;
90  truthPtHandle(*jet) = -1.;
91  truthEtaHandle(*jet) = -1.;
92  }
93 
94  return StatusCode::SUCCESS;
95  }
96 
97  //Find the HS vertex
98  const xAOD::Vertex* HSvertex = findHSVertex(vertices);
99 
100  // Get the track-vertex association
101  auto handle_tva = SG::makeHandle (m_tva_key);
102  if (!handle_tva.isValid()){
103  ATH_MSG_ERROR("Could not retrieve the TrackVertexAssociation: " << m_tva_key.key());
104  return StatusCode::FAILURE;
105  }
106 
107  const auto *tva = handle_tva.cptr();
108 
109  //Loop over the jets
110  for(const xAOD::Jet* jet : jetCont){
111 
112  int nTracksCount = 0;
113  float TracksWidth = 0., SumTracks_pTs = 0., TracksC1 = 0., beta = 0.2;
114 
115  //Get ghost-associated tracks
116  std::vector<const xAOD::IParticle*> jettracks;
117  jet->getAssociatedObjects<xAOD::IParticle>(xAOD::JetAttribute::GhostTrack,jettracks);
118 
119  //Loop over the tracks
120  std::vector<bool> IsGoodTrack;
121  TLorentzVector tracki_TLV, trackj_TLV;
122  TLorentzVector jet_TLV = jet -> p4();
123  for (size_t i = 0; i < jettracks.size(); i++) {
124 
125  if(!jettracks[i]){
126  IsGoodTrack.push_back(false);
127  continue;
128  }
129 
130  const xAOD::TrackParticle* trk = static_cast<const xAOD::TrackParticle*>(jettracks[i]);
131 
132  // only count tracks with selections
133  // 1) pt>500 MeV
134  // 2) accepted track from InDetTrackSelectionTool with CutLevel==Loose
135  // 3) associated to primary vertex OR within 3mm of the primary vertex
136 
137  bool accept = (trk->pt()>500 &&
138  m_trkSelectionTool->accept(*trk) &&
139  (HSvertex == tva->associatedVertex(trk) || (HSvertex != tva->associatedVertex(trk) && std::abs((trk->z0()+trk->vz()-HSvertex->z())*sin(trk->theta()))<3.))
140  );
141 
142  IsGoodTrack.push_back(accept);
143  if (!accept) continue;
144 
145  nTracksCount++;
146 
147  tracki_TLV = trk -> p4();
148  double DR_tracki_jet = tracki_TLV.DeltaR(jet_TLV);
149  TracksWidth += trk -> pt() * DR_tracki_jet;
150  SumTracks_pTs += trk -> pt();
151 
152  }// end loop over jettracks
153 
154  if(SumTracks_pTs>0.) TracksWidth = TracksWidth / SumTracks_pTs;
155  else TracksWidth = -1.;
156 
157  //Calculate C1 from tracks
158  for(size_t i = 0; i < jettracks.size(); i++) {
159  const xAOD::TrackParticle* trki = static_cast<const xAOD::TrackParticle*>(jettracks[i]);
160  if( !( IsGoodTrack.at(i) ) ) continue;
161 
162  for(size_t j = i+1; j < jettracks.size(); j++) {
163  const xAOD::TrackParticle* trkj = static_cast<const xAOD::TrackParticle*>(jettracks[j]);
164  if( !( IsGoodTrack.at(j) ) ) continue;
165 
166  tracki_TLV = trki -> p4();
167  trackj_TLV = trkj -> p4();
168  double DR_tracki_trackj = tracki_TLV.DeltaR(trackj_TLV);
169  TracksC1 += trki -> pt() * trkj -> pt() * pow( DR_tracki_trackj, beta) ;
170 
171  }//end loop over j
172  }//end double loop over ij
173 
174  if(SumTracks_pTs>0.) TracksC1 = TracksC1 / ( pow(SumTracks_pTs, 2.) );
175  else TracksC1 = -1.;
176 
177  // Add truth variables for QG tagging
178 
179  auto eventInfoContainer = SG::makeHandle (m_eventInfo_key);
180  if (!eventInfoContainer.isValid()){
181  ATH_MSG_ERROR("Invalid EventInfo datahandle: " << m_eventInfo_key.key());
182  return StatusCode::FAILURE;
183  }
184 
185  const auto *eventInfo = eventInfoContainer.cptr();
186 
187  bool isMC = eventInfo->eventType(xAOD::EventInfo::IS_SIMULATION);
188  int tntrk = 0;
189  float truthjet_pt = -999.0;
190  float truthjet_eta = -999.0;
191 
192  if(isMC){
193  const xAOD::Jet* tjet=nullptr;
194  static const SG::ConstAccessor< ElementLink<xAOD::JetContainer> > GhostTruthAssociationLinkAcc ("GhostTruthAssociationLink");
195  if(GhostTruthAssociationLinkAcc.isAvailable(*jet) ){
196  ATH_MSG_DEBUG("Accessing GhostTruthAssociationLink: is available");
197  ElementLink<xAOD::JetContainer> truthlink = GhostTruthAssociationLinkAcc(*jet);
198  if(truthlink.isValid() ){
199  ATH_MSG_DEBUG("Accessing GhostTruthAssociationLink: is valid");
200  if(truthlink)
201  tjet = * truthlink;
202  else{
203  ATH_MSG_DEBUG("Skipping...truth link is broken");
204  }//endelse NULL pointer
205  }
206  else {
207  ATH_MSG_DEBUG("Invalid truth link: setting weight to 1");
208  } //endelse isValid
209  } //endif isAvailable
210  else {
211  ATH_MSG_DEBUG("Cannot access truth Link: setting weight to 1");
212  }//endelse isAvailable
213 
214  if(tjet){
215  ATH_MSG_DEBUG("Truth Jet: " << tjet->numConstituents());
216 
217  truthjet_pt = tjet->pt();
218  truthjet_eta = tjet->eta();
219 
220  //Calculate the number of charged final state particles with pT > 500 MeV
221  for (size_t ind = 0; ind < tjet->numConstituents(); ind++) {
222  const xAOD::TruthParticle *part = static_cast<const xAOD::TruthParticle*>(tjet->rawConstituent(ind));
223  ATH_MSG_DEBUG("part: " << part );
224  // dont count invalid truth particles
225  if (!part || ! MC::isStable(part) || HepMC::is_simulation_particle(part)) continue;
226  // pt>500 MeV
227  ATH_MSG_DEBUG("pt: " << (part->pt()) );
228  if( ! (part->pt()>500.) ) continue;
229  // charged
230  ATH_MSG_DEBUG("isCharged: " << (part->isCharged()) );
231  if( !(part->isCharged()) ) continue;
232  tntrk++;
233  }
234  }
235  }
236 
237  nTrkHandle(*jet) = nTracksCount;
238  trkWidthHandle(*jet) = TracksWidth;
239  trkC1Handle(*jet) = TracksC1;
240  nChargedHandle(*jet) = tntrk;
241  truthPtHandle(*jet) = truthjet_pt;
242  truthEtaHandle(*jet) = truthjet_eta;
243 
244  }
245 
246  return StatusCode::SUCCESS;
247 }

◆ 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; }

◆ 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 * JetQGTaggerVariableTool::findHSVertex ( const xAOD::VertexContainer *&  vertices) const

Definition at line 251 of file JetQGTaggerVariableTool.cxx.

252 {
253  for ( size_t iVertex = 0; iVertex < vertices->size(); ++iVertex ) {
254  if(vertices->at(iVertex)->vertexType() == xAOD::VxType::PriVtx) {
255 
256  ATH_MSG_VERBOSE("JetQGTaggerVariableTool " << name() << " Found HS vertex at index: "<< iVertex);
257  return vertices->at(iVertex);
258  }
259  }
260  ATH_MSG_VERBOSE("There is no vertex of type PriVx. Taking default vertex.");
261  return vertices->at(0);
262 }

◆ 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 JetQGTaggerVariableTool::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 29 of file JetQGTaggerVariableTool.cxx.

29  {
30  ATH_MSG_INFO("Initializing JetQGTaggerVariableTool " << name());
31 
32  if(m_jetContainerName.empty()){
33  ATH_MSG_ERROR("JetQGTaggerVariableTool needs to have its input jet container configured!");
34  return StatusCode::FAILURE;
35  }
36 
37  m_nTrkKey = m_jetContainerName + "." + m_nTrkKey.key();
43 
44  ATH_CHECK(m_vertexContainer_key.initialize());
46 
48 
49  ATH_CHECK(m_nTrkKey.initialize());
50  ATH_CHECK(m_trkWidthKey.initialize());
51  ATH_CHECK(m_trkC1Key.initialize());
52  ATH_CHECK(m_nChargedKey.initialize());
53  ATH_CHECK(m_truthPtKey.initialize());
54  ATH_CHECK(m_truthEtaKey.initialize());
55 
56  return StatusCode::SUCCESS;
57 }

◆ 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_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_eventInfo_key

SG::ReadHandleKey<xAOD::EventInfo> JetQGTaggerVariableTool::m_eventInfo_key {this, "EventInfo", "EventInfo", "SG key for input EventInfo"}
private

Definition at line 63 of file JetQGTaggerVariableTool.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> JetQGTaggerVariableTool::m_jetContainerName {this,"JetContainer", "", "SG key for the input jet container"}
private

Definition at line 61 of file JetQGTaggerVariableTool.h.

◆ m_nChargedKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetQGTaggerVariableTool::m_nChargedKey {this, "nChargedDecorName", "DFCommonJets_QGTagger_truthjet_nCharged", "SG key for output truthjet_nCharged decoration"}
private

Definition at line 71 of file JetQGTaggerVariableTool.h.

◆ m_nTrkKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetQGTaggerVariableTool::m_nTrkKey {this, "NTrksDecorName", "DFCommonJets_QGTagger_NTracks", "SG key for output NTracks decoration"}
private

Definition at line 68 of file JetQGTaggerVariableTool.h.

◆ m_trkC1Key

SG::WriteDecorHandleKey<xAOD::JetContainer> JetQGTaggerVariableTool::m_trkC1Key {this, "TracksC1DecorName", "DFCommonJets_QGTagger_TracksC1", "SG key for output TracksC1 decoration"}
private

Definition at line 70 of file JetQGTaggerVariableTool.h.

◆ m_trkSelectionTool

ToolHandle<InDet::IInDetTrackSelectionTool> JetQGTaggerVariableTool::m_trkSelectionTool {this, "TrackSelector", "", "Track selector"}
private

Definition at line 65 of file JetQGTaggerVariableTool.h.

◆ m_trkWidthKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetQGTaggerVariableTool::m_trkWidthKey {this, "TracksWidthDecorName", "DFCommonJets_QGTagger_TracksWidth", "SG key for output TracksWidth decoration"}
private

Definition at line 69 of file JetQGTaggerVariableTool.h.

◆ m_truthEtaKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetQGTaggerVariableTool::m_truthEtaKey {this, "truthEtaDecorName", "DFCommonJets_QGTagger_truthjet_eta", "SG key for output truthjet_eta decoration"}
private

Definition at line 73 of file JetQGTaggerVariableTool.h.

◆ m_truthPtKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetQGTaggerVariableTool::m_truthPtKey {this, "truthPtDecorName", "DFCommonJets_QGTagger_truthjet_pt", "SG key for output truthjet_pt decoration"}
private

Definition at line 72 of file JetQGTaggerVariableTool.h.

◆ m_tva_key

SG::ReadHandleKey<jet::TrackVertexAssociation> JetQGTaggerVariableTool::m_tva_key {this, "TrackVertexAssociation", "", "Track vertex association key"}
private

Definition at line 66 of file JetQGTaggerVariableTool.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> JetQGTaggerVariableTool::m_vertexContainer_key {this, "VertexContainer", "PrimaryVertices", "SG key for input vertex container"}
private

Definition at line 62 of file JetQGTaggerVariableTool.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:
LArG4FSStartPointFilter.part
part
Definition: LArG4FSStartPointFilter.py:21
xAOD::TrackParticle_v1::pt
virtual double pt() const override final
The transverse momentum ( ) of the particle.
Definition: TrackParticle_v1.cxx:73
asg::AsgTool
Base class for the dual-use tool implementation classes.
Definition: AsgTool.h:47
JetQGTaggerVariableTool::m_eventInfo_key
SG::ReadHandleKey< xAOD::EventInfo > m_eventInfo_key
Definition: JetQGTaggerVariableTool.h:63
StateLessPT_NewConfig.proxy
proxy
Definition: StateLessPT_NewConfig.py:392
ATH_MSG_INFO
#define ATH_MSG_INFO(x)
Definition: AthMsgStreamMacros.h:31
AthCommonDataStore::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
Definition: AthCommonDataStore.h:145
CutsMETMaker::accept
StatusCode accept(const xAOD::Muon *mu)
Definition: CutsMETMaker.cxx:18
xAOD::TrackParticle_v1::vz
float vz() const
The z origin for the parameters.
JetQGTaggerVariableTool::m_truthEtaKey
SG::WriteDecorHandleKey< xAOD::JetContainer > m_truthEtaKey
Definition: JetQGTaggerVariableTool.h:73
test_pyathena.pt
pt
Definition: test_pyathena.py:11
xAOD::TrackParticle_v1::z0
float z0() const
Returns the parameter.
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
JetQGTaggerVariableTool::m_tva_key
SG::ReadHandleKey< jet::TrackVertexAssociation > m_tva_key
Definition: JetQGTaggerVariableTool.h:66
SG::ConstAccessor
Helper class to provide constant type-safe access to aux data.
Definition: ConstAccessor.h:55
read_hist_ntuple.t
t
Definition: read_hist_ntuple.py:5
JetQGTaggerVariableTool::m_nChargedKey
SG::WriteDecorHandleKey< xAOD::JetContainer > m_nChargedKey
Definition: JetQGTaggerVariableTool.h:71
ATH_MSG_VERBOSE
#define ATH_MSG_VERBOSE(x)
Definition: AthMsgStreamMacros.h:28
SG::VarHandleKey::key
const std::string & key() const
Return the StoreGate ID for the referenced object.
Definition: AthToolSupport/AsgDataHandles/Root/VarHandleKey.cxx:141
dbg::ptr
void * ptr(T *p)
Definition: SGImplSvc.cxx:74
xAOD::IParticle
Class providing the definition of the 4-vector interface.
Definition: Event/xAOD/xAODBase/xAODBase/IParticle.h:41
xAOD::EventInfo_v1::IS_SIMULATION
@ IS_SIMULATION
true: simulation, false: data
Definition: EventInfo_v1.h:151
python.iconfTool.models.loaders.level
level
Definition: loaders.py:20
SG::VarHandleKeyArray::setOwner
virtual void setOwner(IDataHandleHolder *o)=0
IDTPMcnv.htype
htype
Definition: IDTPMcnv.py:29
SG::makeHandle
SG::ReadCondHandle< T > makeHandle(const SG::ReadCondHandleKey< T > &key, const EventContext &ctx=Gaudi::Hive::currentContext())
Definition: ReadCondHandle.h:270
AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore
ServiceHandle< StoreGateSvc > & evtStore()
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
Definition: AthCommonDataStore.h:85
JetQGTaggerVariableTool::m_trkSelectionTool
ToolHandle< InDet::IInDetTrackSelectionTool > m_trkSelectionTool
Definition: JetQGTaggerVariableTool.h:65
python.utils.AtlRunQueryDQUtils.p
p
Definition: AtlRunQueryDQUtils.py:210
jet
Definition: JetCalibTools_PlotJESFactors.cxx:23
AthCommonDataStore
Definition: AthCommonDataStore.h:52
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
HepMC::is_simulation_particle
bool is_simulation_particle(const T &p)
Method to establish if a particle (or barcode) was created during the simulation (TODO update to be s...
Definition: MagicNumbers.h:355
lumiFormat.i
int i
Definition: lumiFormat.py:85
ATH_MSG_DEBUG
#define ATH_MSG_DEBUG(x)
Definition: AthMsgStreamMacros.h:29
xAOD::TruthParticle_v1
Class describing a truth particle in the MC record.
Definition: TruthParticle_v1.h:37
SG::WriteDecorHandle
Handle class for adding a decoration to an object.
Definition: StoreGate/StoreGate/WriteDecorHandle.h:100
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
xAOD::Vertex_v1::z
float z() const
Returns the z position.
SG::VarHandleKey::initialize
StatusCode initialize(bool used=true)
If this object is used as a property, then this should be called during the initialize phase.
Definition: AthToolSupport/AsgDataHandles/Root/VarHandleKey.cxx:103
JetQGTaggerVariableTool::m_truthPtKey
SG::WriteDecorHandleKey< xAOD::JetContainer > m_truthPtKey
Definition: JetQGTaggerVariableTool.h:72
xAOD::Jet_v1::eta
virtual double eta() const
The pseudorapidity ( ) of the particle.
Definition: Jet_v1.cxx:49
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
JetQGTaggerVariableTool::m_jetContainerName
Gaudi::Property< std::string > m_jetContainerName
Definition: JetQGTaggerVariableTool.h:61
merge_scale_histograms.doc
string doc
Definition: merge_scale_histograms.py:9
JetQGTaggerVariableTool::m_trkWidthKey
SG::WriteDecorHandleKey< xAOD::JetContainer > m_trkWidthKey
Definition: JetQGTaggerVariableTool.h:69
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:228
xAOD::Jet_v1::rawConstituent
const IParticle * rawConstituent(size_t i) const
Direct access to constituents. WARNING expert use only.
Definition: Jet_v1.cxx:158
JetQGTaggerVariableTool::m_vertexContainer_key
SG::ReadHandleKey< xAOD::VertexContainer > m_vertexContainer_key
Definition: JetQGTaggerVariableTool.h:62
xAOD::Jet_v1
Class describing a jet.
Definition: Jet_v1.h:57
MC::isStable
bool isStable(const T &p)
Identify if the particle is stable, i.e. has not decayed.
Definition: HepMCHelpers.h:45
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
AthCommonMsg< AlgTool >::msg
MsgStream & msg() const
Definition: AthCommonMsg.h:24
JetQGTaggerVariableTool::findHSVertex
const xAOD::Vertex * findHSVertex(const xAOD::VertexContainer *&) const
Definition: JetQGTaggerVariableTool.cxx:251
SG::VarHandleBase::vhKey
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
Definition: StoreGate/src/VarHandleBase.cxx:623
EventInfoRead.isMC
isMC
Definition: EventInfoRead.py:11
defineDB.jets
list jets
Definition: JetTagCalibration/share/defineDB.py:24
python.Bindings.keys
keys
Definition: Control/AthenaPython/python/Bindings.py:798
xAOD::TrackParticle_v1
Class describing a TrackParticle.
Definition: TrackParticle_v1.h:43
JetQGTaggerVariableTool::m_trkC1Key
SG::WriteDecorHandleKey< xAOD::JetContainer > m_trkC1Key
Definition: JetQGTaggerVariableTool.h:70
DataVector::at
const T * at(size_type n) const
Access an element, as an rvalue.
drawFromPickle.sin
sin
Definition: drawFromPickle.py:36
MuonParameters::beta
@ beta
Definition: MuonParamDefs.h:144
JetQGTaggerVariableTool::m_nTrkKey
SG::WriteDecorHandleKey< xAOD::JetContainer > m_nTrkKey
Definition: JetQGTaggerVariableTool.h:68
xAOD::Jet_v1::numConstituents
size_t numConstituents() const
Number of constituents in this jets (this is valid even when reading a file where the constituents ha...
Definition: Jet_v1.cxx:153
xAOD::JetAttribute::GhostTrack
@ GhostTrack
Definition: JetAttributes.h:252
SG::DataProxy
Definition: DataProxy.h:45
pow
constexpr int pow(int base, int exp) noexcept
Definition: ap_fixedTest.cxx:15
xAOD::Jet_v1::pt
virtual double pt() const
The transverse momentum ( ) of the particle.
Definition: Jet_v1.cxx:44
xAOD::TrackParticle_v1::theta
float theta() const
Returns the parameter, which has range 0 to .
DataVector::size
size_type size() const noexcept
Returns the number of elements in the collection.
AthCommonDataStore::declareGaudiProperty
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition: AthCommonDataStore.h:156
checkFileSG.ind
list ind
Definition: checkFileSG.py:118
fitman.k
k
Definition: fitman.py:528