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

#include <ZdcMCTruthAlg.h>

Inheritance diagram for ZdcMCTruthAlg:
Collaboration diagram for ZdcMCTruthAlg:

Public Member Functions

 ZdcMCTruthAlg (const std::string &name, ISvcLocator *pSvcLocator)
 
virtual ~ZdcMCTruthAlg ()
 
StatusCode initialize ()
 
StatusCode execute ()
 
StatusCode finalize ()
 
virtual StatusCode sysInitialize () override
 Override sysInitialize. More...
 
virtual const DataObjIDColl & extraOutputDeps () const override
 Return the list of extra output dependencies. 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 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

const ZdcIDm_zdcID
 
Gaudi::Property< std::string > m_auxSuffix {this, "AuxSuffix", "", "ZdcModuleAuxContainer decoration suffix"}
 
SG::ReadHandleKey< CaloCalibrationHitContainerm_CaloCalibrationHitContainerKey {this, "ZDC_CaloCalibrationHitContainerName", "ZDC_CalibrationHits"}
 
std::string m_zdcModuleContainerName
 
std::string m_zdcSumContainerName
 
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainerm_zdcModuleTruthTotalEnergy {this, "ZdcModuleTruthTotalEnergy" , "", "ZDC module Total Truth Energy"}
 
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainerm_zdcModuleTruthInvisEnergy {this, "ZdcModuleTruthInvisibleEnergy", "", "ZDC module Invisible Truth Energy"}
 
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainerm_zdcModuleTruthEMEnergy {this, "ZdcModuleTruthEMEnergy" , "", "ZDC module EM Truth Energy"}
 
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainerm_zdcModuleTruthNonEMEnergy {this, "ZdcModuleTruthNonEMEnergy" , "", "ZDC module Non EM Truth Energy"}
 
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainerm_zdcModuleTruthEscEnergy {this, "ZdcModuleTruthEscapedEnergy" , "", "ZDC module Escaped Truth Energy"}
 
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainerm_rpdTileXpositionRelative {this, "xposRel" , "", "RPD module tile x position relative to the center of the module"}
 
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainerm_rpdTileYpositionRelative {this, "yposRel" , "", "RPD module tile y position relative to the center of the module"}
 
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainerm_rpdTileRowNumber {this, "row" , "", "RPD channel row number"}
 
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainerm_rpdTileColumnNumber {this, "col" , "", "RPD channel column number"}
 
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainerm_zdcSumTruthTotalEnergy {this, "ZdcSumTruthTotalEnergy" , "", "ZDC Sum Total Truth Energy"}
 
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainerm_zdcSumTruthInvisEnergy {this, "ZdcSumTruthInvisibleEnergy" , "", "ZDC Sum Invisible Truth Energy"}
 
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainerm_zdcSumTruthEMEnergy {this, "ZdcSumTruthEMEnergy" , "", "ZDC Sum EM Truth Energy"}
 
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainerm_zdcSumTruthNonEMEnergy {this, "ZdcSumTruthNonEMEnergy" , "", "ZDC Sum Non EM Truth Energy"}
 
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainerm_zdcSumTruthEscEnergy {this, "ZdcSumTruthEscapedEnergy" , "", "ZDC Sum Escaped Truth Energy"}
 
DataObjIDColl m_extendedExtraObjects
 
StoreGateSvc_t m_evtStore
 Pointer to StoreGate (event store by default) More...
 
StoreGateSvc_t m_detStore
 Pointer to StoreGate (detector store by default) More...
 
std::vector< SG::VarHandleKeyArray * > m_vhka
 
bool m_varHandleArraysDeclared
 

Detailed Description

Definition at line 19 of file ZdcMCTruthAlg.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ ZdcMCTruthAlg()

ZdcMCTruthAlg::ZdcMCTruthAlg ( const std::string &  name,
ISvcLocator *  pSvcLocator 
)

Definition at line 11 of file ZdcMCTruthAlg.cxx.

12  : AthAlgorithm(name, pSvcLocator),
13  m_zdcID(nullptr)
14 {
15 
16 }

◆ ~ZdcMCTruthAlg()

ZdcMCTruthAlg::~ZdcMCTruthAlg ( )
virtual

Definition at line 19 of file ZdcMCTruthAlg.cxx.

20 {;}

Member Function Documentation

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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()

StatusCode ZdcMCTruthAlg::execute ( )

Definition at line 79 of file ZdcMCTruthAlg.cxx.

80 {
81 
82  /******************************************
83  * Get the CaloCalibrationHitContainer (input)
84  ******************************************/
86  if (!calibHitContainer.isValid()) {
87  ATH_MSG_ERROR("Could not get Calibration hit container " << calibHitContainer.name() << " from store " << calibHitContainer.store());
88  return StatusCode::FAILURE;
89  }
90 
91  ATH_MSG_DEBUG ("--> ZDC: ZdcMCTruthAlg execute starting on "
92  << getContext().evt()
93  << "th event");
94 
95  /******************************************
96  * Get the ZdcModuleContainer and
97  * ZdcModuleSumContainer (output)
98  ******************************************/
99  xAOD::ZdcModuleContainer const* moduleContainer = nullptr;
100  ATH_CHECK(evtStore()->retrieve(moduleContainer, m_zdcModuleContainerName));
101 
102  xAOD::ZdcModuleContainer const* moduleSumContainer = nullptr;
103  ATH_CHECK(evtStore()->retrieve(moduleSumContainer, m_zdcSumContainerName));
104 
105  //Create local variables to hold the per module and per side sums
106  float totalMod[2][7]={{0.0},{0.0}}, invisMod[2][7]={{0.0},{0.0}}, emMod[2][7]={{0.0},{0.0}}, nonEMMod[2][7]={{0.0},{0.0}}, escMod[2][7]={{0.0},{0.0}};
107  float totalSide[2]={0.0}, invisSide[2]={0.0}, emSide[2]={0.0}, nonEMSide[2]={0.0}, escSide[2]={0.0};
108  bool foundMod[2][7] = {{false},{false}};
109 
110  /******************************************
111  * Sum all hits in each module
112  ******************************************/
113  for (const auto hit : *calibHitContainer){
114  Identifier id = hit->cellID();
115  int side = (m_zdcID->side(id) > 0) ? 1 : 0;
116  int mod = m_zdcID->module(id);
117 
118  emMod[side][mod] += hit->energyEM();
119  nonEMMod[side][mod] += hit->energyNonEM();
120  invisMod[side][mod] += hit->energyInvisible();
121  totalMod[side][mod] += hit->energyTotal();
122  escMod[side][mod] += hit->energyEscaped();
123  }
124 
125  /******************************************
126  * Decorate the ZdcModuleContainer with the
127  * per module sums and add the per module
128  * sums to the per side sums
129  ******************************************/
139  for (const auto zdcModule : *moduleContainer){
140  if(zdcModule->zdcSide() == 0) continue;
141  int side = (zdcModule->zdcSide() > 0) ? 1 : 0;
142  int mod = zdcModule->zdcModule();
143  foundMod[side][mod] = true;
144 
145  //Add row/column info for RPD processing
146  if(mod == 4){
147  int lucrodId = (side == 0) ? 4 : 2;
148  int rpdChannel = zdcModule->zdcChannel();
149  int lucrodChannel = rpdChannel%8;
150  if(rpdChannel > 7)
151  lucrodId ++;
152 
153  ATH_MSG_DEBUG("Accessing LUCROD ID " << lucrodId <<
154  ", lucrodChannel=" << lucrodChannel <<
155  " for RPD side " << zdcModule->zdcSide() <<
156  ", channel " << rpdChannel);
157 
158  float xpos = ZdcLucrodMapRun3::getInstance()->getLucrod(lucrodId)["x"][lucrodChannel];
159  float ypos = ZdcLucrodMapRun3::getInstance()->getLucrod(lucrodId)["y"][lucrodChannel];
160  unsigned int row = ZdcLucrodMapRun3::getInstance()->getLucrod(lucrodId)["row"][lucrodChannel];
161  unsigned int col = ZdcLucrodMapRun3::getInstance()->getLucrod(lucrodId)["col"][lucrodChannel];
162  rpdTileXpositionRelative(*zdcModule) = xpos;
163  rpdTileYpositionRelative(*zdcModule) = ypos;
164  rpdTileRowNumber (*zdcModule) = row;
165  rpdTileColumnNumber (*zdcModule) = col;
166  }
167 
168  //Only save RPD truth in channel 0
169  if(mod == 4 && zdcModule->zdcChannel() != 0) continue;
170 
171  zdcModuleTruthTotalEnergy(*zdcModule) = totalMod[side][mod];
172  zdcModuleTruthInvisEnergy(*zdcModule) = invisMod[side][mod];
173  zdcModuleTruthEMEnergy (*zdcModule) = emMod [side][mod];
174  zdcModuleTruthNonEMEnergy(*zdcModule) = nonEMMod[side][mod];
175  zdcModuleTruthEscEnergy (*zdcModule) = escMod [side][mod];
176 
177  totalSide[side] += totalMod[side][mod];
178  invisSide[side] += invisMod[side][mod];
179  emSide[side] += emMod [side][mod];
180  nonEMSide[side] += nonEMMod[side][mod];
181  escSide[side] += escMod [side][mod];
182  }
183 
184  for(int iside : {0,1}){
185  for(int mod = 0; mod < 7; ++mod){
186  ATH_MSG_DEBUG("ZDC " << iside << ":" << mod << " total energy = " << totalMod[iside][mod]);
187  if(!foundMod[iside][mod]){
188  ATH_MSG_DEBUG("Failed to find " << iside << ":" << mod);
189  }
190  }
191  }
192 
193  ATH_MSG_DEBUG("ZDC A total energy = " << totalSide[1] <<
194  ", invisible energy = " << invisSide[1] <<
195  ", EM energy = " << emSide[1] <<
196  ", non EM energy = " << nonEMSide[1] <<
197  ", escaped energy = " << escSide[1]);
198 
199  ATH_MSG_DEBUG("ZDC C total energy = " << totalSide[0] <<
200  ", invisible energy = " << invisSide[0] <<
201  ", EM energy = " << emSide[0] <<
202  ", non EM energy = " << nonEMSide[0] <<
203  ", escaped energy = " << escSide[0]);
204 
205 
206  /******************************************
207  * Decorate the Sums container with the
208  * per side sums
209  ******************************************/
215  for (const auto zdcSum : *moduleSumContainer){
216  if (zdcSum->zdcSide() == 0) continue;
217  int side = (zdcSum->zdcSide()==-1) ? 0 : 1;
218  ATH_MSG_DEBUG("Filling zdcSum container side " << side);
219 
220  zdcSumTruthTotalEnergy(*zdcSum) = totalSide[side];
221  zdcSumTruthInvisEnergy(*zdcSum) = invisSide[side];
222  zdcSumTruthEMEnergy (*zdcSum) = emSide [side];
223  zdcSumTruthNonEMEnergy(*zdcSum) = nonEMSide[side];
224  zdcSumTruthEscEnergy (*zdcSum) = escSide [side];
225  }
226 
227  return StatusCode::SUCCESS;
228 }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::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

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const
overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

51 {
52  // If we didn't find any symlinks to add, just return the collection
53  // from the base class. Otherwise, return the extended collection.
54  if (!m_extendedExtraObjects.empty()) {
56  }
57  return Algorithm::extraOutputDeps();
58 }

◆ finalize()

StatusCode ZdcMCTruthAlg::finalize ( )

Definition at line 231 of file ZdcMCTruthAlg.cxx.

232 {
233  ATH_MSG_DEBUG( "--> ZDC: ZdcMCTruthAlg finalize complete" );
234 
235  return StatusCode::SUCCESS;
236 }

◆ initialize()

StatusCode ZdcMCTruthAlg::initialize ( )

Definition at line 24 of file ZdcMCTruthAlg.cxx.

25 {
26  ATH_MSG_INFO("Initializing " << name());
27 
28  if (detStore()->retrieve( m_zdcID ).isFailure() ) {
29  ATH_MSG_ERROR("execute: Could not retrieve ZdcID object from the detector store");
30  return StatusCode::FAILURE;
31  }else{
32  ATH_MSG_DEBUG("execute: retrieved ZdcID");
33  }
34 
35  //Initialize input hit container read handles
37 
38  //Initialize output ZdcModuleContainer read handles
39  m_zdcModuleContainerName = "ZdcModules";
40  m_zdcSumContainerName = "ZdcSums";
41 
42  //Per module AuxDecor handles
48  ATH_CHECK( m_zdcModuleTruthEMEnergy.initialize());
52  ATH_CHECK( m_zdcModuleTruthEscEnergy.initialize());
53 
54  //RPD decorations required for processing
60  ATH_CHECK( m_rpdTileRowNumber.initialize());
62  ATH_CHECK( m_rpdTileColumnNumber.initialize());
63 
64  //Sums container auxDecor handles
66  ATH_CHECK( m_zdcSumTruthTotalEnergy.initialize());
68  ATH_CHECK( m_zdcSumTruthInvisEnergy.initialize());
70  ATH_CHECK( m_zdcSumTruthEMEnergy.initialize());
72  ATH_CHECK( m_zdcSumTruthNonEMEnergy.initialize());
73  m_zdcSumTruthEscEnergy = m_zdcSumContainerName + ".TruthEscapedEnergy" + m_auxSuffix;
74  ATH_CHECK( m_zdcSumTruthEscEnergy.initialize());
75 
76  return StatusCode::SUCCESS;
77 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm >::msg ( ) const
inlineinherited

Definition at line 24 of file AthCommonMsg.h.

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

◆ msg() [2/2]

MsgStream& AthCommonMsg< Algorithm >::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< Algorithm >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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()

StatusCode AthAlgorithm::sysInitialize ( )
overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, PyAthena::Alg, and AthHistogramAlgorithm.

Definition at line 66 of file AthAlgorithm.cxx.

66  {
68 
69  if (sc.isFailure()) {
70  return sc;
71  }
72  ServiceHandle<ICondSvc> cs("CondSvc",name());
73  for (auto h : outputHandles()) {
74  if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
75  // do this inside the loop so we don't create the CondSvc until needed
76  if ( cs.retrieve().isFailure() ) {
77  ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
78  return StatusCode::SUCCESS;
79  }
80  if (cs->regHandle(this,*h).isFailure()) {
81  sc = StatusCode::FAILURE;
82  ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
83  << " with CondSvc");
84  }
85  }
86  }
87  return sc;
88 }

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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_auxSuffix

Gaudi::Property<std::string> ZdcMCTruthAlg::m_auxSuffix {this, "AuxSuffix", "", "ZdcModuleAuxContainer decoration suffix"}
private

Definition at line 38 of file ZdcMCTruthAlg.h.

◆ m_CaloCalibrationHitContainerKey

SG::ReadHandleKey<CaloCalibrationHitContainer> ZdcMCTruthAlg::m_CaloCalibrationHitContainerKey {this, "ZDC_CaloCalibrationHitContainerName", "ZDC_CalibrationHits"}
private

Definition at line 40 of file ZdcMCTruthAlg.h.

◆ m_detStore

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

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

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

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects
privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_rpdTileColumnNumber

SG::WriteDecorHandleKey<xAOD::ZdcModuleContainer> ZdcMCTruthAlg::m_rpdTileColumnNumber {this, "col" , "", "RPD channel column number"}
private

Definition at line 52 of file ZdcMCTruthAlg.h.

◆ m_rpdTileRowNumber

SG::WriteDecorHandleKey<xAOD::ZdcModuleContainer> ZdcMCTruthAlg::m_rpdTileRowNumber {this, "row" , "", "RPD channel row number"}
private

Definition at line 51 of file ZdcMCTruthAlg.h.

◆ m_rpdTileXpositionRelative

SG::WriteDecorHandleKey<xAOD::ZdcModuleContainer> ZdcMCTruthAlg::m_rpdTileXpositionRelative {this, "xposRel" , "", "RPD module tile x position relative to the center of the module"}
private

Definition at line 49 of file ZdcMCTruthAlg.h.

◆ m_rpdTileYpositionRelative

SG::WriteDecorHandleKey<xAOD::ZdcModuleContainer> ZdcMCTruthAlg::m_rpdTileYpositionRelative {this, "yposRel" , "", "RPD module tile y position relative to the center of the module"}
private

Definition at line 50 of file ZdcMCTruthAlg.h.

◆ m_varHandleArraysDeclared

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

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

Definition at line 398 of file AthCommonDataStore.h.

◆ m_zdcID

const ZdcID* ZdcMCTruthAlg::m_zdcID
private

Definition at line 36 of file ZdcMCTruthAlg.h.

◆ m_zdcModuleContainerName

std::string ZdcMCTruthAlg::m_zdcModuleContainerName
private

Definition at line 41 of file ZdcMCTruthAlg.h.

◆ m_zdcModuleTruthEMEnergy

SG::WriteDecorHandleKey<xAOD::ZdcModuleContainer> ZdcMCTruthAlg::m_zdcModuleTruthEMEnergy {this, "ZdcModuleTruthEMEnergy" , "", "ZDC module EM Truth Energy"}
private

Definition at line 46 of file ZdcMCTruthAlg.h.

◆ m_zdcModuleTruthEscEnergy

SG::WriteDecorHandleKey<xAOD::ZdcModuleContainer> ZdcMCTruthAlg::m_zdcModuleTruthEscEnergy {this, "ZdcModuleTruthEscapedEnergy" , "", "ZDC module Escaped Truth Energy"}
private

Definition at line 48 of file ZdcMCTruthAlg.h.

◆ m_zdcModuleTruthInvisEnergy

SG::WriteDecorHandleKey<xAOD::ZdcModuleContainer> ZdcMCTruthAlg::m_zdcModuleTruthInvisEnergy {this, "ZdcModuleTruthInvisibleEnergy", "", "ZDC module Invisible Truth Energy"}
private

Definition at line 45 of file ZdcMCTruthAlg.h.

◆ m_zdcModuleTruthNonEMEnergy

SG::WriteDecorHandleKey<xAOD::ZdcModuleContainer> ZdcMCTruthAlg::m_zdcModuleTruthNonEMEnergy {this, "ZdcModuleTruthNonEMEnergy" , "", "ZDC module Non EM Truth Energy"}
private

Definition at line 47 of file ZdcMCTruthAlg.h.

◆ m_zdcModuleTruthTotalEnergy

SG::WriteDecorHandleKey<xAOD::ZdcModuleContainer> ZdcMCTruthAlg::m_zdcModuleTruthTotalEnergy {this, "ZdcModuleTruthTotalEnergy" , "", "ZDC module Total Truth Energy"}
private

Definition at line 44 of file ZdcMCTruthAlg.h.

◆ m_zdcSumContainerName

std::string ZdcMCTruthAlg::m_zdcSumContainerName
private

Definition at line 42 of file ZdcMCTruthAlg.h.

◆ m_zdcSumTruthEMEnergy

SG::WriteDecorHandleKey<xAOD::ZdcModuleContainer> ZdcMCTruthAlg::m_zdcSumTruthEMEnergy {this, "ZdcSumTruthEMEnergy" , "", "ZDC Sum EM Truth Energy"}
private

Definition at line 55 of file ZdcMCTruthAlg.h.

◆ m_zdcSumTruthEscEnergy

SG::WriteDecorHandleKey<xAOD::ZdcModuleContainer> ZdcMCTruthAlg::m_zdcSumTruthEscEnergy {this, "ZdcSumTruthEscapedEnergy" , "", "ZDC Sum Escaped Truth Energy"}
private

Definition at line 57 of file ZdcMCTruthAlg.h.

◆ m_zdcSumTruthInvisEnergy

SG::WriteDecorHandleKey<xAOD::ZdcModuleContainer> ZdcMCTruthAlg::m_zdcSumTruthInvisEnergy {this, "ZdcSumTruthInvisibleEnergy" , "", "ZDC Sum Invisible Truth Energy"}
private

Definition at line 54 of file ZdcMCTruthAlg.h.

◆ m_zdcSumTruthNonEMEnergy

SG::WriteDecorHandleKey<xAOD::ZdcModuleContainer> ZdcMCTruthAlg::m_zdcSumTruthNonEMEnergy {this, "ZdcSumTruthNonEMEnergy" , "", "ZDC Sum Non EM Truth Energy"}
private

Definition at line 56 of file ZdcMCTruthAlg.h.

◆ m_zdcSumTruthTotalEnergy

SG::WriteDecorHandleKey<xAOD::ZdcModuleContainer> ZdcMCTruthAlg::m_zdcSumTruthTotalEnergy {this, "ZdcSumTruthTotalEnergy" , "", "ZDC Sum Total Truth Energy"}
private

Definition at line 53 of file ZdcMCTruthAlg.h.


The documentation for this class was generated from the following files:
python.PyKernel.retrieve
def retrieve(aClass, aKey=None)
Definition: PyKernel.py:110
query_example.row
row
Definition: query_example.py:24
ZdcMCTruthAlg::m_zdcModuleTruthEMEnergy
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainer > m_zdcModuleTruthEMEnergy
Definition: ZdcMCTruthAlg.h:46
python.PerfMonSerializer.p
def p
Definition: PerfMonSerializer.py:743
ATH_MSG_INFO
#define ATH_MSG_INFO(x)
Definition: AthMsgStreamMacros.h:31
ZdcMCTruthAlg::m_zdcSumTruthNonEMEnergy
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainer > m_zdcSumTruthNonEMEnergy
Definition: ZdcMCTruthAlg.h:56
ZdcMCTruthAlg::m_rpdTileColumnNumber
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainer > m_rpdTileColumnNumber
Definition: ZdcMCTruthAlg.h:52
SG::ReadHandle
Definition: StoreGate/StoreGate/ReadHandle.h:70
AthCommonDataStore::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
Definition: AthCommonDataStore.h:145
ZdcID::module
int module(const Identifier &id) const
Definition: ZdcID.h:163
ZdcMCTruthAlg::m_zdcModuleTruthTotalEnergy
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainer > m_zdcModuleTruthTotalEnergy
Definition: ZdcMCTruthAlg.h:44
ZdcMCTruthAlg::m_zdcSumTruthInvisEnergy
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainer > m_zdcSumTruthInvisEnergy
Definition: ZdcMCTruthAlg.h:54
AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
Definition: AthCommonDataStore.h:390
AthCommonDataStore< AthCommonMsg< Algorithm > >::m_vhka
std::vector< SG::VarHandleKeyArray * > m_vhka
Definition: AthCommonDataStore.h:398
LArG4FSStartPointFilter.evt
evt
Definition: LArG4FSStartPointFilter.py:42
read_hist_ntuple.t
t
Definition: read_hist_ntuple.py:5
ZdcMCTruthAlg::m_zdcModuleContainerName
std::string m_zdcModuleContainerName
Definition: ZdcMCTruthAlg.h:41
ZdcMCTruthAlg::m_zdcSumTruthEMEnergy
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainer > m_zdcSumTruthEMEnergy
Definition: ZdcMCTruthAlg.h:55
ZdcLucrodMapRun3::getLucrod
const nlohmann::json & getLucrod(int i) const
Definition: ZdcLucrodMapRun3.h:23
ZdcMCTruthAlg::m_zdcSumTruthTotalEnergy
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainer > m_zdcSumTruthTotalEnergy
Definition: ZdcMCTruthAlg.h:53
AthenaPoolTestRead.sc
sc
Definition: AthenaPoolTestRead.py:27
AthCommonDataStore< AthCommonMsg< Algorithm > >::detStore
const ServiceHandle< StoreGateSvc > & detStore() const
The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
Definition: AthCommonDataStore.h:95
SG::VarHandleKeyArray::setOwner
virtual void setOwner(IDataHandleHolder *o)=0
TRT::Hit::side
@ side
Definition: HitInfo.h:83
AthCommonDataStore< AthCommonMsg< Algorithm > >::evtStore
ServiceHandle< StoreGateSvc > & evtStore()
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
Definition: AthCommonDataStore.h:85
ZdcMCTruthAlg::m_auxSuffix
Gaudi::Property< std::string > m_auxSuffix
Definition: ZdcMCTruthAlg.h:38
ZdcMCTruthAlg::m_zdcSumTruthEscEnergy
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainer > m_zdcSumTruthEscEnergy
Definition: ZdcMCTruthAlg.h:57
AthCommonDataStore
Definition: AthCommonDataStore.h:52
AthAlgorithm::sysInitialize
virtual StatusCode sysInitialize() override
Override sysInitialize.
Definition: AthAlgorithm.cxx:66
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
maskDeadModules.mod
mod
Definition: maskDeadModules.py:36
AthCommonDataStore< AthCommonMsg< Algorithm > >::outputHandles
virtual std::vector< Gaudi::DataHandle * > outputHandles() const override
Return this algorithm's output handles.
Identifier
Definition: DetectorDescription/Identifier/Identifier/Identifier.h:32
EL::StatusCode
::StatusCode StatusCode
StatusCode definition for legacy code.
Definition: PhysicsAnalysis/D3PDTools/EventLoop/EventLoop/StatusCode.h:22
ATH_MSG_DEBUG
#define ATH_MSG_DEBUG(x)
Definition: AthMsgStreamMacros.h:29
SG::WriteDecorHandle
Handle class for adding a decoration to an object.
Definition: StoreGate/StoreGate/WriteDecorHandle.h:99
ZdcMCTruthAlg::m_rpdTileRowNumber
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainer > m_rpdTileRowNumber
Definition: ZdcMCTruthAlg.h:51
ATH_CHECK
#define ATH_CHECK
Definition: AthCheckMacros.h:40
AthCommonDataStore< AthCommonMsg< Algorithm > >::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
DataVector
Derived DataVector<T>.
Definition: DataVector.h:581
ZdcMCTruthAlg::m_zdcModuleTruthInvisEnergy
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainer > m_zdcModuleTruthInvisEnergy
Definition: ZdcMCTruthAlg.h:45
ZdcMCTruthAlg::m_zdcModuleTruthEscEnergy
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainer > m_zdcModuleTruthEscEnergy
Definition: ZdcMCTruthAlg.h:48
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:195
query_example.col
col
Definition: query_example.py:7
AthAlgorithm::m_extendedExtraObjects
DataObjIDColl m_extendedExtraObjects
Definition: AthAlgorithm.h:79
a
TList * a
Definition: liststreamerinfos.cxx:10
h
ATH_MSG_WARNING
#define ATH_MSG_WARNING(x)
Definition: AthMsgStreamMacros.h:32
ZdcID::side
int side(const Identifier &id) const
Values of different levels (failure returns 0)
Definition: ZdcID.h:157
SG::VarHandleBase::vhKey
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
Definition: StoreGate/src/VarHandleBase.cxx:616
declareProperty
#define declareProperty(n, p, h)
Definition: BaseFakeBkgTool.cxx:15
ZdcMCTruthAlg::m_zdcModuleTruthNonEMEnergy
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainer > m_zdcModuleTruthNonEMEnergy
Definition: ZdcMCTruthAlg.h:47
AthAlgorithm::AthAlgorithm
AthAlgorithm()
Default constructor:
python.Bindings.keys
keys
Definition: Control/AthenaPython/python/Bindings.py:790
ZdcMCTruthAlg::m_CaloCalibrationHitContainerKey
SG::ReadHandleKey< CaloCalibrationHitContainer > m_CaloCalibrationHitContainerKey
Definition: ZdcMCTruthAlg.h:40
ZdcMCTruthAlg::m_zdcID
const ZdcID * m_zdcID
Definition: ZdcMCTruthAlg.h:36
LHEF::Writer
Pythia8::Writer Writer
Definition: Prophecy4fMerger.cxx:12
ZdcMCTruthAlg::m_rpdTileYpositionRelative
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainer > m_rpdTileYpositionRelative
Definition: ZdcMCTruthAlg.h:50
ZdcMCTruthAlg::m_rpdTileXpositionRelative
SG::WriteDecorHandleKey< xAOD::ZdcModuleContainer > m_rpdTileXpositionRelative
Definition: ZdcMCTruthAlg.h:49
AthCommonDataStore::declareGaudiProperty
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition: AthCommonDataStore.h:156
ZdcMCTruthAlg::m_zdcSumContainerName
std::string m_zdcSumContainerName
Definition: ZdcMCTruthAlg.h:42
fitman.k
k
Definition: fitman.py:528
ServiceHandle< ICondSvc >
ZdcLucrodMapRun3::getInstance
static const ZdcLucrodMapRun3 * getInstance()
Definition: ZdcLucrodMapRun3.cxx:10