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

Conditions algorithm to load the sTGC efficiency constants that are used in digitization. More...

#include <sTgcDigitEffiCondAlg.h>

Inheritance diagram for sTgcDigitEffiCondAlg:
Collaboration diagram for sTgcDigitEffiCondAlg:

Public Member Functions

 sTgcDigitEffiCondAlg (const std::string &name, ISvcLocator *svc)
virtual ~sTgcDigitEffiCondAlg ()=default
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

StatusCode parseDataFromJSON (const nlohmann::json &lines, Muon::DigitEffiData &effiData) const
 Parse efficiency data from COOL.
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
 specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes

ServiceHandle< Muon::IMuonIdHelperSvcm_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}
Gaudi::Property< std::string > m_readFromJSON {this, "readFromJSON", "" }
 Load the gasGap efficiencies from a JSON file.
SG::WriteCondHandleKey< Muon::DigitEffiDatam_writeKey {this, "WriteKey", "sTgcDigitEff", "Key of the efficiency data in the CondStore"}
SG::ReadCondHandleKey< CondAttrListCollectionm_readKeyDb
Gaudi::Property< double > m_defaultEffi {this, "defaultEffi", 1.}
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

Conditions algorithm to load the sTGC efficiency constants that are used in digitization.

Definition at line 21 of file sTgcDigitEffiCondAlg.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

◆ sTgcDigitEffiCondAlg()

sTgcDigitEffiCondAlg::sTgcDigitEffiCondAlg ( const std::string & name,
ISvcLocator * svc )

Definition at line 12 of file sTgcDigitEffiCondAlg.cxx.

12 :
13 AthCondAlgorithm(name, pSvcLocator) {}

◆ ~sTgcDigitEffiCondAlg()

virtual sTgcDigitEffiCondAlg::~sTgcDigitEffiCondAlg ( )
virtualdefault

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

Definition at line 32 of file sTgcDigitEffiCondAlg.cxx.

32 {
33 ATH_MSG_DEBUG("execute " << name());
34 // launching Write Cond Handle
35 SG::WriteCondHandle<Muon::DigitEffiData> writeHandle{m_writeKey, ctx};
36 if (writeHandle.isValid()) {
37 ATH_MSG_DEBUG("CondHandle " << writeHandle.fullKey() << " is already valid."
38 << " In theory this should not be called, but may happen"
39 << " if multiple concurrent events are being processed out of order.");
40 return StatusCode::SUCCESS;
41 }
42 writeHandle.addDependency(EventIDRange(IOVInfiniteRange::infiniteTime()));
43 std::unique_ptr<Muon::DigitEffiData> writeCdo{std::make_unique<Muon::DigitEffiData>(m_idHelperSvc.get(), m_defaultEffi)};
44 if (!m_readKeyDb.empty()) {
45 SG::ReadCondHandle<CondAttrListCollection> readHandle{m_readKeyDb, ctx};
46 if (!readHandle.isValid()) {
47 ATH_MSG_FATAL("Failed to initialize the COOL folder "<<m_readKeyDb.fullKey());
48 return StatusCode::FAILURE;
49 }
50 writeHandle.addDependency(readHandle);
51 for (CondAttrListCollection::const_iterator itr = readHandle->begin(); itr != readHandle->end(); ++itr) {
52 const coral::AttributeList& atr = itr->second;
53 const std::string data{*(static_cast<const std::string*>((atr["data"]).addressOfData()))};
54 nlohmann::json lines = nlohmann::json::parse(data);
55 ATH_CHECK(parseDataFromJSON(lines, *writeCdo));
56 }
57 } else {
58 std::ifstream inStream{PathResolverFindCalibFile(m_readFromJSON)};
59 if (!inStream.good()) {
60 ATH_MSG_FATAL("No such file or directory");
61 return StatusCode::FAILURE;
62 }
63 nlohmann::json lines;
64 inStream >> lines;
65 ATH_CHECK(parseDataFromJSON(lines, *writeCdo));
66 }
67 ATH_CHECK(writeHandle.record(std::move(writeCdo)));
68 ATH_MSG_DEBUG("Recorded new " << writeHandle.key() << " with range " << writeHandle.getRange() << " into Conditions Store");
69 return StatusCode::SUCCESS;
70}
#define ATH_CHECK
Evaluate an expression and check for errors.
#define ATH_MSG_FATAL(x)
#define ATH_MSG_DEBUG(x)
char data[hepevt_bytes_allocation_ATLAS]
Definition HepEvt.cxx:11
std::string PathResolverFindCalibFile(const std::string &logical_file_name)
ChanAttrListMap::const_iterator const_iterator
static EventIDRange infiniteTime()
Produces an EventIDRange that is inifinite in Time and invalid in RunLumi.
const std::string & key() const
void addDependency(const EventIDRange &range)
const EventIDRange & getRange() const
StatusCode record(const EventIDRange &range, T *t)
record handle, with explicit range DEPRECATED
const DataObjID & fullKey() const
StatusCode parseDataFromJSON(const nlohmann::json &lines, Muon::DigitEffiData &effiData) const
Parse efficiency data from COOL.
Gaudi::Property< std::string > m_readFromJSON
Load the gasGap efficiencies from a JSON file.
ServiceHandle< Muon::IMuonIdHelperSvc > m_idHelperSvc
Gaudi::Property< double > m_defaultEffi
SG::WriteCondHandleKey< Muon::DigitEffiData > m_writeKey
SG::ReadCondHandleKey< CondAttrListCollection > m_readKeyDb

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

Definition at line 16 of file sTgcDigitEffiCondAlg.cxx.

16 {
17 ATH_MSG_DEBUG("initializing " << name());
18 ATH_CHECK(m_idHelperSvc.retrieve());
19 ATH_CHECK(m_writeKey.initialize());
20 if (m_readKeyDb.empty() && m_readFromJSON.value().empty()){
21 ATH_MSG_FATAL("No data source is given to load efficiency maps from. Please provide either a COOL folder or a json file");
22 return StatusCode::FAILURE;
23 } else if (m_readKeyDb.empty()) {
24 ATH_MSG_INFO("Load efficiency maps from a JSON file "<<m_readFromJSON);
25 } else {
26 ATH_MSG_INFO("Load efficiency maps list from COOL "<<m_readKeyDb.fullKey());
27 }
28 return StatusCode::SUCCESS;
29}
#define ATH_MSG_INFO(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()

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

◆ parseDataFromJSON()

StatusCode sTgcDigitEffiCondAlg::parseDataFromJSON ( const nlohmann::json & lines,
Muon::DigitEffiData & effiData ) const
private

Parse efficiency data from COOL.

Station Component identification

Definition at line 71 of file sTgcDigitEffiCondAlg.cxx.

72 {
73 for (auto& corr : lines.items()) {
74 nlohmann::json line = corr.value();
76 const std::string stationType = line["station"];
77 const int stationPhi = line["phi"];
78 const int stationEta = line["eta"];
79 const int multiLayer = line["multilayer"];
80 const int gasGap = line["gasGap"];
81 const int isInnerQ1 = line["isInnerQ1"];
82 const double efficiency = line["efficiency"];
83 bool is_valid{false};
84 const Identifier id = m_idHelperSvc->stgcIdHelper().hvID(stationType, stationEta, stationPhi,
85 multiLayer, gasGap, isInnerQ1, is_valid);
86 if (!is_valid) {
87 ATH_MSG_FATAL("The Identifier identifier "<<stationType<<", "<<stationEta<<", "<<stationPhi
88 << ", "<<multiLayer<<", "<<gasGap<<", "<< isInnerQ1<<" is invalid");
89 return StatusCode::FAILURE;
90 }
91 ATH_CHECK(effiData.setEfficiency(id, efficiency, isInnerQ1));
92 }
93 return StatusCode::SUCCESS;
94}
StatusCode setEfficiency(const Identifier &sectionId, const double effi, bool isInnerQ1=false)
Sets the efficiency for a given minimal section of the dector.
void efficiency(std::vector< double > &bins, std::vector< double > &values, const std::vector< std::string > &files, const std::string &histname, const std::string &tplotname, const std::string &label="")
constexpr uint8_t stationPhi
station Phi 1 to 8

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

Gaudi::Property<double> sTgcDigitEffiCondAlg::m_defaultEffi {this, "defaultEffi", 1.}
private

Definition at line 41 of file sTgcDigitEffiCondAlg.h.

41{this, "defaultEffi", 1.};

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

ServiceHandle<Muon::IMuonIdHelperSvc> sTgcDigitEffiCondAlg::m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}
private

Definition at line 33 of file sTgcDigitEffiCondAlg.h.

33{this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"};

◆ m_readFromJSON

Gaudi::Property<std::string> sTgcDigitEffiCondAlg::m_readFromJSON {this, "readFromJSON", "" }
private

Load the gasGap efficiencies from a JSON file.

Definition at line 36 of file sTgcDigitEffiCondAlg.h.

36{this, "readFromJSON", "" };

◆ m_readKeyDb

SG::ReadCondHandleKey<CondAttrListCollection> sTgcDigitEffiCondAlg::m_readKeyDb
private
Initial value:
{this, "ReadKey", "",
"Folder of the STGC efficiencies as they're stored in COOL"}

Definition at line 39 of file sTgcDigitEffiCondAlg.h.

39 {this, "ReadKey", "",
40 "Folder of the STGC efficiencies as they're stored in COOL"};

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

SG::WriteCondHandleKey<Muon::DigitEffiData> sTgcDigitEffiCondAlg::m_writeKey {this, "WriteKey", "sTgcDigitEff", "Key of the efficiency data in the CondStore"}
private

Definition at line 38 of file sTgcDigitEffiCondAlg.h.

38{this, "WriteKey", "sTgcDigitEff", "Key of the efficiency data in the CondStore"};

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