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

Reads the MaterialTracks and produces the material maps for the Tracking Geometry. More...

#include <MaterialValidation.h>

Inheritance diagram for ActsTrk::MaterialValidation:
Collaboration diagram for ActsTrk::MaterialValidation:

Public Member Functions

 MaterialValidation (const std::string &name, ISvcLocator *pSvcLocator)
virtual StatusCode initialize () override
virtual StatusCode execute (const EventContext &ctx) const override
virtual ~MaterialValidation ()
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::shared_ptr< Acts::MaterialValidater > m_materialValidater
 The material validater from the ACTS core components.
ServiceHandle< IAthRNGSvcm_rndmGenSvc {this, "AthRNGSvc", "AthRNGSvc", "The random number service"}
 The random number service.
Gaudi::Property< size_t > m_nTracks {this, "NumberOfTracks", 1000, "Number of tracks to use per event"}
 The number of tracks to use per event.
Gaudi::Property< std::pair< double, double > > m_etaRange {this, "EtaRange", {-4.5, 4.5}, "The eta range for tracks"}
 The eta range for track generation.
ServiceHandle< ActsTrk::ITrackingGeometrySvcm_trackingGeometrySvc {this, "TrackingGeometrySvc","ActsTrackingGeometrySvc", "The ACTS geometry service for the geometry context"}
 The tracking geometry service to retrive the geometry context and material surfaces.
SG::WriteHandleKey< RecordedMaterialTrackCollectionm_materialTrackCollectionKey {this, "MaterialTrackCollectionKey", "OutputMaterialTracks", "Name of the output 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

Reads the MaterialTracks and produces the material maps for the Tracking Geometry.

The output map is stored in a ROOT file, json, etc. depending on the configured writers.

Definition at line 27 of file Acts/ActsMaterial/src/MaterialValidation.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

◆ MaterialValidation()

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

Definition at line 13 of file Acts/ActsMaterial/src/MaterialValidation.cxx.

13 :
14 AthReentrantAlgorithm(name, pSvcLocator)
15{}

◆ ~MaterialValidation()

ActsTrk::MaterialValidation::~MaterialValidation ( )
virtual

Definition at line 17 of file Acts/ActsMaterial/src/MaterialValidation.cxx.

18{}

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

Definition at line 55 of file Acts/ActsMaterial/src/MaterialValidation.cxx.

56{
57 // Write to the collection to the EventStore
58 SG::WriteHandle<ActsTrk::RecordedMaterialTrackCollection> materialTracks(m_materialTrackCollectionKey, ctx);
59
60 // Record the collection once per event if not already there
61 if (!materialTracks.isPresent()) {
62 auto coll = std::make_unique<ActsTrk::RecordedMaterialTrackCollection>();
63 ATH_CHECK(materialTracks.record(std::move(coll)));
64 }
65
66 // Add the track to the recorded collection
67 auto* coll = materialTracks.ptr();
68 if (!coll) {
69 ATH_MSG_ERROR("RecordedMaterialTrackCollection ptr() is null for key "
71 return StatusCode::FAILURE;
72 }
73
74 // Some useful parameters to be used later
75 Acts::Vector3 startPosition(0., 0., 0.);
76 const ActsTrk::GeometryContext& geoContext{m_trackingGeometrySvc->getNominalContext()};
77 Acts::MagneticFieldContext magFieldContext;
78
79 ATHRNG::RNGWrapper *wrapper = m_rndmGenSvc->getEngine(this);
80 wrapper->setSeed(name(), ctx);
81 CLHEP::HepRandomEngine *rndmEngine = wrapper->getEngine(ctx);
82
83 // Loop over the number of tracks
84 for (std::size_t iTrack = 0; iTrack < m_nTracks; ++iTrack) {
85 // Generate a random phi and eta
86 double phi = rndmEngine->flat() * 2 * M_PI - M_PI;
87 double eta = rndmEngine->flat() * std::abs(m_etaRange.value().second - m_etaRange.value().first) + m_etaRange.value().first;
88 double theta = 2 * std::atan(std::exp(-eta));
89 Acts::Vector3 direction(std::cos(phi) * std::sin(theta),
90 std::sin(phi) * std::sin(theta), std::cos(theta));
91
92 // Record the material
93 auto rmTrack = m_materialValidater->recordMaterial(geoContext.context(),
94 magFieldContext,
95 startPosition,
96 direction);
97
98 // filling the collection
99 coll->push_back(std::move(rmTrack));
100
101 }
102
103 return StatusCode::SUCCESS;
104
105}
#define M_PI
Scalar eta() const
pseudorapidity method
Scalar phi() const
phi method
Scalar theta() const
theta method
#define ATH_CHECK
Evaluate an expression and check for errors.
#define ATH_MSG_ERROR(x)
void setSeed(const std::string &algName, const EventContext &ctx)
Set the random seed using a string (e.g.
Definition RNGWrapper.h:169
CLHEP::HepRandomEngine * getEngine(const EventContext &ctx) const
Retrieve the random engine corresponding to the provided EventContext.
Definition RNGWrapper.h:134
Acts::GeometryContext context() const
ServiceHandle< IAthRNGSvc > m_rndmGenSvc
The random number service.
SG::WriteHandleKey< RecordedMaterialTrackCollection > m_materialTrackCollectionKey
The RecordedMaterialTrackCollection to write.
Gaudi::Property< std::pair< double, double > > m_etaRange
The eta range for track generation.
ServiceHandle< ActsTrk::ITrackingGeometrySvc > m_trackingGeometrySvc
The tracking geometry service to retrive the geometry context and material surfaces.
std::shared_ptr< Acts::MaterialValidater > m_materialValidater
The material validater from the ACTS core components.
Gaudi::Property< size_t > m_nTracks
The number of tracks to use per event.

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

The material validater

Definition at line 20 of file Acts/ActsMaterial/src/MaterialValidation.cxx.

21{
23 ATH_CHECK(m_rndmGenSvc.retrieve());
25
26 // Retrieve the material surfaces
27 std::vector<const Acts::Surface*> materialSurfaces = {};
28
29 auto surfaceSelector = [&](const Acts::Surface* surface) {
30 if (surface->surfaceMaterial() != nullptr &&
31 std::ranges::find(materialSurfaces, surface) == materialSurfaces.end()) {
32 materialSurfaces.push_back(surface);
33 }
34 };
35
36 // Visit all surfaces (second argument = if true only sensitive surfaces are visited)
37 m_trackingGeometrySvc->trackingGeometry()->visitSurfaces(surfaceSelector, false);
38
39 // The material intersection assigner
40 Acts::IntersectionMaterialAssigner::Config assingerConfig;
41 assingerConfig.surfaces = materialSurfaces;
42 auto materialAssigner = std::make_shared<Acts::IntersectionMaterialAssigner>(assingerConfig,
43 makeActsAthenaLogger(this, "MaterialAssigner"));
44
46 Acts::MaterialValidater::Config validaterConfig;
47 validaterConfig.materialAssigner = materialAssigner;
48 m_materialValidater = std::make_shared<Acts::MaterialValidater> (validaterConfig,
49 makeActsAthenaLogger(this, "MaterialValidater"));
50
51 return StatusCode::SUCCESS;
52}
std::unique_ptr< const Acts::Logger > makeActsAthenaLogger(IMessageSvc *svc, const std::string &name, int level, std::optional< std::string > parent_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

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

Gaudi::Property<std::pair<double, double> > ActsTrk::MaterialValidation::m_etaRange {this, "EtaRange", {-4.5, 4.5}, "The eta range for tracks"}
private

The eta range for track generation.

Definition at line 42 of file Acts/ActsMaterial/src/MaterialValidation.h.

42{this, "EtaRange", {-4.5, 4.5}, "The eta range for tracks"};

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

SG::WriteHandleKey<RecordedMaterialTrackCollection> ActsTrk::MaterialValidation::m_materialTrackCollectionKey {this, "MaterialTrackCollectionKey", "OutputMaterialTracks", "Name of the output RecordedMaterialTrackCollection"}
private

The RecordedMaterialTrackCollection to write.

Definition at line 48 of file Acts/ActsMaterial/src/MaterialValidation.h.

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

◆ m_materialValidater

std::shared_ptr<Acts::MaterialValidater> ActsTrk::MaterialValidation::m_materialValidater
private

The material validater from the ACTS core components.

Definition at line 36 of file Acts/ActsMaterial/src/MaterialValidation.h.

◆ m_nTracks

Gaudi::Property<size_t> ActsTrk::MaterialValidation::m_nTracks {this, "NumberOfTracks", 1000, "Number of tracks to use per event"}
private

The number of tracks to use per event.

Definition at line 40 of file Acts/ActsMaterial/src/MaterialValidation.h.

40{this, "NumberOfTracks", 1000, "Number of tracks to use per event"};

◆ m_rndmGenSvc

ServiceHandle<IAthRNGSvc> ActsTrk::MaterialValidation::m_rndmGenSvc {this, "AthRNGSvc", "AthRNGSvc", "The random number service"}
private

The random number service.

Definition at line 38 of file Acts/ActsMaterial/src/MaterialValidation.h.

38{this, "AthRNGSvc", "AthRNGSvc", "The random number service"};

◆ m_trackingGeometrySvc

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

The tracking geometry service to retrive the geometry context and material surfaces.

Definition at line 45 of file Acts/ActsMaterial/src/MaterialValidation.h.

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

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