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

#include <ITkPixelDecodingAlg.h>

Inheritance diagram for ITkPixelDecodingAlg:
Collaboration diagram for ITkPixelDecodingAlg:

Public Member Functions

 ITkPixelDecodingAlg (const std::string &name, ISvcLocator *pSvcLocator)
virtual StatusCode initialize () override
virtual StatusCode execute (const EventContext &ctx) const override
virtual StatusCode finalize () override
virtual StatusCode sysInitialize () override
 Override sysInitialize.
virtual bool isClonable () const override
 Specify if the algorithm is clonable.
virtual unsigned int cardinality () const override
 Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.
virtual StatusCode sysExecute (const EventContext &ctx) override
 Execute an algorithm.
virtual const DataObjIDColl & extraOutputDeps () const override
 Return the list of extra output dependencies.
virtual bool filterPassed (const EventContext &ctx) const
virtual void setFilterPassed (bool state, const EventContext &ctx) const
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 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

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 std::vector< std::vector< uint32_t > > ITkPacketCollection
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

ServiceHandle< IROBDataProviderSvcm_robDataProviderSvc { this, "ROBDataProvider", "ROBDataProviderSvc" }
SG::ReadCondHandleKey< ITkPixelCablingDatam_pixelCablingKey {this, "PixelCablingKey", "ITkPixelCablingData", "Cond Key of Pixel Cabling"}
SG::WriteHandleKey< PixelRDO_Containerm_pixelRDOKey {this, "pixelRDOKey", "PixelRDOs", "StoreGate Key of Pixel RDOs"}
std::vector< uint32_t > m_sourceIDs
const PixelIDm_idHelper {}
DataObjIDColl m_extendedExtraObjects
 Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
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 26 of file ITkPixelDecodingAlg.h.

Member Typedef Documentation

◆ ITkPacketCollection

typedef std::vector< std::vector<uint32_t > > ITkPixelDecodingAlg::ITkPacketCollection
private

Definition at line 41 of file ITkPixelDecodingAlg.h.

◆ StoreGateSvc_t

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

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ ITkPixelDecodingAlg()

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

Definition at line 19 of file ITkPixelDecodingAlg.cxx.

19 :
20 AthReentrantAlgorithm(name, pSvcLocator)
21{
22
23}

Member Function Documentation

◆ cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::cardinality ( ) const
overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Definition at line 75 of file AthCommonReentrantAlgorithm.cxx.

64{
65 return 0;
66}

◆ declareGaudiProperty()

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

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

◆ execute()

StatusCode ITkPixelDecodingAlg::execute ( const EventContext & ctx) const
overridevirtual

Definition at line 47 of file ITkPixelDecodingAlg.cxx.

48{
49 //Timing
50 SCOPED_TIMER("ITkPixelDecodingAlg::execute", msg());
51
52 //Retrieve the ROB IDs from cabling - dummy as of now, happens in initialize()
53 SG::ReadCondHandle<ITkPixelCablingData> cablingData(m_pixelCablingKey, ctx);
54 const ITkPixelCablingData* cabling = *cablingData;
55
56 //Instantiate the output. RN using the old pixel RDO, nothing fancier than that
57 std::unique_ptr<PixelRDO_Container> rdoCont = std::make_unique<PixelRDO_Container>(m_idHelper->wafer_hash_max());
58
59 //Instantiate the decoder. Doing this once per event is fine and MT-safe
60 //It needs a "callback" that implements methods required by concepts. This is
61 //the drawback of using an external code (by ITk online sw). Each of these methods
62 //is then called at appropriate places in the decoding. The decoder is configured
63 //with data format options. The callback can do whatever with the decoded hits
64 //e. g. print them on the screen or put them in a container as RDOs.
65 DataFormat fmt;
66 fmt.options.en_chip_id = true;
67 fmt.options.en_eos = true;
68 PixelCallbacks::RDOCallback cb(rdoCont.get(), m_idHelper);
69 DecCore<PixelCallbacks::RDOCallback> core(fmt, cb);
70 core.initialize();
71
72 //Invoke ROBDataProviderService, fetch the concerned ROBs.
73 std::vector<const eformat::ROBFragment<const uint32_t*>*> ROBs;
74 m_robDataProviderSvc->getROBData(ctx, m_sourceIDs, ROBs);
75 ATH_MSG_DEBUG("Retrieved " << ROBs.size() << " fragments");
76
77 //We can now loop over the payloads of the ROB fragments retrieved earlier.
78 //There's as of now a little annoyance that the decoder eats 64 bit frames
79 //but the ROBs come in 32 bits. At least they have the same endian polarity.
80 //Nevertheless, we need to rearrange them.
81 std::vector<uint64_t> payload64;
82 std::array<std::vector<uint64_t>, 4> split_streams;
83 for (const auto& ROB : ROBs){
84 const uint32_t* payload = ROB->rod_data();
85 uint32_t length = ROB->rod_ndata();
86
87 //Translate the data into 64 bits. We know the length, so we can reserve
88 //the space to avoid reallocation. Since the frames are always 64 bits split
89 //into 32, they'll always be divisible by 2 without modulo.
90 payload64.clear();
91 payload64.resize(length / 2);
92 for (uint32_t word = 0; word < length; word += 2){
93 payload64[word / 2] = ((uint64_t)(payload[word]) << 32) | payload[word + 1];
94 }
95
96
97 //Need to set the correct offline ID for this ROB
98 ITkPixelCabling::ModuleInfo mi = cabling->offlineModuleInfo(ROB->rob_source_id());
99 cb.setOfflineID(mi.id.get_identifier32().get_compact());
100
101 //Set transform type
102 cb.setTransformType(mi.transform);
103
104 //If this is a merged quad, it has all 4 chips in one ROB
105 //In such case we need to decode them separately. Otherwise
106 //It's a 1:1 correspondence
107
109 cb.setChipID(0);
110 core.decode(payload64);
111 }
112 else {
113 //split according to chip ID, which is always in highest bits 1 and 2
114 for (auto &v : split_streams) v.clear();
115 for (const uint64_t& word64: payload64) split_streams[(word64 >> 61) & 0b11].push_back(word64);
116 for (uint8_t chipID = 0; chipID < 4; chipID++){
117 if (!split_streams[chipID].empty()){
118 cb.setChipID(chipID);
119 core.decode(split_streams[chipID]);
120 }
121 }
122 }
123 }
124
125 //The container is filled by now. We can write it to SG
126 SG::WriteHandle<PixelRDO_Container> pixelRDOContainerHandle(m_pixelRDOKey, ctx);
127 ATH_CHECK(pixelRDOContainerHandle.record(std::move(rdoCont)));
128
129 return StatusCode::SUCCESS;
130}
#define ATH_CHECK
Evaluate an expression and check for errors.
#define ATH_MSG_DEBUG(x)
double length(const pvec &v)
#define SCOPED_TIMER(name, msg)
const char *const fmt
static const Attributes_t empty
ServiceHandle< IROBDataProviderSvc > m_robDataProviderSvc
std::vector< uint32_t > m_sourceIDs
SG::WriteHandleKey< PixelRDO_Container > m_pixelRDOKey
const PixelID * m_idHelper
SG::ReadCondHandleKey< ITkPixelCablingData > m_pixelCablingKey
setEventNumber uint32_t

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::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 & AthCommonReentrantAlgorithm< Gaudi::Algorithm >::extraOutputDeps ( ) const
overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 94 of file AthCommonReentrantAlgorithm.cxx.

90{
91 // If we didn't find any symlinks to add, just return the collection
92 // from the base class. Otherwise, return the extended collection.
93 if (!m_extendedExtraObjects.empty()) {
95 }
97}
An algorithm that can be simultaneously executed in multiple threads.

◆ filterPassed()

virtual bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx) const
inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

96 {
97 return execState( ctx ).filterPassed();
98 }
virtual bool filterPassed(const EventContext &ctx) const

◆ finalize()

StatusCode ITkPixelDecodingAlg::finalize ( )
overridevirtual

Definition at line 132 of file ITkPixelDecodingAlg.cxx.

132 {
133 return StatusCode::SUCCESS;
134}

◆ initialize()

StatusCode ITkPixelDecodingAlg::initialize ( )
overridevirtual

Definition at line 26 of file ITkPixelDecodingAlg.cxx.

27{
29
30 ATH_CHECK(m_pixelCablingKey.initialize());
31
32 ATH_CHECK(detStore()->retrieve(m_idHelper, "PixelID"));
33
34 ATH_CHECK(m_pixelRDOKey.initialize());
35
36 //this should go into the cabling likely...
37 for (size_t hash = 0; hash < m_idHelper->wafer_hash_max(); hash++){
38 m_sourceIDs.push_back(m_idHelper->wafer_id(hash).get_identifier32().get_compact() | 0b00 );
39 m_sourceIDs.push_back(m_idHelper->wafer_id(hash).get_identifier32().get_compact() | 0b10 );
40 m_sourceIDs.push_back(m_idHelper->wafer_id(hash).get_identifier32().get_compact() | 0b01 );
41 m_sourceIDs.push_back(m_idHelper->wafer_id(hash).get_identifier32().get_compact() | 0b11 );
42 }
43
44 return StatusCode::SUCCESS;
45}
const ServiceHandle< StoreGateSvc > & detStore() const
retrieve(aClass, aKey=None)
Definition PyKernel.py:110

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::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.

◆ isClonable()

◆ msg()

MsgStream & AthCommonMsg< Gaudi::Algorithm >::msg ( ) const
inlineinherited

Definition at line 24 of file AthCommonMsg.h.

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

◆ msgLvl()

bool AthCommonMsg< Gaudi::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< Gaudi::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray)
inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

364 {
366 }

◆ setFilterPassed()

virtual void AthCommonReentrantAlgorithm< Gaudi::Algorithm >::setFilterPassed ( bool state,
const EventContext & ctx ) const
inlinevirtualinherited

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

100 {
102 }
virtual void setFilterPassed(bool state, const EventContext &ctx) const

◆ sysExecute()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx)
overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Definition at line 85 of file AthCommonReentrantAlgorithm.cxx.

77{
78 return BaseAlg::sysExecute (ctx);
79}

◆ sysInitialize()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::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< Gaudi::Algorithm > >.

Reimplemented in HypoBase, and InputMakerBase.

Definition at line 61 of file AthCommonReentrantAlgorithm.cxx.

107 {
109
110 if (sc.isFailure()) {
111 return sc;
112 }
113
114 ServiceHandle<ICondSvc> cs("CondSvc",name());
115 for (auto h : outputHandles()) {
116 if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
117 // do this inside the loop so we don't create the CondSvc until needed
118 if ( cs.retrieve().isFailure() ) {
119 ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
120 return StatusCode::SUCCESS;
121 }
122 if (cs->regHandle(this,*h).isFailure()) {
124 ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
125 << " with CondSvc");
126 }
127 }
128 }
129 return sc;
130}
#define ATH_MSG_ERROR(x)
#define ATH_MSG_WARNING(x)
virtual std::vector< Gaudi::DataHandle * > outputHandles() const override

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::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< Gaudi::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) {
313 for (auto k : keys) {
314 k->setOwner(this);
315 }
316 }
317 }

Member Data Documentation

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::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< Gaudi::Algorithm > >::m_evtStore
privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthCommonReentrantAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects
privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 114 of file AthCommonReentrantAlgorithm.h.

◆ m_idHelper

const PixelID* ITkPixelDecodingAlg::m_idHelper {}
private

Definition at line 51 of file ITkPixelDecodingAlg.h.

51{};

◆ m_pixelCablingKey

SG::ReadCondHandleKey<ITkPixelCablingData> ITkPixelDecodingAlg::m_pixelCablingKey {this, "PixelCablingKey", "ITkPixelCablingData", "Cond Key of Pixel Cabling"}
private

Definition at line 45 of file ITkPixelDecodingAlg.h.

45{this, "PixelCablingKey", "ITkPixelCablingData", "Cond Key of Pixel Cabling"};

◆ m_pixelRDOKey

SG::WriteHandleKey<PixelRDO_Container> ITkPixelDecodingAlg::m_pixelRDOKey {this, "pixelRDOKey", "PixelRDOs", "StoreGate Key of Pixel RDOs"}
private

Definition at line 47 of file ITkPixelDecodingAlg.h.

47{this, "pixelRDOKey", "PixelRDOs", "StoreGate Key of Pixel RDOs"};

◆ m_robDataProviderSvc

ServiceHandle<IROBDataProviderSvc> ITkPixelDecodingAlg::m_robDataProviderSvc { this, "ROBDataProvider", "ROBDataProviderSvc" }
private

Definition at line 43 of file ITkPixelDecodingAlg.h.

43{ this, "ROBDataProvider", "ROBDataProviderSvc" };

◆ m_sourceIDs

std::vector<uint32_t> ITkPixelDecodingAlg::m_sourceIDs
private

Definition at line 49 of file ITkPixelDecodingAlg.h.

◆ m_varHandleArraysDeclared

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

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

Definition at line 398 of file AthCommonDataStore.h.


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