ATLAS Offline Software
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
JiveXML::xAODCaloClusterRetriever Class Reference

Retrieves all Calo Cluster objects. More...

#include <xAODCaloClusterRetriever.h>

Inheritance diagram for JiveXML::xAODCaloClusterRetriever:
Collaboration diagram for JiveXML::xAODCaloClusterRetriever:

Public Member Functions

 xAODCaloClusterRetriever (const std::string &type, const std::string &name, const IInterface *parent)
 Standard Constructor. More...
 
virtual StatusCode retrieve (ToolHandle< IFormatTool > &FormatTool)
 For each cluster collection retrieve basic parameters. More...
 
const DataMap getData (const xAOD::CaloClusterContainer *)
 Puts the variables into a DataMap. More...
 
const std::vector< std::string > getKeys ()
 Gets the StoreGate keys for the desired containers. More...
 
virtual std::string dataTypeName () const
 Return the name of the data type that is generated by this retriever. 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
 

Static Public Member Functions

static const InterfaceID & interfaceID ()
 Return the interface identifier. 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

const std::string m_typeName = "Cluster"
 The data type that is generated by this retriever. More...
 
Gaudi::Property< bool > m_doWriteHLT {this, "DoWriteHLT", false, "Write out other collections that have HLT in the name"}
 
Gaudi::Property< bool > m_doWriteAllCollections {this, "DoWriteAllCollections", false, "Write out all CaloCluster collections"}
 
Gaudi::Property< std::vector< std::string > > m_otherKeys {this, "OtherClusterCollections", {}, "Other collections to be retrieved. If DoWriteAllCollections is set to true all available CaloCluster collections will be retrieved"}
 
Gaudi::Property< std::string > m_priorityKey {this,"PriorityClusterCollection","egammaClusters", "Name of the priority CaloCluster container that will be written out first"}
 
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

Retrieves all Calo Cluster objects.

Definition at line 37 of file xAODCaloClusterRetriever.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

◆ xAODCaloClusterRetriever()

JiveXML::xAODCaloClusterRetriever::xAODCaloClusterRetriever ( const std::string &  type,
const std::string &  name,
const IInterface *  parent 
)

Standard Constructor.

This is the standard AthAlgTool constructor.

Parameters
typeAlgTool type name
nameAlgTool instance name
parentAlgTools parent owning this tool

Definition at line 19 of file xAODCaloClusterRetriever.cxx.

19  :
21  {}

Member Function Documentation

◆ dataTypeName()

virtual std::string JiveXML::xAODCaloClusterRetriever::dataTypeName ( ) const
inlinevirtual

Return the name of the data type that is generated by this retriever.

Implements JiveXML::IDataRetriever.

Definition at line 51 of file xAODCaloClusterRetriever.h.

51 { return m_typeName; };

◆ 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

◆ getData()

const DataMap JiveXML::xAODCaloClusterRetriever::getData ( const xAOD::CaloClusterContainer ccc)

Puts the variables into a DataMap.

Retrieve basic parameters, mainly four-vectors.

AOD Clusters have no cells (trying to access them without back-navigation causes Athena crash).

Parameters
FormatToolthe tool that will create formated output from the DataMap

Definition at line 63 of file xAODCaloClusterRetriever.cxx.

63  {
64 
65  ATH_MSG_DEBUG("in getData()");
66 
68 
69  DataVect phi; phi.reserve(ccc->size());
70  DataVect eta; eta.reserve(ccc->size());
71  DataVect et; et.reserve(ccc->size());
72  DataVect cells; cells.reserve(ccc->size());
73  DataVect numCells; numCells.reserve(ccc->size());
74  DataVect idVec; idVec.reserve(ccc->size());
75  DataVect emfracVec; emfracVec.reserve(ccc->size());
76  DataVect labelVec; labelVec.reserve(ccc->size());
77 
78  std::string label="";
79  int id = 0;
80  int s = 0;
81  float eInSample = 0.;
82  float eInSampleFull = 0.;
83  float emfrac = 0.;
84  float rawemfrac = 0.;
85 
86  // cells n/a in AOD, but keep this for compatibility
87  // with 'full' clusters in AtlantisJava
88  std::string tagCells;
89  tagCells = "cells multiple=\"1.0\"";
90 
92  for (; itr != ccc->end(); ++itr) {
93 
94  // sum over samplings to get EMfraction:
96  // full sum:
97  for (s=0;s<CaloSampling::Unknown; s++){
98  eInSampleFull += (*itr)->eSample(CaloSampling::CaloSample(s));
99  }
100  // Now only EMB1-3, EME1-3 and FCAL1:
101  eInSample += (*itr)->eSample(CaloSampling::EMB1);
102  eInSample += (*itr)->eSample(CaloSampling::EMB2);
103  eInSample += (*itr)->eSample(CaloSampling::EMB3);
104  eInSample += (*itr)->eSample(CaloSampling::EME1);
105  eInSample += (*itr)->eSample(CaloSampling::EME2);
106  eInSample += (*itr)->eSample(CaloSampling::EME3);
107  eInSample += (*itr)->eSample(CaloSampling::FCAL1);
108 
109  emfrac = eInSample/eInSampleFull;
110  rawemfrac = emfrac;
111  // sanity cut: emfrac should be within [0,1]
112  if ( emfrac > 1.0 ) emfrac = 1.;
113  if ( emfrac < 0.0 ) emfrac = 0.;
114  emfracVec.emplace_back( DataType(emfrac).toString() );
115 
116  if ( DataType( eInSample ).toString() != "0." ){
117  label = "AllMeV_SumEMSampl=" + DataType( eInSample ).toString() +
118  "_SumAllSampl=" + DataType( eInSampleFull ).toString() +
119  "_calcEMFrac=" + DataType( rawemfrac ).toString()+
120  "_outEMFrac=" + DataType( emfrac ).toString();
121  }else{ label = "n_a"; }
122  eInSample = 0.;
123  eInSampleFull = 0.;
124 
125  labelVec.emplace_back( label );
126  ATH_MSG_VERBOSE("label is " << label);
127 
128  // now the standard variables
129  // getBasicEnergy n/a in xAOD !
130 
131  phi.emplace_back(DataType((*itr)->phi()));
132  eta.emplace_back(DataType((*itr)->eta()));
133  et.emplace_back(DataType((*itr)->et()/GeV));
134  numCells.emplace_back(DataType( "0" ));
135  cells.emplace_back(DataType( "0" ));
136  idVec.emplace_back(DataType( ++id ));
137 
138  ATH_MSG_VERBOSE( dataTypeName() << " cluster #" << id
139  << " ,e=" << (*itr)->e()/GeV << ", et="
140  << (*itr)->et()/GeV << ", eta=" << (*itr)->eta()
141  << ", phi=" << (*itr)->phi());
142  }
143  // Start with mandatory entries
144  DataMap["phi"] = phi;
145  DataMap["eta"] = eta;
146  DataMap["et"] = et;
147  DataMap[tagCells] = cells;
148  DataMap["numCells"] = numCells;
149  DataMap["id"] = idVec;
150  DataMap["emfrac"] = emfracVec; // not in Atlantis yet ! Could be used in legoplot
151  DataMap["label"] = labelVec; // not in Atlantis yet !
152 
153  ATH_MSG_DEBUG(dataTypeName() << " (AOD, no cells), collection: " << dataTypeName()
154  << " retrieved with " << phi.size() << " entries");
155  return DataMap;
156  }

◆ getKeys()

const std::vector< std::string > JiveXML::xAODCaloClusterRetriever::getKeys ( )

Gets the StoreGate keys for the desired containers.

Definition at line 159 of file xAODCaloClusterRetriever.cxx.

159  {
160 
161  ATH_MSG_DEBUG("in getKeys()");
162 
163  std::vector<std::string> keys = {};
164 
165  // Remove m_priorityKey from m_otherKeys if it exists, we don't want to write it twice
166  auto it = std::find(m_otherKeys.begin(), m_otherKeys.end(), m_priorityKey);
167  if(it != m_otherKeys.end()){
168  m_otherKeys.erase(it);
169  }
170 
171  // Add m_priorityKey as the first element if it is not ""
172  if(m_priorityKey!=""){
173  keys.push_back(m_priorityKey);
174  }
175 
176  if(!m_otherKeys.empty()){
177  keys.insert(keys.end(), m_otherKeys.begin(), m_otherKeys.end());
178  }
179 
180  // If all collections are requested, obtain all available keys from StoreGate
181  std::vector<std::string> allKeys;
183  evtStore()->keys<xAOD::CaloClusterContainer>(allKeys);
184  // Add keys that are not the priority key and do not add containers with "HLT" in their name if requested
185  for(const std::string& key : allKeys){
186  // Don't include key if it's already in keys
187  auto it2 = std::find(keys.begin(), keys.end(), key);
188  if(it2 != keys.end())continue;
189  if(key.find("HLT") == std::string::npos || m_doWriteHLT){
190  keys.emplace_back(key);
191  }
192  }
193  }
194  return keys;
195  }

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

◆ interfaceID()

const InterfaceID & JiveXML::IDataRetriever::interfaceID ( )
inlinestaticinherited

Return the interface identifier.

Definition at line 40 of file IDataRetriever.h.

40 { return IID_IDataRetriever; }

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

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

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

◆ retrieve()

StatusCode JiveXML::xAODCaloClusterRetriever::retrieve ( ToolHandle< IFormatTool > &  FormatTool)
virtual

For each cluster collection retrieve basic parameters.

'Favourite' cluster collection first, then 'Other' collections.

Parameters
FormatToolthe tool that will create formated output from the DataMap

Implements JiveXML::IDataRetriever.

Definition at line 28 of file xAODCaloClusterRetriever.cxx.

28  {
29 
30  ATH_MSG_DEBUG("In retrieve()");
31 
32  std::vector<std::string> keys = getKeys();
33 
34  if(keys.empty()){
35  ATH_MSG_WARNING("No StoreGate keys found");
36  return StatusCode::SUCCESS;
37  }
38 
39  // Loop through the keys and retrieve the corresponding data
40  for (const std::string& key : keys) {
42  if (cont.isValid()) {
43  DataMap data = getData(&(*cont));
44  if (FormatTool->AddToEvent(dataTypeName(), key + "_xAOD", &data).isFailure()) {
45  ATH_MSG_WARNING("Failed to retrieve Collection " << key);
46  } else {
47  ATH_MSG_DEBUG(" (" << key << ") retrieved");
48  }
49  } else {
50  ATH_MSG_WARNING("Collection " << key << " not found in SG");
51  }
52  }
53  return StatusCode::SUCCESS;
54  }

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

Gaudi::Property<bool> JiveXML::xAODCaloClusterRetriever::m_doWriteAllCollections {this, "DoWriteAllCollections", false, "Write out all CaloCluster collections"}
private

Definition at line 59 of file xAODCaloClusterRetriever.h.

◆ m_doWriteHLT

Gaudi::Property<bool> JiveXML::xAODCaloClusterRetriever::m_doWriteHLT {this, "DoWriteHLT", false, "Write out other collections that have HLT in the name"}
private

Definition at line 58 of file xAODCaloClusterRetriever.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_otherKeys

Gaudi::Property<std::vector<std::string> > JiveXML::xAODCaloClusterRetriever::m_otherKeys {this, "OtherClusterCollections", {}, "Other collections to be retrieved. If DoWriteAllCollections is set to true all available CaloCluster collections will be retrieved"}
private

Definition at line 60 of file xAODCaloClusterRetriever.h.

◆ m_priorityKey

Gaudi::Property<std::string> JiveXML::xAODCaloClusterRetriever::m_priorityKey {this,"PriorityClusterCollection","egammaClusters", "Name of the priority CaloCluster container that will be written out first"}
private

Definition at line 61 of file xAODCaloClusterRetriever.h.

◆ m_typeName

const std::string JiveXML::xAODCaloClusterRetriever::m_typeName = "Cluster"
private

The data type that is generated by this retriever.

Definition at line 56 of file xAODCaloClusterRetriever.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:
RunTileCalibRec.cells
cells
Definition: RunTileCalibRec.py:271
GetLCDefs::Unknown
@ Unknown
Definition: GetLCDefs.h:21
JiveXML::xAODCaloClusterRetriever::m_doWriteAllCollections
Gaudi::Property< bool > m_doWriteAllCollections
Definition: xAODCaloClusterRetriever.h:59
data
char data[hepevt_bytes_allocation_ATLAS]
Definition: HepEvt.cxx:11
et
Extra patterns decribing particle interation process.
GeV
#define GeV
Definition: PhysicsAnalysis/TauID/TauAnalysisTools/Root/HelperFunctions.cxx:17
DataModel_detail::const_iterator
Const iterator class for DataVector/DataList.
Definition: DVLIterator.h:82
python.SystemOfUnits.s
int s
Definition: SystemOfUnits.py:131
constants.EMB1
int EMB1
Definition: Calorimeter/CaloClusterCorrection/python/constants.py:53
phi
Scalar phi() const
phi method
Definition: AmgMatrixBasePlugin.h:67
find
std::string find(const std::string &s)
return a remapped string
Definition: hcg.cxx:135
xAOD::et
et
Definition: TrigEMCluster_v1.cxx:25
eta
Scalar eta() const
pseudorapidity method
Definition: AmgMatrixBasePlugin.h:83
SG::ReadHandle
Definition: StoreGate/StoreGate/ReadHandle.h:67
AthCommonDataStore::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
Definition: AthCommonDataStore.h:145
JiveXML::DataVect
std::vector< DataType > DataVect
Defines a map with a key and a vector of DataType objects e.g.
Definition: DataType.h:58
DataType
OFFLINE_FRAGMENTS_NAMESPACE::PointerType DataType
Definition: RoIBResultByteStreamTool.cxx:25
JiveXML::xAODCaloClusterRetriever::getKeys
const std::vector< std::string > getKeys()
Gets the StoreGate keys for the desired containers.
Definition: xAODCaloClusterRetriever.cxx:159
skel.it
it
Definition: skel.GENtoEVGEN.py:407
JiveXML::xAODCaloClusterRetriever::m_doWriteHLT
Gaudi::Property< bool > m_doWriteHLT
Definition: xAODCaloClusterRetriever.h:58
CaloCell_ID_FCS::FCAL1
@ FCAL1
Definition: FastCaloSim_CaloCell_ID.h:41
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
ATH_MSG_VERBOSE
#define ATH_MSG_VERBOSE(x)
Definition: AthMsgStreamMacros.h:28
JiveXML::DataMap
std::map< std::string, DataVect > DataMap
Definition: DataType.h:59
python.CaloAddPedShiftConfig.type
type
Definition: CaloAddPedShiftConfig.py:42
SG::VarHandleKeyArray::setOwner
virtual void setOwner(IDataHandleHolder *o)=0
IDTPMcnv.htype
htype
Definition: IDTPMcnv.py:29
JiveXML::xAODCaloClusterRetriever::dataTypeName
virtual std::string dataTypeName() const
Return the name of the data type that is generated by this retriever.
Definition: xAODCaloClusterRetriever.h:51
AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore
ServiceHandle< StoreGateSvc > & evtStore()
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
Definition: AthCommonDataStore.h:85
python.utils.AtlRunQueryDQUtils.p
p
Definition: AtlRunQueryDQUtils.py:210
JiveXML::xAODCaloClusterRetriever::getData
const DataMap getData(const xAOD::CaloClusterContainer *)
Puts the variables into a DataMap.
Definition: xAODCaloClusterRetriever.cxx:63
AthCommonDataStore
Definition: AthCommonDataStore.h:52
Amg::toString
std::string toString(const Translation3D &translation, int precision=4)
GeoPrimitvesToStringConverter.
Definition: GeoPrimitivesToStringConverter.h:40
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
constants.EMB2
int EMB2
Definition: Calorimeter/CaloClusterCorrection/python/constants.py:54
CaloSampling::CaloSample
CaloSample
Definition: Calorimeter/CaloGeoHelpers/CaloGeoHelpers/CaloSampling.h:22
ATH_MSG_DEBUG
#define ATH_MSG_DEBUG(x)
Definition: AthMsgStreamMacros.h:29
add-xsec-uncert-quadrature-N.label
label
Definition: add-xsec-uncert-quadrature-N.py:104
test_pyathena.parent
parent
Definition: test_pyathena.py:15
constants.EME1
int EME1
Definition: Calorimeter/CaloClusterCorrection/python/constants.py:55
JiveXML::xAODCaloClusterRetriever::m_otherKeys
Gaudi::Property< std::vector< std::string > > m_otherKeys
Definition: xAODCaloClusterRetriever.h:60
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
Definition: AthCommonDataStore.h:393
DataVector
Derived DataVector<T>.
Definition: DataVector.h:794
AthAlgTool::AthAlgTool
AthAlgTool()
Default constructor:
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
CaloCell_ID_FCS::EME3
@ EME3
Definition: FastCaloSim_CaloCell_ID.h:26
DataVector::end
const_iterator end() const noexcept
Return a const_iterator pointing past the end of the collection.
a
TList * a
Definition: liststreamerinfos.cxx:10
xAOD::TauJetParameters::numCells
@ numCells
Definition: TauDefs.h:171
h
ATH_MSG_WARNING
#define ATH_MSG_WARNING(x)
Definition: AthMsgStreamMacros.h:32
SG::VarHandleBase::vhKey
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
Definition: StoreGate/src/VarHandleBase.cxx:629
python.Bindings.keys
keys
Definition: Control/AthenaPython/python/Bindings.py:798
JiveXML::xAODCaloClusterRetriever::m_priorityKey
Gaudi::Property< std::string > m_priorityKey
Definition: xAODCaloClusterRetriever.h:61
CaloCell_ID_FCS::EMB3
@ EMB3
Definition: FastCaloSim_CaloCell_ID.h:22
DataVector::size
size_type size() const noexcept
Returns the number of elements in the collection.
JiveXML::xAODCaloClusterRetriever::m_typeName
const std::string m_typeName
The data type that is generated by this retriever.
Definition: xAODCaloClusterRetriever.h:56
AthCommonDataStore::declareGaudiProperty
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition: AthCommonDataStore.h:156
constants.EME2
int EME2
Definition: Calorimeter/CaloClusterCorrection/python/constants.py:56
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
mapkey::key
key
Definition: TElectronEfficiencyCorrectionTool.cxx:37