ATLAS Offline Software
Loading...
Searching...
No Matches
ActsTrk::PixelSpacePointFormationAlgBase< useCache > Class Template Reference

#include <PixelSpacePointFormationAlgBase.h>

Inheritance diagram for ActsTrk::PixelSpacePointFormationAlgBase< useCache >:
Collaboration diagram for ActsTrk::PixelSpacePointFormationAlgBase< useCache >:

Public Member Functions

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
AthReentrantAlgorithm methods
 PixelSpacePointFormationAlgBase (const std::string &name, ISvcLocator *pSvcLocator)
virtual ~PixelSpacePointFormationAlgBase ()=default
virtual StatusCode initialize () override
virtual StatusCode execute (const EventContext &ctx) const override
virtual StatusCode finalize () override

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>
Disallow constructor without parameters, copy constructor, assignment operator
 PixelSpacePointFormationAlgBase ()=delete
 PixelSpacePointFormationAlgBase (const PixelSpacePointFormationAlgBase &)=delete
PixelSpacePointFormationAlgBaseoperator= (const PixelSpacePointFormationAlgBase &)=delete

Private Attributes

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
Input data using SG::ReadHandleKey
SG::ReadHandleKey< xAOD::PixelClusterContainerm_pixelClusterContainerKey {this, "PixelClusters", "", "name of the input pixel cluster container"}
Input condition data using SG::ReadCondHandleKey
SG::ReadCondHandleKey< InDetDD::SiDetectorElementCollectionm_pixelDetEleCollKey {this, "PixelDetectorElements", "ITkPixelDetectorElementCollection", "Key of input SiDetectorElementCollection for Pixel"}
 To get detector elements.
Output data using SG::WriteHandleKey
SG::WriteHandleKey< xAOD::SpacePointContainerm_pixelSpacePointContainerKey {this, "PixelSpacePoints", "", "name of the output pixel space point container"}

ToolHandle

enum  EStat { kNClusters , kNSpacePoints , kNStat }
using Cache_IDC = typename Cache::Handles<xAOD::SpacePoint>::IDC
using Cache_BackendUpdateHandleKey = typename Cache::Handles<xAOD::SpacePoint>::BackendUpdateHandleKey
using Cache_BackendUpdateHandle = typename Cache::Handles<xAOD::SpacePoint>::BackendUpdateHandle
using Cache_WriteHandleKey = typename Cache::Handles<xAOD::SpacePoint>::WriteHandleKey
using Cache_WriteHandle = typename Cache::Handles<xAOD::SpacePoint>::WriteHandle
ToolHandle< ActsTrk::IPixelSpacePointFormationToolm_spacePointMakerTool {this, "SpacePointFormationTool", "", "Tool dedicated to the creation of pixel space points"}
 For space point formation.
ToolHandle< GenericMonitoringToolm_monTool {this, "MonTool", "", "Monitoring tool"}
 For monitoring.
Cache_WriteHandleKey m_SPCache {this,"SPCache",""}
Cache_BackendUpdateHandleKey m_SPCacheBackend {this,"SPCacheBackend",""}
std::array< std::atomic< unsigned int >, kNStat > m_stat ATLAS_THREAD_SAFE {}

Detailed Description

template<bool useCache>
class ActsTrk::PixelSpacePointFormationAlgBase< useCache >

Definition at line 38 of file PixelSpacePointFormationAlgBase.h.

Member Typedef Documentation

◆ Cache_BackendUpdateHandle

template<bool useCache>
using ActsTrk::PixelSpacePointFormationAlgBase< useCache >::Cache_BackendUpdateHandle = typename Cache::Handles<xAOD::SpacePoint>::BackendUpdateHandle
private

Definition at line 84 of file PixelSpacePointFormationAlgBase.h.

◆ Cache_BackendUpdateHandleKey

template<bool useCache>
using ActsTrk::PixelSpacePointFormationAlgBase< useCache >::Cache_BackendUpdateHandleKey = typename Cache::Handles<xAOD::SpacePoint>::BackendUpdateHandleKey
private

Definition at line 83 of file PixelSpacePointFormationAlgBase.h.

◆ Cache_IDC

template<bool useCache>
using ActsTrk::PixelSpacePointFormationAlgBase< useCache >::Cache_IDC = typename Cache::Handles<xAOD::SpacePoint>::IDC
private

Definition at line 82 of file PixelSpacePointFormationAlgBase.h.

◆ Cache_WriteHandle

template<bool useCache>
using ActsTrk::PixelSpacePointFormationAlgBase< useCache >::Cache_WriteHandle = typename Cache::Handles<xAOD::SpacePoint>::WriteHandle
private

Definition at line 86 of file PixelSpacePointFormationAlgBase.h.

◆ Cache_WriteHandleKey

template<bool useCache>
using ActsTrk::PixelSpacePointFormationAlgBase< useCache >::Cache_WriteHandleKey = typename Cache::Handles<xAOD::SpacePoint>::WriteHandleKey
private

Definition at line 85 of file PixelSpacePointFormationAlgBase.h.

◆ StoreGateSvc_t

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

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

◆ EStat

Constructor & Destructor Documentation

◆ PixelSpacePointFormationAlgBase() [1/3]

template<bool useCache>
ActsTrk::PixelSpacePointFormationAlgBase< useCache >::PixelSpacePointFormationAlgBase ( const std::string & name,
ISvcLocator * pSvcLocator )

◆ ~PixelSpacePointFormationAlgBase()

template<bool useCache>
virtual ActsTrk::PixelSpacePointFormationAlgBase< useCache >::~PixelSpacePointFormationAlgBase ( )
virtualdefault

◆ PixelSpacePointFormationAlgBase() [2/3]

template<bool useCache>
ActsTrk::PixelSpacePointFormationAlgBase< useCache >::PixelSpacePointFormationAlgBase ( )
privatedelete

◆ PixelSpacePointFormationAlgBase() [3/3]

template<bool useCache>
ActsTrk::PixelSpacePointFormationAlgBase< useCache >::PixelSpacePointFormationAlgBase ( const PixelSpacePointFormationAlgBase< useCache > & )
privatedelete

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

template<bool useCache>
virtual StatusCode ActsTrk::PixelSpacePointFormationAlgBase< useCache >::execute ( const EventContext & ctx) const
overridevirtual

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

template<bool useCache>
virtual StatusCode ActsTrk::PixelSpacePointFormationAlgBase< useCache >::finalize ( )
overridevirtual

◆ initialize()

template<bool useCache>
virtual StatusCode ActsTrk::PixelSpacePointFormationAlgBase< useCache >::initialize ( )
overridevirtual

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

◆ operator=()

template<bool useCache>
PixelSpacePointFormationAlgBase & ActsTrk::PixelSpacePointFormationAlgBase< useCache >::operator= ( const PixelSpacePointFormationAlgBase< useCache > & )
privatedelete

◆ 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

◆ ATLAS_THREAD_SAFE

template<bool useCache>
std::array<std::atomic<unsigned int>, kNStat> m_stat ActsTrk::PixelSpacePointFormationAlgBase< useCache >::ATLAS_THREAD_SAFE {}
mutableprivate

Definition at line 98 of file PixelSpacePointFormationAlgBase.h.

98{};

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

template<bool useCache>
ToolHandle<GenericMonitoringTool> ActsTrk::PixelSpacePointFormationAlgBase< useCache >::m_monTool {this, "MonTool", "", "Monitoring tool"}
private

For monitoring.

Definition at line 79 of file PixelSpacePointFormationAlgBase.h.

79{this, "MonTool", "", "Monitoring tool"};

◆ m_pixelClusterContainerKey

template<bool useCache>
SG::ReadHandleKey<xAOD::PixelClusterContainer> ActsTrk::PixelSpacePointFormationAlgBase< useCache >::m_pixelClusterContainerKey {this, "PixelClusters", "", "name of the input pixel cluster container"}
private

Definition at line 60 of file PixelSpacePointFormationAlgBase.h.

60{this, "PixelClusters", "", "name of the input pixel cluster container"};

◆ m_pixelDetEleCollKey

template<bool useCache>
SG::ReadCondHandleKey<InDetDD::SiDetectorElementCollection> ActsTrk::PixelSpacePointFormationAlgBase< useCache >::m_pixelDetEleCollKey {this, "PixelDetectorElements", "ITkPixelDetectorElementCollection", "Key of input SiDetectorElementCollection for Pixel"}
private

To get detector elements.

Definition at line 66 of file PixelSpacePointFormationAlgBase.h.

66{this, "PixelDetectorElements", "ITkPixelDetectorElementCollection", "Key of input SiDetectorElementCollection for Pixel"};

◆ m_pixelSpacePointContainerKey

template<bool useCache>
SG::WriteHandleKey<xAOD::SpacePointContainer> ActsTrk::PixelSpacePointFormationAlgBase< useCache >::m_pixelSpacePointContainerKey {this, "PixelSpacePoints", "", "name of the output pixel space point container"}
private

Definition at line 71 of file PixelSpacePointFormationAlgBase.h.

71{this, "PixelSpacePoints", "", "name of the output pixel space point container"};

◆ m_spacePointMakerTool

template<bool useCache>
ToolHandle<ActsTrk::IPixelSpacePointFormationTool> ActsTrk::PixelSpacePointFormationAlgBase< useCache >::m_spacePointMakerTool {this, "SpacePointFormationTool", "", "Tool dedicated to the creation of pixel space points"}
private

For space point formation.

Definition at line 77 of file PixelSpacePointFormationAlgBase.h.

77{this, "SpacePointFormationTool", "", "Tool dedicated to the creation of pixel space points"};

◆ m_SPCache

template<bool useCache>
Cache_WriteHandleKey ActsTrk::PixelSpacePointFormationAlgBase< useCache >::m_SPCache {this,"SPCache",""}
private

Definition at line 88 of file PixelSpacePointFormationAlgBase.h.

88{this,"SPCache",""};

◆ m_SPCacheBackend

template<bool useCache>
Cache_BackendUpdateHandleKey ActsTrk::PixelSpacePointFormationAlgBase< useCache >::m_SPCacheBackend {this,"SPCacheBackend",""}
private

Definition at line 89 of file PixelSpacePointFormationAlgBase.h.

89{this,"SPCacheBackend",""};

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