ATLAS Offline Software
Loading...
Searching...
No Matches
ZdcRecChannelToolLucrod Class Reference

#include <ZdcRecChannelToolLucrod.h>

Inheritance diagram for ZdcRecChannelToolLucrod:
Collaboration diagram for ZdcRecChannelToolLucrod:

Public Member Functions

 ZdcRecChannelToolLucrod (const std::string &name)
virtual ~ZdcRecChannelToolLucrod ()
virtual StatusCode initialize () override
 Dummy implementation of the initialisation function.
virtual StatusCode finalize () override
virtual void handle (const Incident &) override
int convertLucrod2ZM (const ZdcLucrodDataContainer *lucrodContainer, xAOD::ZdcModuleContainer *zdcModules, xAOD::ZdcModuleContainer *zdcSums) const
virtual void print () const
 Print the state of the tool.
ServiceHandle< StoreGateSvc > & evtStore ()
 The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > & detStore () const
 The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode sysInitialize () override
 Perform system initialization for an algorithm.
virtual StatusCode sysStart () override
 Handle START transition.
virtual std::vector< Gaudi::DataHandle * > inputHandles () const override
 Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * > outputHandles () const override
 Return this algorithm's output handles.
Gaudi::Details::PropertyBase & declareProperty (Gaudi::Property< T, V, H > &t)
void updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream & msg () const
bool msgLvl (const MSG::Level lvl) const
Additional helper functions, not directly mimicking Athena
template<class T>
const T * getProperty (const std::string &name) const
 Get one of the tool's properties.
const std::string & msg_level_name () const __attribute__((deprecated))
 A deprecated function for getting the message level's name.
const std::string & getName (const void *ptr) const
 Get the name of an object that is / should be in the event store.
SG::sgkey_t getKey (const void *ptr) const
 Get the (hashed) key of an object that is in the event store.

Protected Member Functions

void renounceArray (SG::VarHandleKeyArray &handlesArray)
 remove all handles from I/O resolution
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.

Private Types

typedef ServiceHandle< StoreGateSvcStoreGateSvc_t

Private Member Functions

Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
 specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes

const ZdcIDm_zdcId {}
StoreGateSvc_t m_evtStore
 Pointer to StoreGate (event store by default)
StoreGateSvc_t m_detStore
 Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * > m_vhka
bool m_varHandleArraysDeclared

Detailed Description

Definition at line 30 of file ZdcRecChannelToolLucrod.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

◆ ZdcRecChannelToolLucrod()

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

Definition at line 25 of file ZdcRecChannelToolLucrod.cxx.

25 :
26 AsgTool(name)
27{
28 //Declare properties here...
29
30 declareInterface<ZdcRecChannelToolLucrod>(this);
31}
AsgTool(const std::string &name)
Constructor specifying the tool instance's name.
Definition AsgTool.cxx:58

◆ ~ZdcRecChannelToolLucrod()

virtual ZdcRecChannelToolLucrod::~ZdcRecChannelToolLucrod ( )
inlinevirtual

Definition at line 36 of file ZdcRecChannelToolLucrod.h.

36{};

Member Function Documentation

◆ convertLucrod2ZM()

int ZdcRecChannelToolLucrod::convertLucrod2ZM ( const ZdcLucrodDataContainer * lucrodContainer,
xAOD::ZdcModuleContainer * zdcModules,
xAOD::ZdcModuleContainer * zdcSums ) const

Definition at line 77 of file ZdcRecChannelToolLucrod.cxx.

78{
79
80 ATH_MSG_DEBUG("Trying to convert LUCROD to Modules!");
81
84
85 typedef std::map<uint32_t,xAOD::ZdcModule*> hashmapType;
86 hashmapType digits_map;
87 Identifier chan_id;
88
89 int Nchan = 0;
90
91 std::vector<uint16_t> rodBCID;
92 std::array<xAOD::ZdcModule*, 2> zdcSideSum_ptrs;
93
94 for (int iside = 0;iside<2;iside++)
95 {
96 xAOD::ZdcModule* new_sum = new xAOD::ZdcModule();
98 zdcSideSum_ptrs[iside] = new_sum;
99 new_sum->setZdcSide((iside==0) ? -1 : 1);
100 }
101
102
103 for (const ZdcLucrodData* zld : *lucrodCollection)
104 {
105 ATH_MSG_DEBUG("Next LUCROD...");
106 uint32_t lucrod_id = zld->GetLucrodID();
107 ATH_MSG_DEBUG("Unpacking LUCROD ID " << lucrod_id << " with BCID=" << zld->GetBCID());
108 rodBCID.push_back(zld->GetBCID());
109
110 const std::vector<uint16_t> zlt = zld->GetTrigData();
111
112 for (size_t i=0;i<zld->GetChanDataSize();i++)
113 {
114 ATH_MSG_DEBUG("Accessing LUCROD ID " << lucrod_id << " chan data " << i);
115 const ZdcLucrodChannel& zlc = zld->GetChanData(i);
116 uint16_t lucrod_channel = zlc.id;
117 ATH_MSG_DEBUG("lucrod_channel=" << lucrod_channel);
118 ATH_MSG_DEBUG("Accessing ZDC map");
119 int side = ZdcLucrodMapRun3::getInstance()->getLucrod(lucrod_id)["side"][lucrod_channel];
120 int module = ZdcLucrodMapRun3::getInstance()->getLucrod(lucrod_id)["module"][lucrod_channel];
121 int type = ZdcLucrodMapRun3::getInstance()->getLucrod(lucrod_id)["type"][lucrod_channel];
122 int channel = ZdcLucrodMapRun3::getInstance()->getLucrod(lucrod_id)["channel"][lucrod_channel];
123 int gain = ZdcLucrodMapRun3::getInstance()->getLucrod(lucrod_id)["gain"][lucrod_channel];
124 float xpos = 0;
125 float ypos = 0;
126 unsigned int row = -1;
127 unsigned int col = -1;
128 if (type == 1) // these variables are only defined for RPD in the json file
129 {
130 xpos = ZdcLucrodMapRun3::getInstance()->getLucrod(lucrod_id)["x"][lucrod_channel];
131 ypos = ZdcLucrodMapRun3::getInstance()->getLucrod(lucrod_id)["y"][lucrod_channel];
132 row = ZdcLucrodMapRun3::getInstance()->getLucrod(lucrod_id)["row"][lucrod_channel];
133 col = ZdcLucrodMapRun3::getInstance()->getLucrod(lucrod_id)["col"][lucrod_channel];
134 }
135
136 ATH_MSG_DEBUG("Done accessing ZDC map side " << side << " module " << module << " type " << type << " channel " << channel << " gain " << gain);
137
138 chan_id = m_zdcId->channel_id(side,module,type,channel);
139 const uint32_t chan_hash = chan_id.get_identifier32().get_compact();
140
141
142 hashmapType::iterator iter = digits_map.find(chan_hash);
143 if (iter == digits_map.end())
144 {
145 ATH_MSG_DEBUG("new channel for " << chan_id);
146 Nchan++;
147 xAOD::ZdcModule* new_mod = new xAOD::ZdcModule();
149 digits_map.insert(std::pair<uint32_t,xAOD::ZdcModule*>(chan_hash,new_mod));
150 iter = digits_map.find(chan_hash);
151 (*iter).second->setZdcId(chan_hash);
152 (*iter).second->setZdcSide(side);
153 (*iter).second->setZdcModule(module);
154 (*iter).second->setZdcType(type);
155 (*iter).second->setZdcChannel(channel);
156
157 // RPDs are labeled as type 1
158 //
159 if (type == 1) {
160 // Save the (nominal) positions of the sector relative to the RPD center
161 //
162 static const SG::Accessor<float_t> xposRelAcc ("xposRel");
163 static const SG::Accessor<float_t> yposRelAcc ("yposRel");
164 static const SG::Accessor<uint16_t> rowAcc ("row");
165 static const SG::Accessor<uint16_t> colAcc ("col");
166 xposRelAcc (*iter->second) = xpos;
167 yposRelAcc (*iter->second) = ypos;
168 rowAcc (*iter->second) = row;
169 colAcc (*iter->second) = col;
170 }
171 }
172
173 if (iter != digits_map.end())
174 {
175
176 ATH_MSG_DEBUG("adding waveform data for " << chan_id << " gain " << gain);
177
178 if (gain==0)
179 {
180 (*iter).second->setWaveform("g0data",zlc.waveform);
181 }
182 if (gain==1)
183 {
184 (*iter).second->setWaveform("g1data",zlc.waveform);
185 }
186
187 if (type == 0) {
188 if (gain ==0) {
189 static const SG::Accessor<uint16_t> LucrodTriggerAmpLGAcc ("LucrodTriggerAmpLG");
190 LucrodTriggerAmpLGAcc (*iter->second) = zlt.at(i);
191 }
192 else {
193 static const SG::Accessor<uint16_t> LucrodTriggerAmpAcc ("LucrodTriggerAmp");
194 LucrodTriggerAmpAcc (*iter->second) = zlt.at(i);
195 }
196 }
197 }
198
199 }
200
201 // Get the trigger information from ZDC lucrods
202 //
203 // Unfortunately, we have to hack a bit to get the information we want
204 //
205 int type = ZdcLucrodMapRun3::getInstance()->getLucrod(lucrod_id)["type"][0];
206 int gain = ZdcLucrodMapRun3::getInstance()->getLucrod(lucrod_id)["gain"][0];
207
208 if (type == 0) {
209 std::string auxName = (gain == 0 ? "LucrodTriggerSideAmpLG" : "LucrodTriggerSideAmp");
210 static const SG::Accessor<uint16_t> auxNameAcc (auxName);
211 auxNameAcc ( *zdcSideSum_ptrs[0]) = zld->GetTrigAvgC();
212 auxNameAcc ( *zdcSideSum_ptrs[1]) = zld->GetTrigAvgA();
213 }
214 }
215
216 xAOD::ZdcModule* global_sum = new xAOD::ZdcModule();
218 global_sum->setZdcSide(0); // special "global" sum
219 static const SG::Accessor<std::vector<uint16_t> > rodBCIDAcc ("rodBCID");
220 rodBCIDAcc (*global_sum) = std::move (rodBCID);
221
222 ATH_MSG_DEBUG("Done trying to convert!!");
223
224 return Nchan;
225
226}
#define ATH_MSG_DEBUG(x)
struct ZdcLucrodChannelType ZdcLucrodChannel
value_type push_back(value_type pElem)
Add an element to the end of the collection.
std::unique_ptr< base_value_type > unique_type
Definition DataVector.h:829
value_type get_compact() const
Get the compact id.
Identifier32 get_identifier32() const
Get the 32-bit version Identifier, will be invalid if >32 bits needed.
SG::Accessor< T, ALLOC > Accessor
Definition AuxElement.h:572
static const ZdcLucrodMapRun3 * getInstance()
const nlohmann::json & getLucrod(int i) const
void setZdcSide(int)
row
Appending html table to final .html summary file.
ZdcModule_v1 ZdcModule
Definition ZdcModule.h:15
setWord1 uint16_t
setEventNumber uint32_t
std::vector< uint16_t > waveform

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl,
const SG::VarHandleKeyType &  )
inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

158 {
160 hndl.value(),
161 hndl.documentation());
162
163 }
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T, V, H > &t)

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t)
inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

145 {
146 typedef typename SG::HandleClassifier<T>::type htype;
148 }
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>

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

◆ evtStore()

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.

◆ 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

◆ finalize()

StatusCode ZdcRecChannelToolLucrod::finalize ( )
overridevirtual

Definition at line 70 of file ZdcRecChannelToolLucrod.cxx.

71{
72 msg(MSG::INFO) << "Finalizing " << name() << endmsg;
73 return StatusCode::SUCCESS;
74}
#define endmsg
MsgStream & msg
Definition testRead.cxx:32

◆ 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 }
ServiceHandle< StoreGateSvc > & evtStore()

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

◆ handle()

void ZdcRecChannelToolLucrod::handle ( const Incident & inc)
overridevirtual

Definition at line 35 of file ZdcRecChannelToolLucrod.cxx.

36{
37 if ( inc.type() == IncidentType::EndEvent) {
38
39 }
40}

◆ initialize()

StatusCode ZdcRecChannelToolLucrod::initialize ( void )
overridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 44 of file ZdcRecChannelToolLucrod.cxx.

45{
46 msg(MSG::INFO) << "Initializing " << name() << endmsg;
47
48 const ZdcID* zdcId = nullptr;
49 if (detStore()->retrieve( zdcId ).isFailure() ) {
50 msg(MSG::ERROR) << "execute: Could not retrieve ZdcID object from the detector store" << endmsg;
51 return StatusCode::FAILURE;
52 }
53 else {
54 msg(MSG::DEBUG) << "execute: retrieved ZdcID" << endmsg;
55 }
56 m_zdcId = zdcId;
57
58 ServiceHandle<IIncidentSvc> incidentSvc("IncidentSvc", name());
59 CHECK(incidentSvc.retrieve());
60 incidentSvc->addListener(this, IncidentType::EndEvent);
61
62 msg(MSG::DEBUG) << "--> ZDC : END OF MODIFICATION 0" << endmsg ;
63 return StatusCode::SUCCESS;
64
65}
#define CHECK(...)
Evaluate an expression and check for errors.
const ServiceHandle< StoreGateSvc > & detStore() const
retrieve(aClass, aKey=None)
Definition PyKernel.py:110

◆ 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()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const
inlineinherited

Definition at line 24 of file AthCommonMsg.h.

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

◆ 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 }
MsgStream & msg() const
const std::string & name(Level lvl)
Convenience function for translating message levels to strings.
Definition MsgLevel.cxx:19

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl) const
inlineinherited

Definition at line 30 of file AthCommonMsg.h.

30 {
31 return this->msgLevel(lvl);
32 }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const
overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ print()

void asg::AsgTool::print ( ) const
virtualinherited

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h)
inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

381 {
382 h.renounce();
384 }
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)

◆ 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 {
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 asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ 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) {
313 for (auto k : keys) {
314 k->setOwner(this);
315 }
316 }
317 }
std::vector< SG::VarHandleKeyArray * > m_vhka

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

◆ m_zdcId

const ZdcID* ZdcRecChannelToolLucrod::m_zdcId {}
private

Definition at line 46 of file ZdcRecChannelToolLucrod.h.

46{};

The documentation for this class was generated from the following files: