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

#include <SCTOverlay.h>

Inheritance diagram for SCTOverlay:
Collaboration diagram for SCTOverlay:

Public Types

enum  SCT_numbers {
  NextBC =0 , CurrentBC =1 , PreviousBC =2 , AnyBC =3 ,
  NumberOfBCs =3 , NumberOfBitSets =4 , NumberOfStrips =1536 , BkgSource =0 ,
  SignalSource =1 , NumberOfSources =2
}

Public Member Functions

 SCTOverlay (const std::string &name, ISvcLocator *pSvcLocator)
virtual StatusCode initialize () override final
virtual StatusCode execute (const EventContext &ctx) const override final
const SCT_IDget_sct_id () const
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

template<typename IDC_Container>
StatusCode overlayContainer (const IDC_Container *bkgContainer, const IDC_Container *signalContainer, IDC_Container *outputContainer) const
template<typename IDC_Container, typename Type>
StatusCode overlayContainer (const IDC_Container *bkgContainer, const IDC_Container *signalContainer, IDC_Container *outputContainer, DataPool< Type > &dataItems) const
template<typename IDC_Container, typename Type>
StatusCode overlayContainerWithSorting (const IDC_Container *bkgContainer, const IDC_Container *signalContainer, IDC_Container *outputContainer, DataPool< Type > &dataItems) const
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

template<bool sortCollections, bool usePool, typename Type, typename IDC_Container>
StatusCode overlayContainerImpl (const IDC_Container *bkgContainer, const IDC_Container *signalContainer, IDC_Container *outputContainer, DataPool< Type > *dataItems) const
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
 specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes

const SCT_IDm_sctId {}
SG::ReadHandleKey< SCT_RDO_Containerm_bkgInputKey { this, "BkgInputKey", "Bkg_SCT_RDOs", "ReadHandleKey for Background Input SCT_RDO_Container" }
SG::ReadHandleKey< SCT_RDO_Containerm_signalInputKey { this, "SignalInputKey", "Sig_SCT_RDOs", "ReadHandleKey for Signal Input SCT_RDO_Container" }
SG::WriteHandleKey< SCT_RDO_Containerm_outputKey { this, "OutputKey", "SCT_RDOs", "WriteHandleKey for Output SCT_RDO_Container" }
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 13 of file SCTOverlay.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

◆ SCT_numbers

Enumerator
NextBC 
CurrentBC 
PreviousBC 
AnyBC 
NumberOfBCs 
NumberOfBitSets 
NumberOfStrips 
BkgSource 
SignalSource 
NumberOfSources 

Definition at line 27 of file SCTOverlay.h.

Constructor & Destructor Documentation

◆ SCTOverlay()

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

Definition at line 160 of file SCTOverlay.cxx.

161 : IDC_OverlayBase(name, pSvcLocator)
162{
163}
IDC_OverlayBase(const std::string &name, ISvcLocator *pSvcLocator)

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 SCTOverlay::execute ( const EventContext & ctx) const
finaloverridevirtual

Definition at line 186 of file SCTOverlay.cxx.

187{
188 ATH_MSG_DEBUG("execute() begin");
189
190 // Reading the input RDOs
191 ATH_MSG_VERBOSE("Retrieving input RDO containers");
192
193 const SCT_RDO_Container *bkgContainerPtr = nullptr;
194 if (!m_bkgInputKey.empty()) {
195 SG::ReadHandle<SCT_RDO_Container> bkgContainer(m_bkgInputKey, ctx);
196 if (!bkgContainer.isValid()) {
197 ATH_MSG_ERROR("Could not get background SCT RDO container " << bkgContainer.name() << " from store " << bkgContainer.store());
198 return StatusCode::FAILURE;
199 }
200 bkgContainerPtr = bkgContainer.cptr();
201
202 ATH_MSG_DEBUG("Found background SCT RDO container " << bkgContainer.name() << " in store " << bkgContainer.store());
203 ATH_MSG_DEBUG("SCT Background = " << Overlay::debugPrint(bkgContainer.cptr(), 50));
204 }
205
206 SG::ReadHandle<SCT_RDO_Container> signalContainer(m_signalInputKey, ctx);
207 if (!signalContainer.isValid()) {
208 ATH_MSG_ERROR("Could not get signal SCT RDO container " << signalContainer.name() << " from store " << signalContainer.store());
209 return StatusCode::FAILURE;
210 }
211 ATH_MSG_DEBUG("Found signal SCT RDO container " << signalContainer.name() << " in store " << signalContainer.store());
212 ATH_MSG_DEBUG("SCT Signal = " << Overlay::debugPrint(signalContainer.cptr(), 50));
213
214 // Creating output RDO container
215 SG::WriteHandle<SCT_RDO_Container> outputContainer(m_outputKey, ctx);
216
217
218 ATH_CHECK(outputContainer.record(std::make_unique<SCT_RDO_Container>(signalContainer->size())));
219 if (!outputContainer.isValid()) {
220 ATH_MSG_ERROR("Could not record output SCT RDO container " << outputContainer.name() << " to store " << outputContainer.store());
221 return StatusCode::FAILURE;
222 }
223 ATH_MSG_DEBUG("Recorded output SCT RDO container " << outputContainer.name() << " in store " << outputContainer.store());
224
225 // The DataPool, this is what will actually own the elements
226 // we create during this algorithm. The containers are views.
227 DataPool<SCT3_RawData> dataItemsPool(ctx);
228 // It resizes but lets reserve already quite a few
229 dataItemsPool.prepareToAdd(250000);
230
231 ATH_CHECK(overlayContainer(bkgContainerPtr, signalContainer.cptr(), outputContainer.ptr(),dataItemsPool));
232 ATH_MSG_DEBUG("SCT Result = " << Overlay::debugPrint(outputContainer.ptr(), 50));
233
234 ATH_MSG_DEBUG("execute() end");
235 return StatusCode::SUCCESS;
236}
#define ATH_CHECK
Evaluate an expression and check for errors.
#define ATH_MSG_ERROR(x)
#define ATH_MSG_VERBOSE(x)
#define ATH_MSG_DEBUG(x)
InDetRawDataContainer< InDetRawDataCollection< SCT_RDORawData > > SCT_RDO_Container
StatusCode overlayContainer(const IDC_Container *bkgContainer, const IDC_Container *signalContainer, IDC_Container *outputContainer) const
SG::ReadHandleKey< SCT_RDO_Container > m_signalInputKey
Definition SCTOverlay.h:35
SG::ReadHandleKey< SCT_RDO_Container > m_bkgInputKey
Definition SCTOverlay.h:34
SG::WriteHandleKey< SCT_RDO_Container > m_outputKey
Definition SCTOverlay.h:36
std::string debugPrint(const IDC_Container *container, unsigned numprint=25)
Diagnostic output of Identifiable Containers.

◆ 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

◆ get_sct_id()

const SCT_ID * SCTOverlay::get_sct_id ( ) const
inline

Definition at line 25 of file SCTOverlay.h.

25{ return m_sctId; }
const SCT_ID * m_sctId
Definition SCTOverlay.h:32

◆ initialize()

StatusCode SCTOverlay::initialize ( )
finaloverridevirtual

Definition at line 165 of file SCTOverlay.cxx.

166{
167 ATH_MSG_DEBUG("Initializing...");
168
169 // Check and initialize keys
170 ATH_CHECK( m_bkgInputKey.initialize(!m_bkgInputKey.key().empty()) );
171 ATH_MSG_VERBOSE("Initialized ReadHandleKey: " << m_bkgInputKey);
172 ATH_CHECK( m_signalInputKey.initialize() );
173 ATH_MSG_VERBOSE("Initialized ReadHandleKey: " << m_signalInputKey);
174 ATH_CHECK( m_outputKey.initialize() );
175 ATH_MSG_VERBOSE("Initialized WriteHandleKey: " << m_outputKey);
176
177 // Retrieve SCT ID helper
178 if (!detStore()->retrieve(m_sctId, "SCT_ID").isSuccess() || !m_sctId) {
179 ATH_MSG_FATAL("Cannot retrieve SCT ID helper");
180 return StatusCode::FAILURE;
181 }
182
183 return StatusCode::SUCCESS;
184}
#define ATH_MSG_FATAL(x)
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.

◆ overlayContainer() [1/2]

template<typename IDC_Container>
StatusCode IDC_OverlayBase::overlayContainer ( const IDC_Container * bkgContainer,
const IDC_Container * signalContainer,
IDC_Container * outputContainer ) const
protectedinherited

◆ overlayContainer() [2/2]

template<typename IDC_Container, typename Type>
StatusCode IDC_OverlayBase::overlayContainer ( const IDC_Container * bkgContainer,
const IDC_Container * signalContainer,
IDC_Container * outputContainer,
DataPool< Type > & dataItems ) const
protectedinherited

◆ overlayContainerImpl()

template<bool sortCollections, bool usePool, typename Type, typename IDC_Container>
StatusCode IDC_OverlayBase::overlayContainerImpl ( const IDC_Container * bkgContainer,
const IDC_Container * signalContainer,
IDC_Container * outputContainer,
DataPool< Type > * dataItems ) const
privateinherited

◆ overlayContainerWithSorting()

template<typename IDC_Container, typename Type>
StatusCode IDC_OverlayBase::overlayContainerWithSorting ( const IDC_Container * bkgContainer,
const IDC_Container * signalContainer,
IDC_Container * outputContainer,
DataPool< Type > & dataItems ) const
protectedinherited

◆ 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_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_bkgInputKey

SG::ReadHandleKey<SCT_RDO_Container> SCTOverlay::m_bkgInputKey { this, "BkgInputKey", "Bkg_SCT_RDOs", "ReadHandleKey for Background Input SCT_RDO_Container" }
private

Definition at line 34 of file SCTOverlay.h.

34{ this, "BkgInputKey", "Bkg_SCT_RDOs", "ReadHandleKey for Background Input SCT_RDO_Container" };

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

SG::WriteHandleKey<SCT_RDO_Container> SCTOverlay::m_outputKey { this, "OutputKey", "SCT_RDOs", "WriteHandleKey for Output SCT_RDO_Container" }
private

Definition at line 36 of file SCTOverlay.h.

36{ this, "OutputKey", "SCT_RDOs", "WriteHandleKey for Output SCT_RDO_Container" };

◆ m_sctId

const SCT_ID* SCTOverlay::m_sctId {}
private

Definition at line 32 of file SCTOverlay.h.

32{};

◆ m_signalInputKey

SG::ReadHandleKey<SCT_RDO_Container> SCTOverlay::m_signalInputKey { this, "SignalInputKey", "Sig_SCT_RDOs", "ReadHandleKey for Signal Input SCT_RDO_Container" }
private

Definition at line 35 of file SCTOverlay.h.

35{ this, "SignalInputKey", "Sig_SCT_RDOs", "ReadHandleKey for Signal Input SCT_RDO_Container" };

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