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

Athena Algorithm to decode the SCT Byte Stream. More...

#include <SCTRawDataProvider.h>

Inheritance diagram for SCTRawDataProvider:
Collaboration diagram for SCTRawDataProvider:

Public Member Functions

 SCTRawDataProvider (const std::string &name, ISvcLocator *pSvcLocator)
 Constructor. More...
 
virtual ~SCTRawDataProvider ()=default
 Destructor. More...
 
virtual StatusCode initialize () override
 Initialize. More...
 
virtual StatusCode execute (const EventContext &ctx) const override
 Execute. More...
 
virtual bool isClonable () const override
 Make this algorithm clonable. More...
 
virtual StatusCode sysInitialize () override
 Override sysInitialize. More...
 
virtual unsigned int cardinality () const override
 Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant. More...
 
virtual StatusCode sysExecute (const EventContext &ctx) override
 Execute an algorithm. More...
 
virtual const DataObjIDColl & extraOutputDeps () const override
 Return the list of extra output dependencies. More...
 
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. 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

ServiceHandle< IROBDataProviderSvcm_robDataProvider
 ROB Data Provider for accessing ROB data. More...
 
ToolHandle< IRegSelToolm_regionSelector
 Region Selector tool for Athena. More...
 
ToolHandle< ISCTRawDataProviderToolm_rawDataTool
 Tool to fill Collections of SCT RDO Containers. More...
 
ToolHandle< ISCT_CablingToolm_cabling
 Providing mappings of online and offline identifiers and also serial numbers. More...
 
const SCT_IDm_sctID {nullptr}
 Identifier helper class for the SCT subdetector that creates compact Identifier objects and IdentifierHash or hash IDs. More...
 
BooleanProperty m_roiSeeded {this, "isRoI_Seeded", false, "Use RoI"}
 Boolean to determine if SCT Raw Data Provider should be run in RoI seeded mode. More...
 
Gaudi::Property< bool > m_useDataPoolWithCache
 Boolean to Use DataPool with IDC online Cache. More...
 
SG::ReadHandleKey< TrigRoiDescriptorCollectionm_roiCollectionKey
 Read handle for Trigger ROI descriptor collection. More...
 
SG::WriteHandleKey< SCT_RDO_Containerm_rdoContainerKey
 Write handle for SCT RDO container. More...
 
SG::WriteHandleKey< InDetTimeCollectionm_lvl1CollectionKey
 Write handle for LVL 1 Inner Detector time collection. More...
 
SG::WriteHandleKey< InDetTimeCollectionm_bcIDCollectionKey
 Write handle for BC ID Inner Detector time collection. More...
 
SG::WriteHandleKey< IDCInDetBSErrContainerm_bsIDCErrContainerKey
 Write handle for Inner Detector ByteStream error container. More...
 
SG::UpdateHandleKey< SCT_RDO_Cachem_rdoContainerCacheKey
 Update handle for SCT RDO and Erorrs Cache. More...
 
SG::UpdateHandleKey< IDCInDetBSErrContainer_Cachem_bsErrContainerCacheKey
 
Gaudi::Property< bool > m_storeInDetTimeColls {this, "StoreInDetTimeCollections", true, "Store LVL1ID and BCID"}
 
DataObjIDColl m_extendedExtraObjects
 Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks. More...
 
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

Athena Algorithm to decode the SCT Byte Stream.

Gets vector of ROBFragments from the ROBDataProviderSvc and uses AlgTools (SCTRawDataProviderTool and SCT_RodDecoder to read the ByteStream and make RDOs. Output is one RDO container (IDC) per event, which contains one Collection per link (8176 in total), each of which contains RDOs for hits (one RDO per strip in expanded mode, one per cluster in condensed mode).

Class based on TRT equivalent.

Definition at line 44 of file SCTRawDataProvider.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ SCTRawDataProvider()

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

Constructor.

Definition at line 19 of file SCTRawDataProvider.cxx.

19  :
20  AthReentrantAlgorithm(name, pSvcLocator)
21 {
22  declareProperty("RDOCacheKey", m_rdoContainerCacheKey="");
23  declareProperty("BSErrCacheKey", m_bsErrContainerCacheKey="");
24 }

◆ ~SCTRawDataProvider()

virtual SCTRawDataProvider::~SCTRawDataProvider ( )
virtualdefault

Destructor.

Member Function Documentation

◆ cardinality()

unsigned int AthReentrantAlgorithm::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.

Override this to return 0 for reentrant algorithms.

Definition at line 55 of file AthReentrantAlgorithm.cxx.

56 {
57  return 0;
58 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::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< Gaudi::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< Gaudi::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< Gaudi::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< Gaudi::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< Gaudi::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< Gaudi::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< Gaudi::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< Gaudi::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< Gaudi::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< 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.

95 { return m_detStore; }

◆ evtStore() [1/2]

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.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::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 SCTRawDataProvider::execute ( const EventContext &  ctx) const
overridevirtual

Execute.

Definition at line 64 of file SCTRawDataProvider.cxx.

65 {
67  bool externalCacheRDO = !m_rdoContainerCacheKey.key().empty();
68  if (not externalCacheRDO) {
69  ATH_CHECK(rdoContainer.record (std::make_unique<SCT_RDO_Container>(m_sctID->wafer_hash_max(), EventContainers::Mode::OfflineFast)));
70  ATH_MSG_DEBUG("Created container for " << m_sctID->wafer_hash_max());
71  }
72  else {
74  ATH_CHECK(rdoCache.isValid());
75  ATH_CHECK(rdoContainer.record (std::make_unique<SCT_RDO_Container>(rdoCache.ptr())));
76  ATH_MSG_DEBUG("Created container using cache for " << m_rdoContainerCacheKey.key());
77  }
78 
80  if ( m_bsErrContainerCacheKey.key().empty() ) {
81  ATH_CHECK(bsIDCErrContainer.record( std::make_unique<IDCInDetBSErrContainer>(m_sctID->wafer_hash_max(), std::numeric_limits<IDCInDetBSErrContainer::ErrorCode>::min() )));
82  ATH_MSG_DEBUG("Created IDCInDetBSErrContainer w/o using external cache");
83  } else { // use cache
85  ATH_CHECK( cacheHandle.isValid() );
86  ATH_CHECK(bsIDCErrContainer.record( std::make_unique<IDCInDetBSErrContainer>(cacheHandle.ptr())) );
87  ATH_MSG_DEBUG("Created SCT IDCInDetBSErrContainer using external cache");
88  }
89 
90  // Ask ROBDataProviderSvc for the vector of ROBFragment for all SCT ROBIDs
91  std::vector<const ROBFragment*> vecROBFrags;
92  std::vector<IdentifierHash> hashIDs;
93  if (not m_roiSeeded.value()) {
94  std::vector<uint32_t> rodList;
95  m_cabling->getAllRods(rodList, ctx);
96  m_robDataProvider->getROBData(ctx, rodList, vecROBFrags);
97  }
98  else {
99  // Only load ROBs from RoI
100  std::vector<uint32_t> listOfROBs;
102  ATH_CHECK(roiCollection.isValid());
103  TrigRoiDescriptor superRoI; // Add all RoIs to a super-RoI
104  superRoI.reserve(roiCollection->size());
105  superRoI.setComposite(true);
106  superRoI.manageConstituents(false);
107  for (const TrigRoiDescriptor* roi : *roiCollection) {
108  superRoI.push_back(roi);
109  }
110  m_regionSelector->ROBIDList(superRoI, listOfROBs);
111  m_regionSelector->HashIDList(superRoI, hashIDs);
112  m_robDataProvider->getROBData(ctx, listOfROBs, vecROBFrags);
113  }
114 
115 
116  ATH_MSG_DEBUG("Number of ROB fragments " << vecROBFrags.size());
117 
118  if (m_storeInDetTimeColls) {
121  lvl1Collection = SG::makeHandle(m_lvl1CollectionKey,ctx);
122  bcIDCollection = SG::makeHandle(m_bcIDCollectionKey,ctx);
123 
124  ATH_CHECK(lvl1Collection.record(std::make_unique<InDetTimeCollection>()));
125  ATH_CHECK(bcIDCollection.record(std::make_unique<InDetTimeCollection>()));
126 
127  lvl1Collection->reserve(vecROBFrags.size());
128  bcIDCollection->reserve(vecROBFrags.size());
129 
130  for (const ROBFragment* robFrag : vecROBFrags) {
131  // Store LVL1ID and BCID information in InDetTimeCollection
132  // to be stored in StoreGate at the end of the loop.
133  // We want to store a pair<ROBID, LVL1ID> for each ROD, once per event.
134  uint32_t robID{(robFrag)->rod_source_id()};
135 
136  unsigned int lvl1ID{(robFrag)->rod_lvl1_id()};
137  lvl1Collection->emplace_back(robID, lvl1ID);
138 
139  unsigned int bcID{(robFrag)->rod_bc_id()};
140  bcIDCollection->emplace_back(robID, bcID);
141 
142  ATH_MSG_DEBUG("Stored LVL1ID " << lvl1ID << " and BCID " << bcID << " in InDetTimeCollections");
143  }
144  }
145 
146  if ( not hashIDs.empty() ) {
147  int missingCount{};
148  for ( IdentifierHash hash: hashIDs ) {
149  if ( not rdoContainer->tryAddFromCache( hash ) ) missingCount++;
150  bsIDCErrContainer->tryAddFromCache( hash );
151  }
152  ATH_MSG_DEBUG("Out of: " << hashIDs.size() << "Hash IDs missing: " << missingCount );
153  if ( missingCount == 0 ) {
154  return StatusCode::SUCCESS;
155  }
156  }
157 
158  std::unique_ptr<DataPool<SCT3_RawData>> dataItemsPool = nullptr;
159  if(!externalCacheRDO){
160  dataItemsPool = std::make_unique<DataPool<SCT3_RawData>>(ctx);
161  dataItemsPool->reserve(10000); // Some large default size
162  } else if (m_useDataPoolWithCache) {
163  dataItemsPool = std::make_unique<DataPool<SCT3_RawData>>(ctx);
164  // for now a default size 1024.
165  }
166 
167  // Ask SCTRawDataProviderTool to decode it and to fill the IDC
168  StatusCode statConv = m_rawDataTool->convert(vecROBFrags,
169  *(rdoContainer.ptr()),
170  *bsIDCErrContainer,
171  dataItemsPool.get(),
172  ctx);
173 
174  if (statConv.isFailure() && statConv != StatusCode::RECOVERABLE) {
175  ATH_MSG_WARNING("BS conversion into RDOs failed");
176  return statConv;
177  } else {
178  return StatusCode::SUCCESS;
179  }
180 
181 }

◆ 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 & AthReentrantAlgorithm::extraOutputDeps ( ) const
overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 79 of file AthReentrantAlgorithm.cxx.

80 {
81  // If we didn't find any symlinks to add, just return the collection
82  // from the base class. Otherwise, return the extended collection.
83  if (!m_extendedExtraObjects.empty()) {
85  }
86  return Algorithm::extraOutputDeps();
87 }

◆ filterPassed()

virtual bool AthReentrantAlgorithm::filterPassed ( const EventContext &  ctx) const
inlinevirtualinherited

Definition at line 135 of file AthReentrantAlgorithm.h.

135  {
136  return execState( ctx ).filterPassed();
137  }

◆ initialize()

StatusCode SCTRawDataProvider::initialize ( )
overridevirtual

Initialize.

Definition at line 28 of file SCTRawDataProvider.cxx.

29 {
30  // Get ROBDataProviderSvc
31  ATH_CHECK(m_robDataProvider.retrieve());
32 
33  // Get the SCT ID helper
34  ATH_CHECK(detStore()->retrieve(m_sctID, "SCT_ID"));
35  if (m_roiSeeded.value()) {
36  // Don't need SCT cabling if running in RoI-seeded mode
38  ATH_CHECK(m_regionSelector.retrieve());
39  m_cabling.disable();
40  }
41  else {
42  //Disable Roi requirement
44  // Retrieve Cabling tool
45  ATH_CHECK(m_cabling.retrieve());
46  m_regionSelector.disable();
47  }
48 
49  //Initialize
50  ATH_CHECK(m_rdoContainerKey.initialize());
54  ATH_CHECK(m_rdoContainerCacheKey.initialize(!m_rdoContainerCacheKey.key().empty()));
56 
57  ATH_CHECK( m_rawDataTool.retrieve() );
58 
59  return StatusCode::SUCCESS;
60 }

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

virtual bool SCTRawDataProvider::isClonable ( ) const
inlineoverridevirtual

Make this algorithm clonable.

Reimplemented from AthReentrantAlgorithm.

Definition at line 61 of file SCTRawDataProvider.h.

61 { return true; };

◆ msg() [1/2]

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

Definition at line 24 of file AthCommonMsg.h.

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

◆ msg() [2/2]

MsgStream& AthCommonMsg< Gaudi::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< 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();
383  PBASE::renounce (h);
384  }

◆ 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  {
365  handlesArray.renounce();
366  }

◆ setFilterPassed()

virtual void AthReentrantAlgorithm::setFilterPassed ( bool  state,
const EventContext &  ctx 
) const
inlinevirtualinherited

Definition at line 139 of file AthReentrantAlgorithm.h.

139  {
140  execState( ctx ).setFilterPassed( state );
141  }

◆ sysExecute()

StatusCode AthReentrantAlgorithm::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 67 of file AthReentrantAlgorithm.cxx.

68 {
69  return Gaudi::Algorithm::sysExecute (ctx);
70 }

◆ sysInitialize()

StatusCode AthReentrantAlgorithm::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 InputMakerBase, and HypoBase.

Definition at line 96 of file AthReentrantAlgorithm.cxx.

96  {
98 
99  if (sc.isFailure()) {
100  return sc;
101  }
102 
103  ServiceHandle<ICondSvc> cs("CondSvc",name());
104  for (auto h : outputHandles()) {
105  if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
106  // do this inside the loop so we don't create the CondSvc until needed
107  if ( cs.retrieve().isFailure() ) {
108  ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
109  return StatusCode::SUCCESS;
110  }
111  if (cs->regHandle(this,*h).isFailure()) {
112  sc = StatusCode::FAILURE;
113  ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
114  << " with CondSvc");
115  }
116  }
117  }
118  return sc;
119 }

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

Member Data Documentation

◆ m_bcIDCollectionKey

SG::WriteHandleKey<InDetTimeCollection> SCTRawDataProvider::m_bcIDCollectionKey
private
Initial value:
{this,
"BCIDKey",
"SCT_BCID",
"SCT BCID key"}

Write handle for BC ID Inner Detector time collection.

Definition at line 117 of file SCTRawDataProvider.h.

◆ m_bsErrContainerCacheKey

SG::UpdateHandleKey<IDCInDetBSErrContainer_Cache> SCTRawDataProvider::m_bsErrContainerCacheKey
private

Definition at line 131 of file SCTRawDataProvider.h.

◆ m_bsIDCErrContainerKey

SG::WriteHandleKey<IDCInDetBSErrContainer> SCTRawDataProvider::m_bsIDCErrContainerKey
private
Initial value:
{this,
"IDCByteStreamErrContainer",
"SCT_ByteStreamErrs",
"SCT BS error key for IDC variant"}

Write handle for Inner Detector ByteStream error container.

Definition at line 123 of file SCTRawDataProvider.h.

◆ m_cabling

ToolHandle<ISCT_CablingTool> SCTRawDataProvider::m_cabling
private
Initial value:
{this,
"SCT_CablingTool",
"SCT_CablingTool",
"Tool to retrieve SCT Cabling"}

Providing mappings of online and offline identifiers and also serial numbers.

Definition at line 82 of file SCTRawDataProvider.h.

◆ 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 AthReentrantAlgorithm::m_extendedExtraObjects
privateinherited

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

Empty if no symlinks were found.

Definition at line 153 of file AthReentrantAlgorithm.h.

◆ m_lvl1CollectionKey

SG::WriteHandleKey<InDetTimeCollection> SCTRawDataProvider::m_lvl1CollectionKey
private
Initial value:
{this,
"LVL1IDKey",
"SCT_LVL1ID",
"SCT LVL1ID key"}

Write handle for LVL 1 Inner Detector time collection.

Definition at line 111 of file SCTRawDataProvider.h.

◆ m_rawDataTool

ToolHandle<ISCTRawDataProviderTool> SCTRawDataProvider::m_rawDataTool
private
Initial value:
{this,
"ProviderTool",
"SCTRawDataProviderTool",
"SCT Raw Data Provider Tool"}

Tool to fill Collections of SCT RDO Containers.

Definition at line 76 of file SCTRawDataProvider.h.

◆ m_rdoContainerCacheKey

SG::UpdateHandleKey<SCT_RDO_Cache> SCTRawDataProvider::m_rdoContainerCacheKey
private

Update handle for SCT RDO and Erorrs Cache.

Definition at line 130 of file SCTRawDataProvider.h.

◆ m_rdoContainerKey

SG::WriteHandleKey<SCT_RDO_Container> SCTRawDataProvider::m_rdoContainerKey
private
Initial value:
{this,
"RDOKey",
"SCT_RDOs",
"SCT RDO key"}

Write handle for SCT RDO container.

Definition at line 105 of file SCTRawDataProvider.h.

◆ m_regionSelector

ToolHandle<IRegSelTool> SCTRawDataProvider::m_regionSelector
private
Initial value:
{this,
"RegSelTool",
"RegSelTool/RegSel_SCT"}

Region Selector tool for Athena.

Definition at line 71 of file SCTRawDataProvider.h.

◆ m_robDataProvider

ServiceHandle<IROBDataProviderSvc> SCTRawDataProvider::m_robDataProvider
private
Initial value:
{this,
"ROBDataProviderSvc",
"ROBDataProviderSvc"}

ROB Data Provider for accessing ROB data.

Definition at line 66 of file SCTRawDataProvider.h.

◆ m_roiCollectionKey

SG::ReadHandleKey<TrigRoiDescriptorCollection> SCTRawDataProvider::m_roiCollectionKey
private
Initial value:
{this,
"RoIs",
"",
"RoIs to read in"}

Read handle for Trigger ROI descriptor collection.

Definition at line 99 of file SCTRawDataProvider.h.

◆ m_roiSeeded

BooleanProperty SCTRawDataProvider::m_roiSeeded {this, "isRoI_Seeded", false, "Use RoI"}
private

Boolean to determine if SCT Raw Data Provider should be run in RoI seeded mode.

Definition at line 92 of file SCTRawDataProvider.h.

◆ m_sctID

const SCT_ID* SCTRawDataProvider::m_sctID {nullptr}
private

Identifier helper class for the SCT subdetector that creates compact Identifier objects and IdentifierHash or hash IDs.

Also allows decoding of these IDs.

Definition at line 89 of file SCTRawDataProvider.h.

◆ m_storeInDetTimeColls

Gaudi::Property<bool> SCTRawDataProvider::m_storeInDetTimeColls {this, "StoreInDetTimeCollections", true, "Store LVL1ID and BCID"}
private

Definition at line 133 of file SCTRawDataProvider.h.

◆ m_useDataPoolWithCache

Gaudi::Property<bool> SCTRawDataProvider::m_useDataPoolWithCache
private
Initial value:
{
this, "useDataPoolWithCache", false, "use DataPool With Cache"}

Boolean to Use DataPool with IDC online Cache.

Definition at line 95 of file SCTRawDataProvider.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:
python.PyKernel.retrieve
def retrieve(aClass, aKey=None)
Definition: PyKernel.py:110
SCTRawDataProvider::m_bsErrContainerCacheKey
SG::UpdateHandleKey< IDCInDetBSErrContainer_Cache > m_bsErrContainerCacheKey
Definition: SCTRawDataProvider.h:131
SCTRawDataProvider::m_useDataPoolWithCache
Gaudi::Property< bool > m_useDataPoolWithCache
Boolean to Use DataPool with IDC online Cache.
Definition: SCTRawDataProvider.h:95
beamspotPlotBcids.k
k
Definition: beamspotPlotBcids.py:524
SCTRawDataProvider::m_robDataProvider
ServiceHandle< IROBDataProviderSvc > m_robDataProvider
ROB Data Provider for accessing ROB data.
Definition: SCTRawDataProvider.h:66
python.PerfMonSerializer.p
def p
Definition: PerfMonSerializer.py:743
SCTRawDataProvider::m_bcIDCollectionKey
SG::WriteHandleKey< InDetTimeCollection > m_bcIDCollectionKey
Write handle for BC ID Inner Detector time collection.
Definition: SCTRawDataProvider.h:117
beamspotVtxAnalysis.cs
list cs
Definition: beamspotVtxAnalysis.py:391
xAOD::uint32_t
setEventNumber uint32_t
Definition: EventInfo_v1.cxx:127
SG::ReadHandle
Definition: StoreGate/StoreGate/ReadHandle.h:70
AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
Definition: AthCommonDataStore.h:145
AthCommonDataStore::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 > renounce(T &h)
Definition: AthCommonDataStore.h:380
AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
Definition: AthCommonDataStore.h:390
AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka
std::vector< SG::VarHandleKeyArray * > m_vhka
Definition: AthCommonDataStore.h:398
SCTRawDataProvider::m_storeInDetTimeColls
Gaudi::Property< bool > m_storeInDetTimeColls
Definition: SCTRawDataProvider.h:133
TrigRoiDescriptor
nope - should be used for standalone also, perhaps need to protect the class def bits #ifndef XAOD_AN...
Definition: TrigRoiDescriptor.h:56
read_hist_ntuple.t
t
Definition: read_hist_ntuple.py:5
AthenaPoolTestRead.sc
sc
Definition: AthenaPoolTestRead.py:27
AthCommonDataStore< AthCommonMsg< Gaudi::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
SG::makeHandle
SG::ReadCondHandle< T > makeHandle(const SG::ReadCondHandleKey< T > &key, const EventContext &ctx=Gaudi::Hive::currentContext())
Definition: ReadCondHandle.h:269
AthCommonDataStore
Definition: AthCommonDataStore.h:52
AthReentrantAlgorithm::AthReentrantAlgorithm
AthReentrantAlgorithm()
Default constructor:
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
RoiDescriptor::push_back
void push_back(const IRoiDescriptor *roi)
add a RoiDescriptor
Definition: RoiDescriptor.h:157
AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::outputHandles
virtual std::vector< Gaudi::DataHandle * > outputHandles() const override
Return this algorithm's output handles.
RoiDescriptor::reserve
void reserve(size_t s)
reserve elements in vector
Definition: RoiDescriptor.h:154
eformat::ROBFragment
Definition: L1CaloBsDecoderUtil.h:12
EL::StatusCode
::StatusCode StatusCode
StatusCode definition for legacy code.
Definition: PhysicsAnalysis/D3PDTools/EventLoop/EventLoop/StatusCode.h:22
SCTRawDataProvider::m_rdoContainerCacheKey
SG::UpdateHandleKey< SCT_RDO_Cache > m_rdoContainerCacheKey
Update handle for SCT RDO and Erorrs Cache.
Definition: SCTRawDataProvider.h:130
ATH_MSG_DEBUG
#define ATH_MSG_DEBUG(x)
Definition: AthMsgStreamMacros.h:29
SCTRawDataProvider::m_cabling
ToolHandle< ISCT_CablingTool > m_cabling
Providing mappings of online and offline identifiers and also serial numbers.
Definition: SCTRawDataProvider.h:82
SCTRawDataProvider::m_roiCollectionKey
SG::ReadHandleKey< TrigRoiDescriptorCollection > m_roiCollectionKey
Read handle for Trigger ROI descriptor collection.
Definition: SCTRawDataProvider.h:99
ATH_CHECK
#define ATH_CHECK
Definition: AthCheckMacros.h:40
SCTRawDataProvider::m_bsIDCErrContainerKey
SG::WriteHandleKey< IDCInDetBSErrContainer > m_bsIDCErrContainerKey
Write handle for Inner Detector ByteStream error container.
Definition: SCTRawDataProvider.h:123
AthCommonDataStore< AthCommonMsg< Gaudi::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
SCTRawDataProvider::m_roiSeeded
BooleanProperty m_roiSeeded
Boolean to determine if SCT Raw Data Provider should be run in RoI seeded mode.
Definition: SCTRawDataProvider.h:92
AthReentrantAlgorithm::m_extendedExtraObjects
DataObjIDColl m_extendedExtraObjects
Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
Definition: AthReentrantAlgorithm.h:153
min
#define min(a, b)
Definition: cfImp.cxx:40
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:192
SCT_ID::wafer_hash_max
size_type wafer_hash_max(void) const
Definition: SCT_ID.cxx:639
AthReentrantAlgorithm::sysInitialize
virtual StatusCode sysInitialize() override
Override sysInitialize.
Definition: AthReentrantAlgorithm.cxx:96
SG::UpdateHandle
Definition: UpdateHandle.h:94
EventContainers::Mode::OfflineFast
@ OfflineFast
SCTRawDataProvider::m_lvl1CollectionKey
SG::WriteHandleKey< InDetTimeCollection > m_lvl1CollectionKey
Write handle for LVL 1 Inner Detector time collection.
Definition: SCTRawDataProvider.h:111
SCTRawDataProvider::m_rdoContainerKey
SG::WriteHandleKey< SCT_RDO_Container > m_rdoContainerKey
Write handle for SCT RDO container.
Definition: SCTRawDataProvider.h:105
SG::WriteHandle
Definition: StoreGate/StoreGate/WriteHandle.h:76
a
TList * a
Definition: liststreamerinfos.cxx:10
h
SG::WriteHandle::record
StatusCode record(std::unique_ptr< T > data)
Record a const object to the store.
CaloCondBlobAlgs_fillNoiseFromASCII.hash
dictionary hash
Definition: CaloCondBlobAlgs_fillNoiseFromASCII.py:109
ATH_MSG_WARNING
#define ATH_MSG_WARNING(x)
Definition: AthMsgStreamMacros.h:32
SCTRawDataProvider::m_rawDataTool
ToolHandle< ISCTRawDataProviderTool > m_rawDataTool
Tool to fill Collections of SCT RDO Containers.
Definition: SCTRawDataProvider.h:76
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
RoiDescriptor::setComposite
void setComposite(bool b=true)
Definition: RoiDescriptor.h:138
python.Bindings.keys
keys
Definition: Control/AthenaPython/python/Bindings.py:790
RoiDescriptor::manageConstituents
bool manageConstituents() const
always manage constituents ???
Definition: RoiDescriptor.h:141
IdentifierHash
Definition: IdentifierHash.h:38
AthCommonDataStore::declareGaudiProperty
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition: AthCommonDataStore.h:156
SCTRawDataProvider::m_regionSelector
ToolHandle< IRegSelTool > m_regionSelector
Region Selector tool for Athena.
Definition: SCTRawDataProvider.h:71
SCTRawDataProvider::m_sctID
const SCT_ID * m_sctID
Identifier helper class for the SCT subdetector that creates compact Identifier objects and Identifie...
Definition: SCTRawDataProvider.h:89
ServiceHandle< ICondSvc >