ATLAS Offline Software
Loading...
Searching...
No Matches
ActsTrk::MaterialTrackReader Class Reference

Writes out RecordedMaterialTrackCollection to a root file. More...

#include <MaterialTrackReader.h>

Inheritance diagram for ActsTrk::MaterialTrackReader:
Collaboration diagram for ActsTrk::MaterialTrackReader:

Public Member Functions

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

std::mutex m_readMutex
 mutex used to protect multi-threaded reads
std::size_t m_events = 0
 The number of events.
std::size_t m_batchSize = 0
 The batch size (number of track per events)
Gaudi::Property< std::vector< std::string > > m_fileNames {this, "FileNames", {}, "The list of input file names"}
 The list of input filenames.
Gaudi::Property< std::string > m_treeName {this, "TreeName", "material-tracks", "The input tree name"}
 The name of the input tree.
Gaudi::Property< bool > m_readCachedSurfaceInformation {this, "ReadCachedSurface", false, "Read surface information for the root file"}
 Read surface information for the root file.
ActsPlugins::RootMaterialTrackIo m_accessor
 The read - write payload.
std::unique_ptr< TChain > m_inputChain ATLAS_THREAD_SAFE = {}
 The input chain of entries.
SG::WriteHandleKey< RecordedMaterialTrackCollectionm_materialTrackCollectionKey {this, "MaterialTrackCollectionKey", "InputMaterialTracks", "Name of the RecordedMaterialTrackCollection"}
 The RecordedMaterialTrackCollection to write.
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

Writes out RecordedMaterialTrackCollection to a root file.

It writes out a MaterialTrack which is usually generated from MaterialTrackRecorder G4UA

Definition at line 31 of file MaterialTrackReader.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

◆ MaterialTrackReader()

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

Definition at line 12 of file MaterialTrackReader.cxx.

12 :
13 AthReentrantAlgorithm(name, pSvcLocator),
15{}
ActsPlugins::RootMaterialTrackIo m_accessor
The read - write payload.
Gaudi::Property< bool > m_readCachedSurfaceInformation
Read surface information for the root file.

◆ ~MaterialTrackReader()

ActsTrk::MaterialTrackReader::~MaterialTrackReader ( )
virtual

Definition at line 17 of file MaterialTrackReader.cxx.

18{
19
20
21}

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

Definition at line 57 of file MaterialTrackReader.cxx.

58{
59 if (m_inputChain == nullptr) {
60 ATH_MSG_DEBUG("Invalid pointer to input chain");
61 return StatusCode::SUCCESS;
62 }
63
64 if (ctx.evt() >= m_events) {
65 ATH_MSG_INFO("Maximum number of events in file reached, nothing to be done...");
66 return StatusCode::SUCCESS;
67 }
68
69 // Write to the collection to the EventStore
70 SG::WriteHandle<ActsTrk::RecordedMaterialTrackCollection> materialTracks(m_materialTrackCollectionKey, ctx);
71
72 // Record the collection once per event if not already there
73 if (!materialTracks.isPresent()) {
74 auto coll = std::make_unique<ActsTrk::RecordedMaterialTrackCollection>();
75 ATH_CHECK(materialTracks.record(std::move(coll)));
76 }
77
78 // Add the track to the recorded collection
79 auto* coll = materialTracks.ptr();
80 if (!coll) {
81 ATH_MSG_ERROR("RecordedMaterialTrackCollection ptr() is null for key "
83 return StatusCode::FAILURE;
84 }
85
86 // lock the mutex
87 std::lock_guard<std::mutex> lock(m_readMutex);
88 for (std::size_t index = 0; index < m_batchSize; index++) {
89 // evaluate the entry number based on the batch size
90 auto entry = m_batchSize * ctx.evt() + index;
91
92 ATH_MSG_DEBUG("Reading event / entry (in batch) : " << ctx.evt() << " / " << entry << "(" << index << ")");
93
94 // get the correspoing entry and read it
95 m_inputChain->GetEntry(entry);
96 Acts::RecordedMaterialTrack rmTrack = m_accessor.read();
97
98 ATH_MSG_DEBUG("Track vertex: " << rmTrack.first.first);
99 ATH_MSG_DEBUG("Track momentum:" << rmTrack.first.second);
100
101 // filling the collection
102 coll->push_back(std::move(rmTrack));
103 }
104
105 return StatusCode::SUCCESS;
106
107}
#define ATH_CHECK
Evaluate an expression and check for errors.
#define ATH_MSG_ERROR(x)
#define ATH_MSG_INFO(x)
#define ATH_MSG_DEBUG(x)
std::mutex m_readMutex
mutex used to protect multi-threaded reads
std::size_t m_events
The number of events.
std::size_t m_batchSize
The batch size (number of track per events)
SG::WriteHandleKey< RecordedMaterialTrackCollection > m_materialTrackCollectionKey
The RecordedMaterialTrackCollection to write.
str index
Definition DeMoScan.py:362

◆ 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 ActsTrk::MaterialTrackReader::initialize ( )
overridevirtual

Definition at line 23 of file MaterialTrackReader.cxx.

24{
26
27 if (m_fileNames.empty()) {
28 ATH_MSG_ERROR("No input files given... Please check!!");
29 return StatusCode::FAILURE;
30 }
31
32 // set up the input chain
33 m_inputChain = std::make_unique<TChain>(m_treeName.value().c_str());
34
35 // loop over the input files
36 for (const auto& inputFile : m_fileNames) {
37 // add file to the input chain
38 m_inputChain->Add(inputFile.c_str());
39 ATH_MSG_DEBUG("Adding File " << inputFile << " to tree '" << m_treeName << "'.");
40 }
41
42 // Connect the branches
43 m_accessor.connectForRead(*m_inputChain);
44
45 // get the number of events, which also loads the tree
46 std::size_t nentries = m_inputChain->GetEntries();
47 m_events = static_cast<std::size_t>(m_inputChain->GetMaximum("event_id") + 1);
49
50 ATH_MSG_DEBUG("The full chain has " << nentries << " entries for " << m_events
51 << " events this corresponds to a batch size of: " << m_batchSize);
52
53 return StatusCode::SUCCESS;
54}
Gaudi::Property< std::vector< std::string > > m_fileNames
The list of input filenames.
Gaudi::Property< std::string > m_treeName
The name of the input tree.

◆ 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

◆ ATLAS_THREAD_SAFE

std::unique_ptr<TChain> m_inputChain ActsTrk::MaterialTrackReader::ATLAS_THREAD_SAFE = {}
private

The input chain of entries.

Definition at line 54 of file MaterialTrackReader.h.

54{};

◆ m_accessor

ActsPlugins::RootMaterialTrackIo ActsTrk::MaterialTrackReader::m_accessor
private

The read - write payload.

Definition at line 52 of file MaterialTrackReader.h.

◆ m_batchSize

std::size_t ActsTrk::MaterialTrackReader::m_batchSize = 0
private

The batch size (number of track per events)

Definition at line 44 of file MaterialTrackReader.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_events

std::size_t ActsTrk::MaterialTrackReader::m_events = 0
private

The number of events.

Definition at line 42 of file MaterialTrackReader.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_fileNames

Gaudi::Property<std::vector<std::string> > ActsTrk::MaterialTrackReader::m_fileNames {this, "FileNames", {}, "The list of input file names"}
private

The list of input filenames.

Definition at line 46 of file MaterialTrackReader.h.

46{this, "FileNames", {}, "The list of input file names"};

◆ m_materialTrackCollectionKey

SG::WriteHandleKey<RecordedMaterialTrackCollection> ActsTrk::MaterialTrackReader::m_materialTrackCollectionKey {this, "MaterialTrackCollectionKey", "InputMaterialTracks", "Name of the RecordedMaterialTrackCollection"}
private

The RecordedMaterialTrackCollection to write.

Definition at line 56 of file MaterialTrackReader.h.

56{this, "MaterialTrackCollectionKey", "InputMaterialTracks", "Name of the RecordedMaterialTrackCollection"};

◆ m_readCachedSurfaceInformation

Gaudi::Property<bool> ActsTrk::MaterialTrackReader::m_readCachedSurfaceInformation {this, "ReadCachedSurface", false, "Read surface information for the root file"}
private

Read surface information for the root file.

Definition at line 50 of file MaterialTrackReader.h.

50{this, "ReadCachedSurface", false, "Read surface information for the root file"};

◆ m_readMutex

std::mutex ActsTrk::MaterialTrackReader::m_readMutex
mutableprivate

mutex used to protect multi-threaded reads

Definition at line 40 of file MaterialTrackReader.h.

◆ m_treeName

Gaudi::Property<std::string> ActsTrk::MaterialTrackReader::m_treeName {this, "TreeName", "material-tracks", "The input tree name"}
private

The name of the input tree.

Definition at line 48 of file MaterialTrackReader.h.

48{this, "TreeName", "material-tracks", "The input tree name"};

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