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

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

#include <MaterialTrackWriter.h>

Inheritance diagram for ActsTrk::MaterialTrackWriter:
Collaboration diagram for ActsTrk::MaterialTrackWriter:

Public Member Functions

 MaterialTrackWriter (const std::string &name, ISvcLocator *pSvcLocator)
virtual StatusCode initialize () override
virtual StatusCode execute (const EventContext &ctx) const override
virtual StatusCode finalize () override
virtual ~MaterialTrackWriter ()
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_writeMutex
 mutex used to protect multi-threaded writes
Gaudi::Property< std::string > m_fileName {this, "FileName", "MaterialTracks.root", "The output file name"}
 The output file name.
Gaudi::Property< std::string > m_treeName {this, "TreeName", "material-tracks", "The output tree name"}
 The output file name.
Gaudi::Property< bool > m_storeSurface {this, "StoreSurface", false, "Write the surface to which the material step correpond"}
 Write the surface to which the material step correpond.
Gaudi::Property< bool > m_storeVolume {this, "StoreVolume", false, "Write the volume to which the material step correpond"}
 Write the volume to which the material step correpond.
Gaudi::Property< bool > m_prePostStep {this, "PrePostStep", false, "Write out pre and post step (for G4), otherwise central step position"}
 Write out pre and post step (for G4), otherwise central step position.
Gaudi::Property< bool > m_recalculateTotals {this, "RecalculateTotals", false, "Re-calculate total values from individual steps (for cross-checks)"}
 Re-calculate total values from individual steps (for cross-checks)
SG::ReadHandleKey< RecordedMaterialTrackCollectionm_materialTrackCollectionKey {this, "MaterialTrackCollectionKey", "OutputMaterialTracks", "Name of the RecordedMaterialTrackCollection"}
 The RecordedMaterialTrackCollection to read.
ServiceHandle< ActsTrk::ITrackingGeometrySvcm_trackingGeometrySvc {this, "TrackingGeometrySvc","ActsTrackingGeometrySvc", "The ACTS geometry service for the geometry context"}
 The tracking geometry service to retrive the geometry context.
ActsPlugins::RootMaterialTrackIo m_accessor ATLAS_THREAD_SAFE
 The read - write payload.
TFile * m_outputFile {}
 The output file and tree.
TTree *m_outputTree ATLAS_THREAD_SAFE = {}
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 32 of file MaterialTrackWriter.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

◆ MaterialTrackWriter()

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

Definition at line 13 of file MaterialTrackWriter.cxx.

13 :
14 AthReentrantAlgorithm(name, pSvcLocator),
16{}
Gaudi::Property< bool > m_recalculateTotals
Re-calculate total values from individual steps (for cross-checks)
Gaudi::Property< bool > m_storeVolume
Write the volume to which the material step correpond.
Gaudi::Property< bool > m_storeSurface
Write the surface to which the material step correpond.
Gaudi::Property< bool > m_prePostStep
Write out pre and post step (for G4), otherwise central step position.

◆ ~MaterialTrackWriter()

ActsTrk::MaterialTrackWriter::~MaterialTrackWriter ( )
virtual

Definition at line 18 of file MaterialTrackWriter.cxx.

19{
20 if (m_outputFile != nullptr)
21 m_outputFile->Close();
22}
TFile * m_outputFile
The output file and tree.

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

Definition at line 63 of file MaterialTrackWriter.cxx.

64{
65 // Get the collection from storegate
66 SG::ReadHandle<ActsTrk::RecordedMaterialTrackCollection> materialTracks(m_materialTrackCollectionKey, ctx);
67 if (!materialTracks.isValid()) {
68 ATH_MSG_ERROR("Failed to read " << m_materialTrackCollectionKey.key());
69 return StatusCode::FAILURE;
70 }
71
72 const ActsTrk::GeometryContext& geoContext{m_trackingGeometrySvc->getNominalContext()};
73
74 std::lock_guard<std::mutex> lock(m_writeMutex);
75
76 // Loop over the material tracks and write them out
77 for (const auto& materialTrack : *materialTracks) {
78 // write & fill
79 m_accessor.write(geoContext.context(), ctx.evt(), materialTrack);
80 m_outputTree->Fill();
81 }
82
83 // return success
84 return StatusCode::SUCCESS;
85}
#define ATH_MSG_ERROR(x)
Acts::GeometryContext context() const
SG::ReadHandleKey< RecordedMaterialTrackCollection > m_materialTrackCollectionKey
The RecordedMaterialTrackCollection to read.
std::mutex m_writeMutex
mutex used to protect multi-threaded writes
ServiceHandle< ActsTrk::ITrackingGeometrySvc > m_trackingGeometrySvc
The tracking geometry service to retrive the geometry context.

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

StatusCode ActsTrk::MaterialTrackWriter::finalize ( )
overridevirtual

Definition at line 50 of file MaterialTrackWriter.cxx.

51{
52 // write the tree and close the file
53 ATH_MSG_INFO("Writing ROOT output File : " << m_outputFile);
54
55 m_outputFile->cd();
56 m_outputTree->Write();
57 m_outputFile->Close();
58
59 return StatusCode::SUCCESS;
60}
#define ATH_MSG_INFO(x)

◆ initialize()

StatusCode ActsTrk::MaterialTrackWriter::initialize ( )
overridevirtual

Definition at line 24 of file MaterialTrackWriter.cxx.

25{
26 // Check the input collection key
28
29 // Setup ROOT I/O
30 m_outputFile = TFile::Open(m_fileName.value().c_str(), "RECREATE");
31 if (m_outputFile == nullptr) {
32 ATH_MSG_ERROR("Could not open '" + m_fileName + "'");
33 return StatusCode::FAILURE;
34 }
35
36 m_outputFile->cd();
37 m_outputTree =
38 new TTree(m_treeName.value().c_str(), "TTree from MaterialTrackWriter");
39 if (m_outputTree == nullptr) {
40 ATH_MSG_ERROR("Could not create TTree '" + m_treeName + "'");
41 return StatusCode::FAILURE;
42 }
43
44 // Connect the branches
45 m_accessor.connectForWrite(*m_outputTree);
46
47 return StatusCode::SUCCESS;
48}
#define ATH_CHECK
Evaluate an expression and check for errors.
Gaudi::Property< std::string > m_treeName
The output file name.
Gaudi::Property< std::string > m_fileName
The output file name.

◆ 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 [1/2]

ActsPlugins::RootMaterialTrackIo m_accessor ActsTrk::MaterialTrackWriter::ATLAS_THREAD_SAFE
mutableprivate

The read - write payload.

Definition at line 62 of file MaterialTrackWriter.h.

◆ ATLAS_THREAD_SAFE [2/2]

TTree* m_outputTree ActsTrk::MaterialTrackWriter::ATLAS_THREAD_SAFE = {}
mutableprivate

Definition at line 65 of file MaterialTrackWriter.h.

65{};

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

Gaudi::Property<std::string> ActsTrk::MaterialTrackWriter::m_fileName {this, "FileName", "MaterialTracks.root", "The output file name"}
private

The output file name.

Definition at line 44 of file MaterialTrackWriter.h.

44{this, "FileName", "MaterialTracks.root", "The output file name"};

◆ m_materialTrackCollectionKey

SG::ReadHandleKey<RecordedMaterialTrackCollection> ActsTrk::MaterialTrackWriter::m_materialTrackCollectionKey {this, "MaterialTrackCollectionKey", "OutputMaterialTracks", "Name of the RecordedMaterialTrackCollection"}
private

The RecordedMaterialTrackCollection to read.

Definition at line 57 of file MaterialTrackWriter.h.

57{this, "MaterialTrackCollectionKey", "OutputMaterialTracks", "Name of the RecordedMaterialTrackCollection"};

◆ m_outputFile

TFile* ActsTrk::MaterialTrackWriter::m_outputFile {}
private

The output file and tree.

Definition at line 64 of file MaterialTrackWriter.h.

64{};

◆ m_prePostStep

Gaudi::Property<bool> ActsTrk::MaterialTrackWriter::m_prePostStep {this, "PrePostStep", false, "Write out pre and post step (for G4), otherwise central step position"}
private

Write out pre and post step (for G4), otherwise central step position.

Definition at line 52 of file MaterialTrackWriter.h.

52{this, "PrePostStep", false, "Write out pre and post step (for G4), otherwise central step position"};

◆ m_recalculateTotals

Gaudi::Property<bool> ActsTrk::MaterialTrackWriter::m_recalculateTotals {this, "RecalculateTotals", false, "Re-calculate total values from individual steps (for cross-checks)"}
private

Re-calculate total values from individual steps (for cross-checks)

Definition at line 54 of file MaterialTrackWriter.h.

54{this, "RecalculateTotals", false, "Re-calculate total values from individual steps (for cross-checks)"};

◆ m_storeSurface

Gaudi::Property<bool> ActsTrk::MaterialTrackWriter::m_storeSurface {this, "StoreSurface", false, "Write the surface to which the material step correpond"}
private

Write the surface to which the material step correpond.

Definition at line 48 of file MaterialTrackWriter.h.

48{this, "StoreSurface", false, "Write the surface to which the material step correpond"};

◆ m_storeVolume

Gaudi::Property<bool> ActsTrk::MaterialTrackWriter::m_storeVolume {this, "StoreVolume", false, "Write the volume to which the material step correpond"}
private

Write the volume to which the material step correpond.

Definition at line 50 of file MaterialTrackWriter.h.

50{this, "StoreVolume", false, "Write the volume to which the material step correpond"};

◆ m_trackingGeometrySvc

ServiceHandle<ActsTrk::ITrackingGeometrySvc> ActsTrk::MaterialTrackWriter::m_trackingGeometrySvc {this, "TrackingGeometrySvc","ActsTrackingGeometrySvc", "The ACTS geometry service for the geometry context"}
private

The tracking geometry service to retrive the geometry context.

Definition at line 60 of file MaterialTrackWriter.h.

60{this, "TrackingGeometrySvc","ActsTrackingGeometrySvc", "The ACTS geometry service for the geometry context"};

◆ m_treeName

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

The output file name.

Definition at line 46 of file MaterialTrackWriter.h.

46{this, "TreeName", "material-tracks", "The output 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.

◆ m_writeMutex

std::mutex ActsTrk::MaterialTrackWriter::m_writeMutex
mutableprivate

mutex used to protect multi-threaded writes

Definition at line 42 of file MaterialTrackWriter.h.


The documentation for this class was generated from the following files: