ATLAS Offline Software
Loading...
Searching...
No Matches
ThinInDetForwardTrackParticlesAlg Class Referencefinal

#include <ThinInDetForwardTrackParticlesAlg.h>

Inheritance diagram for ThinInDetForwardTrackParticlesAlg:
Collaboration diagram for ThinInDetForwardTrackParticlesAlg:

Public Member Functions

 ThinInDetForwardTrackParticlesAlg (const std::string &name, ISvcLocator *pSvcLocator)
 Constructor with parameters:
virtual ~ThinInDetForwardTrackParticlesAlg ()=default
 Destructor:
virtual StatusCode initialize () override
 Athena algorithm's initalize hook.
virtual StatusCode execute (const EventContext &ctx) const override
 Athena algorithm's execute hook.
virtual StatusCode finalize () override
 Athena algorithm's finalize hook.
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

StringProperty m_streamName
SG::ThinningHandleKey< xAOD::TrackParticleContainerm_tracksKey
SG::ReadHandleKey< xAOD::MuonContainerm_muonsKey { this, "MuonsKey", "Muons", "Muons to use for thinning" }
BooleanProperty m_doThinning
 Should the thinning run?
std::atomic< unsigned long > m_nEventsProcessed {}
 Counters.
std::atomic< unsigned long > m_nTracksProcessed {}
std::atomic< unsigned long > m_nTracksThinned {}
std::atomic< unsigned long > m_nMuons {}
std::atomic< unsigned long > m_nSiFwdMuons {}
std::atomic< unsigned long > m_nSiFwdAssoc {}
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 27 of file ThinInDetForwardTrackParticlesAlg.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

◆ ThinInDetForwardTrackParticlesAlg()

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

Constructor with parameters:

Definition at line 36 of file ThinInDetForwardTrackParticlesAlg.cxx.

39 : AthReentrantAlgorithm(name, pSvcLocator)
40{
41}

◆ ~ThinInDetForwardTrackParticlesAlg()

virtual ThinInDetForwardTrackParticlesAlg::~ThinInDetForwardTrackParticlesAlg ( )
virtualdefault

Destructor:

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.

62{
63 return 0;
64}

◆ 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 ThinInDetForwardTrackParticlesAlg::execute ( const EventContext & ctx) const
overridevirtual

Athena algorithm's execute hook.

Definition at line 87 of file ThinInDetForwardTrackParticlesAlg.cxx.

88{
89 // Increase the event counter
90 m_nEventsProcessed.fetch_add(1, std::memory_order_relaxed);
91
92 // Is truth thinning required?
93 if (!m_doThinning) {
94 return StatusCode::SUCCESS;
95 }
96
97 // Retrieve InDetForwardTrackParticles container
98 SG::ThinningHandle<xAOD::TrackParticleContainer> tracks(m_tracksKey, ctx);
99
100 // Set up mask and set the main counters
101 std::vector<bool> trackMask;
102 unsigned int nTracks = tracks->size();
103 m_nTracksProcessed.fetch_add(nTracks, std::memory_order_relaxed);
104 trackMask.assign(nTracks, false);
105
106 unsigned int nSiFwdAssoc = 0;
107 unsigned int nSiFwdMuons = 0;
108
109 // Loop over the muons. Identify which are SiliconAssociatedForwardMuon.
110 // Get their associated inner detector track. Find that track in the
111 // InDetForwardTrackParticles. Set the mask element.
112 // Only if muons are provided as inputs
113
114 if(!m_muonsKey.empty()){
115 SG::ReadHandle<xAOD::MuonContainer> muons(m_muonsKey, ctx);
116 m_nMuons.fetch_add(muons->size(), std::memory_order_relaxed);
117
118 for (const auto* muon : *muons) {
119 if (muon->muonType() == xAOD::Muon::SiliconAssociatedForwardMuon) {
120 ++nSiFwdMuons;
121 const xAOD::TrackParticle* muTrk(nullptr);
122 if (muon->inDetTrackParticleLink().isValid())
123 muTrk = *(muon->inDetTrackParticleLink());
124 if (muTrk != nullptr) {
125 auto search = std::find(tracks->begin(), tracks->end(), muTrk);
126 if (search != tracks->end()) {
127 ++nSiFwdAssoc;
128 trackMask[(*search)->index()] = true;
129 }
130 }
131 }
132 }
133 }
134
135 m_nSiFwdAssoc.fetch_add(nSiFwdAssoc, std::memory_order_relaxed);
136 m_nSiFwdMuons.fetch_add(nSiFwdMuons, std::memory_order_relaxed);
137
138 // Increment counters
139 unsigned int nTracksThinned = 0;
140 for (unsigned int i = 0; i < nTracks; ++i) {
141 if (!trackMask[i])
142 ++nTracksThinned;
143 }
144 m_nTracksThinned.fetch_add(nTracksThinned, std::memory_order_relaxed);
145 // Apply masks to thinning service
146 tracks.keep(trackMask);
147
148 return StatusCode::SUCCESS;
149}
std::atomic< unsigned long > m_nEventsProcessed
Counters.
SG::ThinningHandleKey< xAOD::TrackParticleContainer > m_tracksKey
SG::ReadHandleKey< xAOD::MuonContainer > m_muonsKey
BooleanProperty m_doThinning
Should the thinning run?
void search(TDirectory *td, const std::string &s, std::string cwd, node *n)
recursive directory search for TH1 and TH2 and TProfiles
Definition hcg.cxx:743
TrackParticle_v1 TrackParticle
Reference the current persistent version:

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

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

◆ filterPassed()

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

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

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

◆ finalize()

StatusCode ThinInDetForwardTrackParticlesAlg::finalize ( )
overridevirtual

Athena algorithm's finalize hook.

Definition at line 72 of file ThinInDetForwardTrackParticlesAlg.cxx.

73{
74 ATH_MSG_DEBUG("Finalizing " << name() << "...");
75 ATH_MSG_INFO("Processed " << m_nEventsProcessed << " events containing: ");
76 ATH_MSG_INFO(" " << m_nTracksProcessed << " InDetForwardTrackParticles");
77 ATH_MSG_INFO(" " << m_nMuons << " muons of which " << m_nSiFwdMuons
78 << " were SiliconAssociatedForward muons");
80 << " of the SiliconAssociatedForward muons were "
81 "associated with InDetForwardTrackParticles");
82 ATH_MSG_INFO("Removed " << m_nTracksThinned << " InDetForwardTrackParticles");
83 return StatusCode::SUCCESS;
84}
#define ATH_MSG_INFO(x)
#define ATH_MSG_DEBUG(x)

◆ initialize()

StatusCode ThinInDetForwardTrackParticlesAlg::initialize ( )
overridevirtual

Athena algorithm's initalize hook.

Definition at line 46 of file ThinInDetForwardTrackParticlesAlg.cxx.

47{
48 ATH_MSG_DEBUG("Initializing " << name() << "...");
49
50 // Print out the used configuration
51 ATH_MSG_DEBUG(" using = " << m_streamName);
52
53 // Is truth thinning required?
54 if (!m_doThinning) {
55 ATH_MSG_INFO("InDetForwardTrackParticles thinning not required");
56 } else {
57 ATH_MSG_INFO("InDetForwardTrackParticles will be thinned");
58 }
59
60 if (m_doThinning && m_streamName.empty()) {
61 ATH_MSG_ERROR("StreamName property was not initialized.");
62 return StatusCode::FAILURE;
63 }
65 ATH_CHECK(m_muonsKey.initialize(m_doThinning && !m_muonsKey.empty()));
66 ATH_MSG_DEBUG("==> done with initialize " << name() << "...");
67
68 return StatusCode::SUCCESS;
69}
#define ATH_CHECK
Evaluate an expression and check for errors.
#define ATH_MSG_ERROR(x)

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

75{
76 return BaseAlg::sysExecute (ctx);
77}

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

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

BooleanProperty ThinInDetForwardTrackParticlesAlg::m_doThinning
private
Initial value:
{
this,
"ThinInDetForwardTrackParticles",
true,
"Should the InDetForwardTrackParticles thinning be run?"
}

Should the thinning run?

Definition at line 63 of file ThinInDetForwardTrackParticlesAlg.h.

63 {
64 this,
65 "ThinInDetForwardTrackParticles",
66 true,
67 "Should the InDetForwardTrackParticles thinning be run?"
68 };

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

SG::ReadHandleKey<xAOD::MuonContainer> ThinInDetForwardTrackParticlesAlg::m_muonsKey { this, "MuonsKey", "Muons", "Muons to use for thinning" }
private

Definition at line 60 of file ThinInDetForwardTrackParticlesAlg.h.

60{ this, "MuonsKey", "Muons", "Muons to use for thinning" };

◆ m_nEventsProcessed

std::atomic<unsigned long> ThinInDetForwardTrackParticlesAlg::m_nEventsProcessed {}
mutableprivate

Counters.

Definition at line 71 of file ThinInDetForwardTrackParticlesAlg.h.

71{};

◆ m_nMuons

std::atomic<unsigned long> ThinInDetForwardTrackParticlesAlg::m_nMuons {}
mutableprivate

Definition at line 74 of file ThinInDetForwardTrackParticlesAlg.h.

74{};

◆ m_nSiFwdAssoc

std::atomic<unsigned long> ThinInDetForwardTrackParticlesAlg::m_nSiFwdAssoc {}
mutableprivate

Definition at line 76 of file ThinInDetForwardTrackParticlesAlg.h.

76{};

◆ m_nSiFwdMuons

std::atomic<unsigned long> ThinInDetForwardTrackParticlesAlg::m_nSiFwdMuons {}
mutableprivate

Definition at line 75 of file ThinInDetForwardTrackParticlesAlg.h.

75{};

◆ m_nTracksProcessed

std::atomic<unsigned long> ThinInDetForwardTrackParticlesAlg::m_nTracksProcessed {}
mutableprivate

Definition at line 72 of file ThinInDetForwardTrackParticlesAlg.h.

72{};

◆ m_nTracksThinned

std::atomic<unsigned long> ThinInDetForwardTrackParticlesAlg::m_nTracksThinned {}
mutableprivate

Definition at line 73 of file ThinInDetForwardTrackParticlesAlg.h.

73{};

◆ m_streamName

StringProperty ThinInDetForwardTrackParticlesAlg::m_streamName
private
Initial value:
{ this,
"StreamName",
"",
"Stream for which to thin" }

Definition at line 47 of file ThinInDetForwardTrackParticlesAlg.h.

47 { this,
48 "StreamName",
49 "",
50 "Stream for which to thin" };

◆ m_tracksKey

SG::ThinningHandleKey<xAOD::TrackParticleContainer> ThinInDetForwardTrackParticlesAlg::m_tracksKey
private
Initial value:
{
this,
"TracksKey",
"InDetForwardTrackParticles",
"Tracks to thin"
}

Definition at line 52 of file ThinInDetForwardTrackParticlesAlg.h.

52 {
53 this,
54 "TracksKey",
55 "InDetForwardTrackParticles",
56 "Tracks to thin"
57 };

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