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

#include <JetConstituentsRetriever.h>

Inheritance diagram for JetConstituentsRetriever:
Collaboration diagram for JetConstituentsRetriever:

Public Types

typedef std::vector< fastjet::PseudoJet > PseudoJetVector
 
typedef std::vector< std::string > NameList
 

Public Member Functions

 JetConstituentsRetriever (const std::string &name)
 
StatusCode initialize ()
 Dummy implementation of the initialisation function. More...
 
int constituents (const xAOD::Jet &jet, PseudoJetVector &cons, NameList *pghostlabs=nullptr) const
 Append constituents to the supplied vector. More...
 
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
 

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

bool m_usepj
 
bool m_usejetcons
 
ToolHandle< IJetPseudojetRetrieverm_hpjr
 
NameList m_glabs
 
double m_gscale
 
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

Author
David Adams
Date
November 2014

Tool to retrieve the constituents associated with a jet.

Properties:

Definition at line 28 of file JetConstituentsRetriever.h.

Member Typedef Documentation

◆ NameList

typedef std::vector<std::string> IJetConstituentsRetriever::NameList
inherited

Definition at line 33 of file IJetConstituentsRetriever.h.

◆ PseudoJetVector

typedef std::vector<fastjet::PseudoJet> IJetConstituentsRetriever::PseudoJetVector
inherited

Definition at line 32 of file IJetConstituentsRetriever.h.

◆ StoreGateSvc_t

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

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ JetConstituentsRetriever()

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

Definition at line 26 of file JetConstituentsRetriever.cxx.

27  : AsgTool(name), m_hpjr("",this) {
28  declareProperty("UsePseudojet", m_usepj =true);
29  declareProperty("UseJetConstituents", m_usejetcons =true);
30  declareProperty("PseudojetRetriever", m_hpjr);
31  declareProperty("GhostLabels", m_glabs);
32  declareProperty("GhostScale", m_gscale);
33 }

Member Function Documentation

◆ constituents()

int JetConstituentsRetriever::constituents ( const xAOD::Jet jet,
PseudoJetVector cons,
NameList pghostlabs = nullptr 
) const
virtual

Append constituents to the supplied vector.

Implements IJetConstituentsRetriever.

Definition at line 48 of file JetConstituentsRetriever.cxx.

50  {
51  // If flag is set, try to retrieve constituents from jet pseudojet.
52  if ( m_usepj ) {
53  ATH_MSG_VERBOSE("Using pseudojet to search for constituents.");
54  if ( m_hpjr.empty() ) {
55  ATH_MSG_WARNING("Pseudojet retriever not found.");
56  } else {
57  const fastjet::PseudoJet* ppj = m_hpjr->pseudojet(jet);
58  if ( ppj == nullptr ) {
59  ATH_MSG_VERBOSE("Pseudojet not found.");
60  } else {
61  if ( ! ppj->has_constituents() ) {
62  ATH_MSG_WARNING("Jet pseudojet does not have constituents.");
63  } else {
64  PseudoJetVector pjcons = ppj->constituents();
65  constits.insert(constits.end(), pjcons.begin(), pjcons.end());
66  return 0;
67  }
68  }
69  }
70  }
71  // Remainder requires access to the label index map;
72  jet::LabelIndex* pli = nullptr;
73  const string liname = "PseudoJetLabelMap";
74  if ( evtStore()->contains<jet::LabelIndex>(liname) ) {
75  ATH_MSG_DEBUG("Fetching existing pseudojet label map.");
76  pli = evtStore()->retrieve<jet::LabelIndex>(liname);
77  if ( pli == nullptr ) {
78  ATH_MSG_ERROR("Unable to fetch pseudojet label map.");
79  return 1;
80  }
81  } else {
82  ATH_MSG_DEBUG("Creating new pseudojet label map.");
83  pli = new jet::LabelIndex(liname);
84  if ( evtStore()->record(pli, liname).isFailure() ) {
85  ATH_MSG_ERROR("Unable to store pseudojet label map.");
86  return 2;
87  }
88  }
89  // Add ATLAS jet constituents.
90  if ( m_usejetcons ) {
91  xAOD::JetInput::Type intype = jet.getInputType();
92  string lab = xAOD::JetInput::typeName(intype);
93  int labidx = pli->addLabel(lab);
94  ATH_MSG_DEBUG("Jet input type is " << lab);
95  ATH_MSG_VERBOSE("Looping over " << jet.getConstituents().size()
96  << " real constituents.");
97  for ( const auto *const pjetcon : jet.getConstituents() ) {
98  if ( pjetcon == nullptr ) {
99  ATH_MSG_WARNING("Jet has null constituent");
100  } else {
101  //fastjet::PseudoJet psj(*pjetcon);
102  fastjet::PseudoJet psj(pjetcon->px(), pjetcon->py(), pjetcon->pz(), pjetcon->e());
103  const xAOD::IParticle* ppar = pjetcon->rawConstituent();
105  new jet::IndexedConstituentUserInfo(*ppar, labidx, pli);
106  psj.set_user_info(pcui);
107  constits.push_back(psj);
108  ATH_MSG_VERBOSE(" Real user info: particle=" << pcui->particle()
109  << ", index=" << pcui->index()
110  << ", label=" << pcui->label()
111  << ", isGhost=" << pcui->isGhost());
112  }
113  }
114  }
115  // Add ghosts.
116  NameList glabs;
117  ATH_MSG_VERBOSE("Looping over " << m_glabs.size() << " ghost labels.");
118  for ( const std::string& glab : m_glabs ) {
119  string gname = "Ghost" + glab;
120  double fac = m_gscale;
121  if ( glab == "MuonSegment" ) {
122  MuonSegmentVector psegs;
123  if ( jet.getAssociatedObjects(gname, psegs) ) {
124  ATH_MSG_VERBOSE(" Found Muon segment vector " << gname << " with "
125  << psegs.size() << " entries.");
126  int labidx = pli->addLabel(glab);
127  glabs.push_back(glab);
128  unsigned int iseg = 0;
129  for ( const MuonSegment* pseg : psegs ) {
130  if ( pseg == nullptr ) {
131  ATH_MSG_DEBUG("Muon segment not found: " << gname << "[" << iseg << "]");
132  } else {
133  // Cut and paste from MuonSegmentPseudoJetGetter.
134  double pt = 1.0e-20; // Should be property?
135  double x = pseg->x();
136  double y = pseg->y();
137  double z = pseg->z();
138  double xy = sqrt(x*x + y*y);
139  double r = xy*xy + z*z;
140  double pfac = pt/xy;
141  double px = pfac*x;
142  double py = pfac*y;
143  double pz = pfac*z;
144  double e = pfac*r;
145  fastjet::PseudoJet psj(px, py, pz, e);
147  new jet::IndexedTConstituentUserInfo<MuonSegment>(*pseg, -labidx, pli);
148  psj.set_user_info(pcui);
149  constits.push_back(psj);
150  ATH_MSG_VERBOSE(" Muon ghost user info: particle=" << pcui->particle()
151  << ", index=" << pcui->index()
152  << ", label=" << pcui->label()
153  << ", isGhost=" << pcui->isGhost());
154  ATH_MSG_VERBOSE(" Adding " << gname << "[" << iseg << "]");
155  }
156  ++iseg;
157  }
158  } else {
159  ATH_MSG_VERBOSE(" Muon segment vector " << gname << " is not found on jet.");
160  }
161 
162  } else {
163  IParticleVector ppars;
164  if ( jet.getAssociatedObjects(gname, ppars) ) {
165  ATH_MSG_VERBOSE(" Found IParticle vector " << gname << " with "
166  << ppars.size() << " entries.");
167  int labidx = pli->addLabel(glab);
168  glabs.push_back(glab);
169  unsigned int ipar = 0;
170  for ( const IParticle* ppar : ppars ) {
171  if ( ppar == nullptr ) {
172  ATH_MSG_DEBUG("IParticle not found: " << gname << "[" << ipar << "]");
173  } else {
174  auto p4 = ppar->p4();
175  fastjet::PseudoJet psj(fac*p4.Px(), fac*p4.Py(), fac*p4.Pz(), fac*p4.E());
177  new jet::IndexedConstituentUserInfo(*ppar, -labidx, pli);
178  psj.set_user_info(pcui);
179  constits.push_back(psj);
180  ATH_MSG_VERBOSE(" Ghost user info: particle=" << pcui->particle()
181  << ", index=" << pcui->index()
182  << ", label=" << pcui->label()
183  << ", isGhost=" << pcui->isGhost());
184  ATH_MSG_VERBOSE(" Adding " << gname << "[" << ipar << "]");
185  }
186  ++ipar;
187  }
188  } else {
189  ATH_MSG_VERBOSE(" IParticle vector " << gname << " is not found on jet.");
190  }
191  }
192  }
193  if ( pghostlabs != nullptr ) {
194  pghostlabs->insert(pghostlabs->end(), glabs.begin(), glabs.end());
195  }
196  return 1;
197 }

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

◆ 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 JetConstituentsRetriever::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 37 of file JetConstituentsRetriever.cxx.

37  {
38  if ( m_usepj ) {
39  if ( m_hpjr.empty() ) {
40  ATH_MSG_ERROR(" PseudojetRetriever is missing.");
41  }
42  }
43  return StatusCode::SUCCESS;
44 }

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

◆ 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 JetConstituentsRetriever::print ( ) const
virtual

Print the state of the tool.

Reimplemented from asg::AsgTool.

Definition at line 201 of file JetConstituentsRetriever.cxx.

201  {
202  ATH_MSG_INFO("JetConstituentsRetriever");
203  ATH_MSG_INFO(" UsePseudojet: " << m_usepj);
204  if ( m_usepj ) {
205  if ( m_hpjr.empty() ) {
206  ATH_MSG_INFO(" PseudojetRetriever is missing.");
207  } else {
208  ATH_MSG_INFO(" PseudojetRetriever: " << m_hpjr->name());
209  }
210  }
211  ATH_MSG_INFO(" UsePseudojet: " << m_usepj);
212  if ( m_glabs.empty() ) {
213  ATH_MSG_INFO(" GhostLabels:");
214  for ( const std::string& glab : m_glabs ) {
215  ATH_MSG_INFO(" " << glab);
216  }
217  }
218  ATH_MSG_INFO(" GhostScale: " << m_gscale);
219 }

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

NameList JetConstituentsRetriever::m_glabs
private

Definition at line 53 of file JetConstituentsRetriever.h.

◆ m_gscale

double JetConstituentsRetriever::m_gscale
private

Definition at line 54 of file JetConstituentsRetriever.h.

◆ m_hpjr

ToolHandle<IJetPseudojetRetriever> JetConstituentsRetriever::m_hpjr
private

Definition at line 52 of file JetConstituentsRetriever.h.

◆ m_usejetcons

bool JetConstituentsRetriever::m_usejetcons
private

Definition at line 51 of file JetConstituentsRetriever.h.

◆ m_usepj

bool JetConstituentsRetriever::m_usepj
private

Definition at line 50 of file JetConstituentsRetriever.h.

◆ m_varHandleArraysDeclared

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

Definition at line 399 of file AthCommonDataStore.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:
AllowedVariables::e
e
Definition: AsgElectronSelectorTool.cxx:37
beamspotman.r
def r
Definition: beamspotman.py:676
jet::LabelIndex
Definition: LabelIndex.h:22
test_pyathena.px
px
Definition: test_pyathena.py:18
StateLessPT_NewConfig.proxy
proxy
Definition: StateLessPT_NewConfig.py:392
ATH_MSG_INFO
#define ATH_MSG_INFO(x)
Definition: AthMsgStreamMacros.h:31
AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
Definition: AthCommonDataStore.h:145
IParticleVector
std::vector< const IParticle * > IParticleVector
Definition: JetConstituentsRetriever.cxx:19
test_pyathena.pt
pt
Definition: test_pyathena.py:11
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
Definition: AthCommonDataStore.h:390
JetConstituentsRetriever::m_usepj
bool m_usepj
Definition: JetConstituentsRetriever.h:50
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka
std::vector< SG::VarHandleKeyArray * > m_vhka
Definition: AthCommonDataStore.h:398
jet::IConstituentUserInfo::particle
virtual const xAOD::IParticle * particle() const =0
read_hist_ntuple.t
t
Definition: read_hist_ntuple.py:5
ReadBchFromCool.gname
gname
Definition: ReadBchFromCool.py:415
ATH_MSG_VERBOSE
#define ATH_MSG_VERBOSE(x)
Definition: AthMsgStreamMacros.h:28
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::JetInput::typeName
const std::string & typeName(Type id)
Definition: JetContainerInfo.cxx:199
x
#define x
xAOD::MuonSegment
MuonSegment_v1 MuonSegment
Reference the current persistent version:
Definition: Event/xAOD/xAODMuon/xAODMuon/MuonSegment.h:13
python.iconfTool.models.loaders.level
level
Definition: loaders.py:20
SG::VarHandleKeyArray::setOwner
virtual void setOwner(IDataHandleHolder *o)=0
jet::IndexedTConstituentUserInfo
Definition: IndexedTConstituentUserInfo.h:31
IDTPMcnv.htype
htype
Definition: IDTPMcnv.py:29
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
jet
Definition: JetCalibTools_PlotJESFactors.cxx:23
AthCommonDataStore
Definition: AthCommonDataStore.h:52
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
z
#define z
jet::IConstituentUserInfo::isGhost
virtual bool isGhost() const
Returns true if this constituent is a ghost.
Definition: IConstituentUserInfo.cxx:26
jet::LabelIndex::addLabel
Index addLabel(const Label &lab)
Add a label and get its index.
Definition: LabelIndex.cxx:23
ATH_MSG_DEBUG
#define ATH_MSG_DEBUG(x)
Definition: AthMsgStreamMacros.h:29
Amg::pz
@ pz
Definition: GeoPrimitives.h:40
jet::IConstituentUserInfo::index
virtual Index index() const
Definition: IConstituentUserInfo.cxx:14
jet::IConstituentUserInfo::label
virtual Label label() const =0
python.xAODType.dummy
dummy
Definition: xAODType.py:4
JetConstituentsRetriever::m_gscale
double m_gscale
Definition: JetConstituentsRetriever.h:54
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::JetInput::Type
Type
Definition: JetContainerInfo.h:54
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
jet::IndexedConstituentUserInfo
Definition: IndexedConstituentUserInfo.h:28
Amg::py
@ py
Definition: GeoPrimitives.h:39
merge_scale_histograms.doc
string doc
Definition: merge_scale_histograms.py:9
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:228
JetConstituentsRetriever::m_usejetcons
bool m_usejetcons
Definition: JetConstituentsRetriever.h:51
xAOD::IParticle::p4
virtual FourMom_t p4() const =0
The full 4-momentum of the particle.
PseudoJetVector
std::vector< fastjet::PseudoJet > PseudoJetVector
Definition: JetConstituentFiller.cxx:17
a
TList * a
Definition: liststreamerinfos.cxx:10
MuonSegmentVector
std::vector< const MuonSegment * > MuonSegmentVector
Definition: JetConstituentFiller.cxx:27
y
#define y
h
NameList
IJetConstituentsRetriever::NameList NameList
Definition: JetConstituentsRetriever.cxx:22
jet::IConstituentUserInfo
Definition: IConstituentUserInfo.h:26
ATH_MSG_WARNING
#define ATH_MSG_WARNING(x)
Definition: AthMsgStreamMacros.h:32
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
JetConstituentsRetriever::m_glabs
NameList m_glabs
Definition: JetConstituentsRetriever.h:53
SG::DataProxy
Definition: DataProxy.h:45
IParticle
Definition: Event/EventKernel/EventKernel/IParticle.h:43
AthCommonDataStore::declareGaudiProperty
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition: AthCommonDataStore.h:156
JetConstituentsRetriever::m_hpjr
ToolHandle< IJetPseudojetRetriever > m_hpjr
Definition: JetConstituentsRetriever.h:52
fitman.k
k
Definition: fitman.py:528