ATLAS Offline Software
Loading...
Searching...
No Matches
ITkPixFieldMapsAlg Class Reference

#include <ITkPixFieldMapsAlg.h>

Inheritance diagram for ITkPixFieldMapsAlg:
Collaboration diagram for ITkPixFieldMapsAlg:

Public Member Functions

 ITkPixFieldMapsAlg (const std::string &name, ISvcLocator *pSvcLocator)
virtual StatusCode initialize () override
virtual StatusCode execute (const EventContext &ctx) const override
virtual bool isReEntrant () const override
 Avoid scheduling algorithm multiple times.
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< std::string > m_efieldFilePath {this, "EFieldFilePath", "PixelDigitization/maps_IBL_PL_80V_fl0e14.root", "File path for EField files"}
SG::WriteCondHandleKey< ITkPixFieldMapsm_writeFieldMapKey {this, "ITkPixFieldMapsKey", "ITkPixFieldMapsKey", "Output key for efield data"}
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 19 of file ITkPixFieldMapsAlg.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

◆ ITkPixFieldMapsAlg()

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

Definition at line 31 of file ITkPixFieldMapsAlg.cxx.

31 :
32 ::AthCondAlgorithm(name, pSvcLocator)
33{
34}

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

Definition at line 136 of file ITkPixFieldMapsAlg.cxx.

136 {
137 ATH_MSG_DEBUG("ITkPixFieldMapsAlg::execute()");
138
139
140 return StatusCode::SUCCESS;
141}
#define ATH_MSG_DEBUG(x)

◆ 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

◆ initialize()

StatusCode ITkPixFieldMapsAlg::initialize ( )
overridevirtual

Definition at line 36 of file ITkPixFieldMapsAlg.cxx.

36 {
37 ATH_MSG_DEBUG("ITkPixFieldMapsAlg::initialize()");
38 ATH_CHECK(m_writeFieldMapKey.initialize());
39 EventContext ctx;
40 //we need a context eventually, and the following will all be in 'execute'
41 //right now, this section is redundant; however by doing it in initialize, we only open
42 //the file and read the data once for all events
46 EventIDBase eidRun1 (runNumber, eventNumber, timeStamp);
47 ctx.setEventID (eidRun1);
48 //
49 SG::WriteCondHandle<ITkPixFieldMaps> writeFieldMapHandle(m_writeFieldMapKey, ctx);
50 if (writeFieldMapHandle.isValid()) {
51 ATH_MSG_DEBUG("CondHandle " << writeFieldMapHandle.fullKey() << " is already valid.. In theory this should not be called, but may happen if multiple concurrent events are being processed out of order.");
52 return StatusCode::SUCCESS;
53 }
54
55
56 // Construct the output Cond Object and fill it in
57 auto writeFieldsCdo(std::make_unique<ITkPixFieldMaps>());
58
59 const EventIDBase start{EventIDBase::UNDEFNUM, EventIDBase::UNDEFEVT, 0,
60 0, EventIDBase::UNDEFNUM, EventIDBase::UNDEFNUM};
61 const EventIDBase stop {EventIDBase::UNDEFNUM, EventIDBase::UNDEFEVT, EventIDBase::UNDEFNUM-1,
62 EventIDBase::UNDEFNUM-1, EventIDBase::UNDEFNUM, EventIDBase::UNDEFNUM};
63
64 EventIDRange rangeW{start, stop};
65
66 // Create mapping file for radiation damage simulation
67 std::vector<PixelHistoConverter> ramoPotentialMap;
68 std::vector<PixelHistoConverter> lorentzMap_e;
69 std::vector<PixelHistoConverter> lorentzMap_h;
70 std::vector<PixelHistoConverter> distanceMap_e;
71 std::vector<PixelHistoConverter> distanceMap_h;
72 //returns /cvmfs/atlas.cern.ch/repo/sw/database/GroupData/PixelDigitization/maps_IBL_PL_80V_fl0e14.root
73 const std::string fullPath = PathResolverFindCalibFile(m_efieldFilePath.value());
74 ATH_MSG_INFO("Using map located at: "<<fullPath);
75 std::unique_ptr<TFile> mapsFile(TFile::Open(fullPath.c_str(), "READ")); //this is the ramo potential
76 if (!mapsFile) {
77 ATH_MSG_FATAL("Cannot open file: " << m_efieldFilePath.value());
78 return StatusCode::FAILURE;
79 }
80
81 //Setup ramo weighting field map
82 auto ramoPotentialMap_hold = readRootObject<TH3F>(*mapsFile, "hramomap1");
83 if (!ramoPotentialMap_hold) {
84 ramoPotentialMap_hold = readRootObject<TH3F>(*mapsFile, "ramo3d");
85 }
86 if (!ramoPotentialMap_hold) {
87 ATH_MSG_FATAL("Did not find a Ramo potential map and an approximate form is available yet. Exit...");
88 return StatusCode::FAILURE;
89 }
90
91 ramoPotentialMap_hold->SetDirectory(nullptr);
92 auto lorentzMap_e_hold = readRootObject<TH2F>(*mapsFile, "lorentz_map_e");
93 auto lorentzMap_h_hold = readRootObject<TH2F>(*mapsFile, "lorentz_map_h");
94 auto distanceMap_e_hold = readRootObject<TH2F>(*mapsFile, "edistance");
95 auto distanceMap_h_hold = readRootObject<TH2F>(*mapsFile, "hdistance");
96
97 if (!lorentzMap_e_hold || !lorentzMap_h_hold || !distanceMap_e_hold || !distanceMap_h_hold) {
98 ATH_MSG_FATAL("Cannot read one of the histograms needed");
99 return StatusCode::FAILURE;
100 }
101
102
103 ramoPotentialMap.emplace_back();
104 ATH_CHECK(ramoPotentialMap.back().setHisto3D(ramoPotentialMap_hold.get()));
105 lorentzMap_e.emplace_back();
106 lorentzMap_h.emplace_back();
107 distanceMap_e.emplace_back();
108 distanceMap_h.emplace_back();
109 ATH_CHECK(lorentzMap_e.back().setHisto2D(lorentzMap_e_hold.get()));
110 ATH_CHECK(lorentzMap_h.back().setHisto2D(lorentzMap_h_hold.get()));
111 ATH_CHECK(distanceMap_e.back().setHisto2D(distanceMap_e_hold.get()));
112 ATH_CHECK(distanceMap_h.back().setHisto2D(distanceMap_h_hold.get()));
113
114 mapsFile->Close();
115
116 writeFieldsCdo -> setLorentzMap_e(std::move(lorentzMap_e));
117 writeFieldsCdo -> setLorentzMap_h(std::move(lorentzMap_h));
118 writeFieldsCdo -> setDistanceMap_e(std::move(distanceMap_e));
119 writeFieldsCdo -> setDistanceMap_h(std::move(distanceMap_h));
120 writeFieldsCdo -> setRamoPotentialMap(std::move(ramoPotentialMap));
121
122 if (rangeW.stop().isValid() && rangeW.start()>rangeW.stop()) {
123 ATH_MSG_FATAL("Invalid intersection rangeW: " << rangeW);
124 return StatusCode::FAILURE;
125 }
126 if (writeFieldMapHandle.record(rangeW, std::move(writeFieldsCdo)).isFailure()) {
127 ATH_MSG_FATAL("Could not record ITkPixFieldMaps " << writeFieldMapHandle.key() << " with EventRange " << rangeW << " into Conditions Store");
128 return StatusCode::FAILURE;
129 }
130 ATH_MSG_INFO("recorded new CDO " << writeFieldMapHandle.key() << " with range " << rangeW << " into Conditions Store");
131
132 return StatusCode::SUCCESS;
133
134}
#define ATH_CHECK
Evaluate an expression and check for errors.
#define ATH_MSG_FATAL(x)
#define ATH_MSG_INFO(x)
EventIDBase::event_number_t event_number_t
std::string PathResolverFindCalibFile(const std::string &logical_file_name)
Gaudi::Property< std::string > m_efieldFilePath
SG::WriteCondHandleKey< ITkPixFieldMaps > m_writeFieldMapKey
unsigned int number_type
setEventNumber timeStamp

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

◆ isReEntrant()

virtual bool AthCondAlgorithm::isReEntrant ( ) const
inlineoverridevirtualinherited

Avoid scheduling algorithm multiple times.

With multiple concurrent events, conditions objects often expire simultaneously for all slots. To avoid that the scheduler runs the CondAlg in each slot, we declare it as "non-reentrant". This ensures that the conditions objects are only created once.

In case a particular CondAlg should behave differently, it can override this method again and return true.

See also
ATEAM-836

Definition at line 39 of file AthCondAlgorithm.h.

39{ return false; }

◆ 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_ERROR(x)
#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_efieldFilePath

Gaudi::Property<std::string> ITkPixFieldMapsAlg::m_efieldFilePath {this, "EFieldFilePath", "PixelDigitization/maps_IBL_PL_80V_fl0e14.root", "File path for EField files"}
private

Definition at line 27 of file ITkPixFieldMapsAlg.h.

28{this, "EFieldFilePath", "PixelDigitization/maps_IBL_PL_80V_fl0e14.root", "File path for EField files"};

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

SG::WriteCondHandleKey<ITkPixFieldMaps> ITkPixFieldMapsAlg::m_writeFieldMapKey {this, "ITkPixFieldMapsKey", "ITkPixFieldMapsKey", "Output key for efield data"}
private

Definition at line 30 of file ITkPixFieldMapsAlg.h.

31{this, "ITkPixFieldMapsKey", "ITkPixFieldMapsKey", "Output key for efield data"};

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