ATLAS Offline Software
Loading...
Searching...
No Matches
FPGATrackSim::FPGATrackSimSeedingAlg Class Reference

#include <FPGATrackSimSeedingAlg.h>

Inheritance diagram for FPGATrackSim::FPGATrackSimSeedingAlg:
Collaboration diagram for FPGATrackSim::FPGATrackSimSeedingAlg:

Public Member Functions

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

Gaudi::Property< size_t > m_minSpacePointsPerSeed {this, "MinSpacePointsPerSeed", 3, "Minimum number of space points per seed"}
Gaudi::Property< size_t > m_maxSpacePointsPerSeed {this, "MaxSpacePointsPerSeed", 3, "Maximum number of space points per seed"}
SG::ReadHandleKey< FPGATrackSimTrackCollectionm_FPGATrackCollectionKey {this, "FPGATrackSimTrackKey","","FPGA Tracks 1st stage key"}
SG::ReadHandleKey< xAOD::PixelClusterContainerm_pixelClusterContainerKey {this, "FPGAPixelClustersKey", "", "Pixel Cluster Container"}
SG::ReadHandleKey< xAOD::SpacePointContainerm_spacePointContainerKey {this, "FPGASpacePointsKey", "", "Pixel Space Point Container"}
SG::WriteHandleKey< ActsTrk::SeedContainerm_seedKey {this,"OutputSeeds","","Output Seeds"}
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 FPGATrackSimSeedingAlg.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

◆ FPGATrackSimSeedingAlg()

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

Definition at line 10 of file FPGATrackSimSeedingAlg.cxx.

10 : AthReentrantAlgorithm(name, pSvcLocator) {
11}

◆ ~FPGATrackSimSeedingAlg()

virtual FPGATrackSim::FPGATrackSimSeedingAlg::~FPGATrackSimSeedingAlg ( )
virtualdefault

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

Definition at line 21 of file FPGATrackSimSeedingAlg.cxx.

21 {
22
23 SG::ReadHandle<FPGATrackSimTrackCollection> tracksHandle{m_FPGATrackCollectionKey, ctx};
24 SG::ReadHandle<xAOD::PixelClusterContainer> pixelClustersHandle{m_pixelClusterContainerKey, ctx};
25 SG::ReadHandle<xAOD::SpacePointContainer> spacePointsHandle{m_spacePointContainerKey, ctx};
26
27 ATH_CHECK(tracksHandle.isValid());
28 ATH_CHECK(pixelClustersHandle.isValid());
29 ATH_CHECK(spacePointsHandle.isValid());
30
31 SG::WriteHandle<ActsTrk::SeedContainer> seedHandle{m_seedKey, ctx};
32 ATH_CHECK(seedHandle.record(std::make_unique<ActsTrk::SeedContainer>()));
33 ActsTrk::SeedContainer* seeds = seedHandle.ptr();
34
35 // Use a map since identifiers are unique
36 std::map<Identifier::value_type, Acts::SpacePointIndex2> spacePointMap;
37 seeds->spacePoints().reserve(spacePointsHandle->size());
38
39 // Populate the map with pixel cluster identifier (rdoID) as key.
40 // Only space points with one measurement are considered (i.e. pixels). In case strips are needed the code should not be based on the one-measurement-per-space-point assumption.
41 for (const xAOD::SpacePoint* spacePoint : *spacePointsHandle) {
42 if (!spacePoint->measurements().empty()) {
43 seeds->spacePoints().push_back(spacePoint);
44 const auto identifier = spacePoint->measurements().at(0)->identifier();
45
46 // Check for duplicates (shouldn't happen if all works as expected)
47 auto [it, inserted] = spacePointMap.emplace(identifier, seeds->spacePoints().size()-1ul);
48 if (!inserted) {
49 ATH_MSG_ERROR("Duplicate identifier 0x" << std::hex << identifier << std::dec
50 << " found for space point. Keeping first occurrence.");
51 }
52 }
53 }
54
55 seeds->reserve(tracksHandle->size());
56 // loop over the tracks and make seeds based on the hits in FPGATrackSimTracks
57 for (const auto& track : *tracksHandle) {
58 std::vector<Acts::SpacePointIndex2> spacePointsToStoreInSeed;
59 for (const FPGATrackSimHit& hit : track.getFPGATrackSimHits()) {
60 if (hit.isReal() && hit.isPixel()) {
61 ATH_MSG_DEBUG("Hit coordinates in module " << hit.getRdoIdentifier()
62 << ": (" << hit.getPhiCoord() << ", " << hit.getEtaCoord() << ")");
63
64 // map lookup
65 auto it = spacePointMap.find(hit.getRdoIdentifier());
66 if (it != spacePointMap.end()) {
67 spacePointsToStoreInSeed.push_back(it->second);
68 } else {
69 ATH_MSG_ERROR("No SP found for hit identifier 0x"
70 << std::hex << hit.getRdoIdentifier() << std::dec);
71 }
72
73 // stop in case we reach the maximum number of space points allowed
74 if (spacePointsToStoreInSeed.size() == m_maxSpacePointsPerSeed) break;
75 }
76 }
77
78 // Construct seed based on the space points stored in the vector
79 if (spacePointsToStoreInSeed.size() >= m_minSpacePointsPerSeed) { // check that seeds contains at least the minimum number of desired space points
80 auto seed = seeds->push_back(spacePointsToStoreInSeed);
81 seed.vertexZ() = track.getZ0();
82 if (track.getChi2ndof() != 0.0) {
83 seed.quality() = 1.0 / track.getChi2ndof(); // TODO: validate if this is correct. (technically the larger the value, the better the quality of the seed)
84 } else {
85 seed.quality() = 0.0; // or another default value? TODO: check if that's fine
86 }
87 }
88 }
89
90 ATH_MSG_DEBUG("Recorded " << seeds->size() << " seeds");
91 return StatusCode::SUCCESS;
92 }
#define ATH_CHECK
Evaluate an expression and check for errors.
#define ATH_MSG_ERROR(x)
#define ATH_MSG_DEBUG(x)
SG::ReadHandleKey< xAOD::PixelClusterContainer > m_pixelClusterContainerKey
Gaudi::Property< size_t > m_maxSpacePointsPerSeed
SG::ReadHandleKey< FPGATrackSimTrackCollection > m_FPGATrackCollectionKey
SG::ReadHandleKey< xAOD::SpacePointContainer > m_spacePointContainerKey
Gaudi::Property< size_t > m_minSpacePointsPerSeed
SG::WriteHandleKey< ActsTrk::SeedContainer > m_seedKey
virtual bool isValid() override final
Can the handle be successfully dereferenced?
StatusCode record(std::unique_ptr< T > data)
Record a const object to the store.
pointer_type ptr()
Dereference the pointer.
Acts::MutableSeedProxy2 push_back(Acts::SpacePointIndexSubset2 sp)
const SpacePointContainer & spacePoints() const noexcept

◆ 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

◆ initialize()

StatusCode FPGATrackSim::FPGATrackSimSeedingAlg::initialize ( )
finaloverridevirtual

Definition at line 12 of file FPGATrackSimSeedingAlg.cxx.

12 {
16 ATH_CHECK(m_seedKey.initialize());
17
18 return StatusCode::SUCCESS;
19 }

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

SG::ReadHandleKey<FPGATrackSimTrackCollection> FPGATrackSim::FPGATrackSimSeedingAlg::m_FPGATrackCollectionKey {this, "FPGATrackSimTrackKey","","FPGA Tracks 1st stage key"}
private

Definition at line 40 of file FPGATrackSimSeedingAlg.h.

40{this, "FPGATrackSimTrackKey","","FPGA Tracks 1st stage key"};

◆ m_maxSpacePointsPerSeed

Gaudi::Property<size_t> FPGATrackSim::FPGATrackSimSeedingAlg::m_maxSpacePointsPerSeed {this, "MaxSpacePointsPerSeed", 3, "Maximum number of space points per seed"}
private

Definition at line 37 of file FPGATrackSimSeedingAlg.h.

37{this, "MaxSpacePointsPerSeed", 3, "Maximum number of space points per seed"};

◆ m_minSpacePointsPerSeed

Gaudi::Property<size_t> FPGATrackSim::FPGATrackSimSeedingAlg::m_minSpacePointsPerSeed {this, "MinSpacePointsPerSeed", 3, "Minimum number of space points per seed"}
private

Definition at line 36 of file FPGATrackSimSeedingAlg.h.

36{this, "MinSpacePointsPerSeed", 3, "Minimum number of space points per seed"};

◆ m_pixelClusterContainerKey

SG::ReadHandleKey<xAOD::PixelClusterContainer> FPGATrackSim::FPGATrackSimSeedingAlg::m_pixelClusterContainerKey {this, "FPGAPixelClustersKey", "", "Pixel Cluster Container"}
private

Definition at line 41 of file FPGATrackSimSeedingAlg.h.

41{this, "FPGAPixelClustersKey", "", "Pixel Cluster Container"};

◆ m_seedKey

SG::WriteHandleKey< ActsTrk::SeedContainer > FPGATrackSim::FPGATrackSimSeedingAlg::m_seedKey {this,"OutputSeeds","","Output Seeds"}
private

Definition at line 45 of file FPGATrackSimSeedingAlg.h.

45{this,"OutputSeeds","","Output Seeds"};

◆ m_spacePointContainerKey

SG::ReadHandleKey<xAOD::SpacePointContainer> FPGATrackSim::FPGATrackSimSeedingAlg::m_spacePointContainerKey {this, "FPGASpacePointsKey", "", "Pixel Space Point Container"}
private

Definition at line 42 of file FPGATrackSimSeedingAlg.h.

42{this, "FPGASpacePointsKey", "", "Pixel Space Point 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: