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

creates a jet::TrackVertexAssociation object More...

#include <TrackVertexAssociationTool.h>

Inheritance diagram for TrackVertexAssociationTool:
Collaboration diagram for TrackVertexAssociationTool:

Public Member Functions

 TrackVertexAssociationTool (const std::string &t)
 
StatusCode initialize ()
 Dummy implementation of the initialisation function. More...
 
int execute () const
 Method to be called for each event. 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 int inputContainerNames (std::vector< std::string > &connames)
 Method to return the list of input containers. More...
 
virtual int outputContainerNames (std::vector< std::string > &connames)
 Method to return the list of output containers. 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

std::unique_ptr< jet::TrackVertexAssociationbuildTrackVertexAssociation_withTool (const xAOD::TrackParticleContainer *, const xAOD::VertexContainer *) const
 
std::unique_ptr< jet::TrackVertexAssociationbuildTrackVertexAssociation_custom (const xAOD::TrackParticleContainer *, const xAOD::VertexContainer *) const
 
std::unique_ptr< jet::TrackVertexAssociationmakeTrackVertexAssociation (const xAOD::TrackParticleContainer *, const xAOD::VertexContainer *, bool useCustom) 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

ToolHandle< CP::ITrackVertexAssociationToolm_tvaTool
 
float m_transDistMax
 
float m_longDistMax
 
float m_maxZ0SinTheta
 
SG::ReadHandleKey< xAOD::TrackParticleContainerm_trackContainer_key
 
SG::ReadHandleKey< xAOD::VertexContainerm_vertexContainer_key
 
SG::WriteHandleKey< jet::TrackVertexAssociationm_tva_key
 
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

creates a jet::TrackVertexAssociation object

Creates a jet::TrackVertexAssociation map. The tool expects a ITrackVertexAssociationTool which it uses to create the map from a TrackParticleContainer and a VertexContainer. The map is recorded in the evtStore.

Properties :

If the TrackVertexAssoTool is left blank, the old custom method is used to build the code using cuts defined by these properties

Definition at line 45 of file Reconstruction/Jet/JetRecTools/JetRecTools/TrackVertexAssociationTool.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

◆ TrackVertexAssociationTool()

TrackVertexAssociationTool::TrackVertexAssociationTool ( const std::string &  t)

Definition at line 10 of file Reconstruction/Jet/JetRecTools/Root/TrackVertexAssociationTool.cxx.

11  : AsgTool(t)
12  , m_tvaTool("",this) // default as empty
13  , m_transDistMax(10e6)
14  , m_longDistMax(10e6)
15  , m_maxZ0SinTheta(10e6)
16 {
17  declareProperty("TrackVertexAssoTool", m_tvaTool); // Tool handle
18 
19  declareProperty("MaxTransverseDistance",m_transDistMax);
20  declareProperty("MaxLongitudinalDistance",m_longDistMax);
21  declareProperty("MaxZ0SinTheta", m_maxZ0SinTheta);
22 
23  declareProperty("TrackParticleContainer",m_trackContainer_key);
24  declareProperty("VertexContainer",m_vertexContainer_key);
25  declareProperty("TrackVertexAssociation",m_tva_key);
26 
27 }

Member Function Documentation

◆ buildTrackVertexAssociation_custom()

std::unique_ptr< jet::TrackVertexAssociation > TrackVertexAssociationTool::buildTrackVertexAssociation_custom ( const xAOD::TrackParticleContainer trackContainer,
const xAOD::VertexContainer vertexContainer 
) const
private

Definition at line 141 of file Reconstruction/Jet/JetRecTools/Root/TrackVertexAssociationTool.cxx.

142 {
143  ATH_MSG_DEBUG("Building track-vertex association trk size="<< trackContainer->size()
144  << " vtx size="<< vertexContainer->size());
145 
146  auto tva = std::make_unique<jet::TrackVertexAssociation>(trackContainer);
147 
148  for (size_t iTrack = 0; iTrack < trackContainer->size(); ++iTrack)
149  {
150  const xAOD::TrackParticle* track = trackContainer->at(iTrack);
151 
152  // Apply track transverse distance cut
153  const float transverseDistance = track->d0();//perigeeParameters().parameters()[Trk::d0];
154  if (transverseDistance > m_transDistMax) continue;
155 
156 
157  // Get track longitudinal distance offset
158  const float longitudinalDistance = track->z0()+track->vz();
159 
160  double sinTheta = std::sin(track->theta());
161 
162  // For each track, find the vertex with highest sum pt^2 within z0 cut
163  size_t matchedIndex = 0;
164  bool foundMatch = false;
165  for (size_t iVertex = 0; iVertex < vertexContainer->size(); ++iVertex)
166  {
167  const xAOD::Vertex* vertex = vertexContainer->at(iVertex);
168 
169  double deltaz = longitudinalDistance - vertex->z();
170 
171  // Check longitudinal distance between track and vertex
172  if ( fabs(deltaz) > m_longDistMax)
173  continue;
174 
175  // Check z0*sinThetha between track and vertex
176  if (fabs(deltaz*sinTheta) > m_maxZ0SinTheta)
177  continue;
178 
179  // If it passed the cuts, then this is the vertex we want
180  // This does make the assumption that the container is sorted in sum pT^2 order
181  foundMatch = true;
182  matchedIndex = iVertex;
183  break;
184  }
185 
186  // If we matched a vertex, then associate that vertex to the track
187  if (foundMatch)
188  tva->associate(trackContainer->at(iTrack),vertexContainer->at(matchedIndex));
189  }
190 
191 
192  // Return the TVA object
193  return tva;
194 }

◆ buildTrackVertexAssociation_withTool()

std::unique_ptr< jet::TrackVertexAssociation > TrackVertexAssociationTool::buildTrackVertexAssociation_withTool ( const xAOD::TrackParticleContainer trackContainer,
const xAOD::VertexContainer vertexContainer 
) const
private

Definition at line 119 of file Reconstruction/Jet/JetRecTools/Root/TrackVertexAssociationTool.cxx.

120 {
121 
122  ATH_MSG_DEBUG("Building track-vertex association USING InDet tool. trk size="<< trackContainer->size()
123  << " vtx size="<< vertexContainer->size());
124 
125  auto tva = std::make_unique<jet::TrackVertexAssociation>(trackContainer);
126 
127  std::vector<const xAOD::Vertex*> vecVert;
128  vecVert.assign(vertexContainer->begin(), vertexContainer->end());
129 
130  for( const xAOD::TrackParticle* track : *trackContainer) {
131 
132  const xAOD::Vertex * v = m_tvaTool->getUniqueMatchVertex(*track, vecVert) ;
133  tva->associate( track, v );
134  }
135  return tva;
136 }

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

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

◆ execute()

int TrackVertexAssociationTool::execute ( ) const
virtual

Method to be called for each event.

Returns 0 for success.

Implements IJetExecuteTool.

Definition at line 46 of file Reconstruction/Jet/JetRecTools/Root/TrackVertexAssociationTool.cxx.

46  {
47  // Get input track collection
48 
49  auto handle_tracks = SG::makeHandle(m_trackContainer_key);
50 
51  if(!handle_tracks.isValid()){
52  ATH_MSG_ERROR("Error retrieving TrackParticleContainer from evtStore: "
54  return 1;
55  }
56 
57  const auto *trackContainer = handle_tracks.cptr();
58 
59 
60  // If this is a view container, then we assume that it contains elements from only one owning container
61  if ( trackContainer->ownPolicy() != SG::OWN_ELEMENTS ) {
62  bool oneOwningContainer(true);
63  for(const xAOD::TrackParticle* track : *trackContainer) {
64  if(track->container() != trackContainer->front()->container()) {
65  oneOwningContainer=false;
66  break;
67  }
68  }
69  if(!oneOwningContainer) {
70  ATH_MSG_ERROR("Track view container holds track from multiple owning containers.");
71  ATH_MSG_ERROR("Problem is this container: " << m_trackContainer_key.key());
72  return 11;
73  }
74  }
75 
76  // Get input vertex collection
77  auto handle_vert = SG::makeHandle(m_vertexContainer_key);
78 
79  if(!handle_vert.isValid()){
80  ATH_MSG_ERROR("Error retrieving VertexContainer from evtStore: "
81  << m_vertexContainer_key.key());
82  return 2;
83  }
84 
85  const auto *vertexContainer = handle_vert.cptr();
86 
87  auto useCustom = m_tvaTool.empty();
88  auto tva = makeTrackVertexAssociation(trackContainer,
89  vertexContainer,
90  useCustom);
91  // Check the result.
92  // if ( tva == nullptr ) {
93  if (!tva){
94  ATH_MSG_ERROR("Could not build the TrackVertexAssociation");
95  return 3;
96  }
97 
98  // Store it
99 
100  auto handle_tva = SG::makeHandle(m_tva_key);
101  if(!handle_tva.record(std::move(tva))){
102  ATH_MSG_ERROR("Unable to write new TrackVertexAssociation to evtStore: "
103  << m_tva_key.key());
104  return 4;
105  }
106 
107  // Success
108  ATH_MSG_DEBUG("Wrote new TrackVertexAssociation to evtStore: "
109  << m_tva_key.key());
110  return 0;
111 }

◆ 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

◆ 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 TrackVertexAssociationTool::initialize ( )
virtual

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 Reconstruction/Jet/JetRecTools/Root/TrackVertexAssociationTool.cxx.

29  {
30  ATH_MSG_INFO("Initializing tool " << name() << "...");
31  ATH_MSG_DEBUG("initializing version with data handles");
32 
34  ATH_CHECK(m_vertexContainer_key.initialize());
36 
37  if(! m_tvaTool.empty() ) {
38  ATH_MSG_INFO("Intialized using ITrackVertexAssociationTool");
39  return m_tvaTool.retrieve();
40  }
41 
42  ATH_MSG_INFO("Intialized using custom track-vertex association");
43  return StatusCode::SUCCESS;
44 }

◆ inputContainerNames()

int IJetExecuteTool::inputContainerNames ( std::vector< std::string > &  connames)
virtualinherited

Method to return the list of input containers.

The names of required input containers are appended to connames. Returns nonzero for error. Default returns 0 and adds no names.

Reimplemented in JetRecTool.

Definition at line 11 of file IJetExecuteTool.cxx.

11  {
12  return 0;
13 }

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

◆ makeTrackVertexAssociation()

std::unique_ptr< jet::TrackVertexAssociation > TrackVertexAssociationTool::makeTrackVertexAssociation ( const xAOD::TrackParticleContainer ,
const xAOD::VertexContainer ,
bool  useCustom 
) const
private

Definition at line 199 of file Reconstruction/Jet/JetRecTools/Root/TrackVertexAssociationTool.cxx.

201  {
202  if (useCustom) {
203  return buildTrackVertexAssociation_custom(trackContainer,
204  vertexContainer);
205  } else {
206  return buildTrackVertexAssociation_withTool(trackContainer,
207  vertexContainer);
208  }
209 }

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

◆ outputContainerNames()

int IJetExecuteTool::outputContainerNames ( std::vector< std::string > &  connames)
virtualinherited

Method to return the list of output containers.

The names of produced output containers are appended to connames. Returns nonzero for error. Default returns 0 and adds no names.

Reimplemented in JetRecTool.

Definition at line 17 of file IJetExecuteTool.cxx.

17  {
18  return 0;
19 }

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

float TrackVertexAssociationTool::m_longDistMax
private

◆ m_maxZ0SinTheta

float TrackVertexAssociationTool::m_maxZ0SinTheta
private

◆ m_trackContainer_key

SG::ReadHandleKey<xAOD::TrackParticleContainer> TrackVertexAssociationTool::m_trackContainer_key
private

◆ m_transDistMax

float TrackVertexAssociationTool::m_transDistMax
private

◆ m_tva_key

SG::WriteHandleKey<jet::TrackVertexAssociation> TrackVertexAssociationTool::m_tva_key
private

◆ m_tvaTool

ToolHandle<CP::ITrackVertexAssociationTool> TrackVertexAssociationTool::m_tvaTool
private

◆ m_varHandleArraysDeclared

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

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vertexContainer_key

SG::ReadHandleKey<xAOD::VertexContainer> TrackVertexAssociationTool::m_vertexContainer_key
private

◆ 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:
StateLessPT_NewConfig.proxy
proxy
Definition: StateLessPT_NewConfig.py:392
ATH_MSG_INFO
#define ATH_MSG_INFO(x)
Definition: AthMsgStreamMacros.h:31
TrackVertexAssociationTool::m_longDistMax
float m_longDistMax
Definition: Reconstruction/Jet/JetRecTools/JetRecTools/TrackVertexAssociationTool.h:80
AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
Definition: AthCommonDataStore.h:145
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
read_hist_ntuple.t
t
Definition: read_hist_ntuple.py:5
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
TrackVertexAssociationTool::buildTrackVertexAssociation_custom
std::unique_ptr< jet::TrackVertexAssociation > buildTrackVertexAssociation_custom(const xAOD::TrackParticleContainer *, const xAOD::VertexContainer *) const
Definition: Reconstruction/Jet/JetRecTools/Root/TrackVertexAssociationTool.cxx:141
TrackVertexAssociationTool::makeTrackVertexAssociation
std::unique_ptr< jet::TrackVertexAssociation > makeTrackVertexAssociation(const xAOD::TrackParticleContainer *, const xAOD::VertexContainer *, bool useCustom) const
Definition: Reconstruction/Jet/JetRecTools/Root/TrackVertexAssociationTool.cxx:199
TrackVertexAssociationTool::m_tvaTool
ToolHandle< CP::ITrackVertexAssociationTool > m_tvaTool
Definition: Reconstruction/Jet/JetRecTools/JetRecTools/TrackVertexAssociationTool.h:75
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
asg::AsgTool::AsgTool
AsgTool(const std::string &name)
Constructor specifying the tool instance's name.
Definition: AsgTool.cxx:58
python.utils.AtlRunQueryDQUtils.p
p
Definition: AtlRunQueryDQUtils.py:210
AthCommonDataStore
Definition: AthCommonDataStore.h:52
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
TrackVertexAssociationTool::m_tva_key
SG::WriteHandleKey< jet::TrackVertexAssociation > m_tva_key
Definition: Reconstruction/Jet/JetRecTools/JetRecTools/TrackVertexAssociationTool.h:85
SG::OWN_ELEMENTS
@ OWN_ELEMENTS
this data object owns its elements
Definition: OwnershipPolicy.h:17
TrackVertexAssociationTool::m_vertexContainer_key
SG::ReadHandleKey< xAOD::VertexContainer > m_vertexContainer_key
Definition: Reconstruction/Jet/JetRecTools/JetRecTools/TrackVertexAssociationTool.h:84
TrackVertexAssociationTool::m_maxZ0SinTheta
float m_maxZ0SinTheta
Definition: Reconstruction/Jet/JetRecTools/JetRecTools/TrackVertexAssociationTool.h:81
ATH_MSG_DEBUG
#define ATH_MSG_DEBUG(x)
Definition: AthMsgStreamMacros.h:29
TrackVertexAssociationTool::buildTrackVertexAssociation_withTool
std::unique_ptr< jet::TrackVertexAssociation > buildTrackVertexAssociation_withTool(const xAOD::TrackParticleContainer *, const xAOD::VertexContainer *) const
Definition: Reconstruction/Jet/JetRecTools/Root/TrackVertexAssociationTool.cxx:119
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
TrackVertexAssociationTool::m_trackContainer_key
SG::ReadHandleKey< xAOD::TrackParticleContainer > m_trackContainer_key
Definition: Reconstruction/Jet/JetRecTools/JetRecTools/TrackVertexAssociationTool.h:83
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
Definition: AthCommonDataStore.h:393
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
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_scale_histograms.doc
string doc
Definition: merge_scale_histograms.py:9
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:228
DataVector::end
const_iterator end() const noexcept
Return a const_iterator pointing past the end of the collection.
python.PyAthena.v
v
Definition: PyAthena.py:154
Trk::vertex
@ vertex
Definition: MeasurementType.h:21
a
TList * a
Definition: liststreamerinfos.cxx:10
h
xAOD::Vertex_v1
Class describing a Vertex.
Definition: Vertex_v1.h:42
TrackVertexAssociationTool::m_transDistMax
float m_transDistMax
Definition: Reconstruction/Jet/JetRecTools/JetRecTools/TrackVertexAssociationTool.h:79
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:623
python.Bindings.keys
keys
Definition: Control/AthenaPython/python/Bindings.py:798
xAOD::track
@ track
Definition: TrackingPrimitives.h:512
xAOD::TrackParticle_v1
Class describing a TrackParticle.
Definition: TrackParticle_v1.h:43
DataVector::at
const T * at(size_type n) const
Access an element, as an rvalue.
drawFromPickle.sin
sin
Definition: drawFromPickle.py:36
SG::DataProxy
Definition: DataProxy.h:45
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
DataVector::begin
const_iterator begin() const noexcept
Return a const_iterator pointing at the beginning of the collection.
fitman.k
k
Definition: fitman.py:528