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

#include <NswOccupancyAlg.h>

Inheritance diagram for NswOccupancyAlg:
Collaboration diagram for NswOccupancyAlg:

Public Member Functions

 NswOccupancyAlg (const std::string &name, ISvcLocator *pSvcLocator)
StatusCode initialize () override
StatusCode execute (const EventContext &ctx) override
 Execute method.
unsigned int cardinality () const override final
virtual StatusCode sysInitialize ()
 Initialization method invoked by the framework.
const ServiceHandle< ITHistSvc > & histSvc () const
 The standard THistSvc (for writing histograms and TTrees and more to a root file) Returns (kind of) a pointer to the THistSvc.
virtual bool isClonable () const override
 Specify if the algorithm is clonable.
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
 Get filter decision:
virtual void setFilterPassed (bool state, const EventContext &ctx) const
 Set filter decision:
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

virtual bool isReEntrant () const override final
 Legacy algorithms are not thread-safe.
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.
StatusCode configAthHistogramming (const ServiceHandle< ITHistSvc > &histSvc, const std::string &prefix, const std::string &rootDir, const std::string &histNamePrefix, const std::string &histNamePostfix, const std::string &histTitlePrefix, const std::string &histTitlePostfix)
 To be called by the derived classes to fill the internal configuration.
TH1 * bookGetPointer (const TH1 &hist, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of histograms.
TH1 * bookGetPointer (TH1 *hist, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of histograms.
TH1 * bookGetPointer (TH1 &histRef, std::string tDir="", std::string stream="")
 Simplify the booking and registering (into THistSvc) of histograms.
TTree * bookGetPointer (const TTree &treeRef, std::string tDir="", std::string stream="")
 Simplify the booking and registering (into THistSvc) of TTrees.
TGraph * bookGetPointer (const TGraph &graphRef, std::string tDir="", std::string stream="")
 Simplify the booking and registering (into THistSvc) of TGraphs.
TEfficiency * bookGetPointer (const TEfficiency &eff, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of TEfficiency.
TEfficiency * bookGetPointer (TEfficiency *eff, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of TEfficiency.
TEfficiency * bookGetPointer (TEfficiency &effRef, std::string tDir="", std::string stream="")
 Simplify the booking and registering (into THistSvc) of TEfficiency.
StatusCode book (const TH1 &hist, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of histograms.
StatusCode book (TH1 *hist, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of histograms.
StatusCode book (TH1 &histRef, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of histograms.
StatusCode book (const TTree &treeRef, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of TTrees.
StatusCode book (const TGraph &graphRef, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of TGraphs.
StatusCode book (const TEfficiency &eff, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of TEfficiency.
StatusCode book (TEfficiency *eff, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of TEfficiency.
StatusCode book (TEfficiency &effRef, const std::string &tDir="", const std::string &stream="")
 Simplify the booking and registering (into THistSvc) of TEfficiency.
TH1 * hist (std::string_view histName, const std::string &tDir="", const std::string &stream="")
 Simplify the retrieval of registered histograms of any type.
TH2 * hist2d (std::string_view histName, const std::string &tDir="", const std::string &stream="")
 Simplify the retrieval of registered 2-d histograms.
TH3 * hist3d (std::string_view histName, const std::string &tDir="", const std::string &stream="")
 Simplify the retrieval of registered 3-d histograms.
TTree * tree (const std::string &treeName, const std::string &tDir="", const std::string &stream="")
 Simplify the retrieval of registered TTrees.
TGraph * graph (const std::string &graphName, const std::string &tDir="", const std::string &stream="")
 Simplify the retrieval of registered TGraphs.
TEfficiency * efficiency (const std::string &effName, const std::string &tDir="", const std::string &stream="")
 Simplify the retrieval of registered TEfficiency.

Private Types

using Layer = std::vector<Identifier>
using LayerVec = std::vector<Layer>
typedef ServiceHandle< StoreGateSvcStoreGateSvc_t
typedef uint32_t hash_t
 typedef for the internal hash
typedef std::map< const hash_t, TH1 * > HistMap_t
 Typedef for convenience.
typedef std::map< const hash_t, TEfficiency * > EffMap_t
 Typedef for convenience.
typedef std::map< const hash_t, TTree * > TreeMap_t
 Typedef for convenience.
typedef std::map< const hash_t, TGraph * > GraphMap_t
 Typedef for convenience.

Private Member Functions

LayerVec sortByLayer (std::vector< Identifier > &micromegaHits) const
void fillHistograms (const Layer &layers)
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
 specialization for handling Gaudi::Property<SG::VarHandleKey>
std::string buildBookingString (std::string &histName, std::string &tDir, std::string &stream, bool usePrefixPostfix=false)
 Method to build individual booking string.
void myReplace (std::string &str, const std::string &oldStr, const std::string &newStr)
 Helper method to replace sub-string.
hash_t hash (const std::string &histName) const
 Method to calculate a 32-bit hash from a string.

Private Attributes

ServiceHandle< Muon::IMuonIdHelperSvcm_idHelperSvc
SG::ReadHandleKey< MuonPatternCombinationCollectionm_patternCollKey
Gaudi::Property< std::string > m_fileStream {this, "FileStream", "NSWSTORIES"}
Gaudi::Property< unsigned int > m_binWidth {this, "BinWidth", 100}
TH1 * m_singleBinOccupancy {nullptr}
TH1 * m_pairBinOccupancy {nullptr}
TH1 * m_pairVsSingleOccupancy {nullptr}
ServiceHandle< ITHistSvc > m_histSvc
 Default constructor: AthHistogramAlgorithm();.
std::string m_prefix
 Name of the ROOT output stream (file).
std::string m_rootDir
 Name of the ROOT directory.
std::string m_histNamePrefix
 The prefix for the histogram THx name.
std::string m_histNamePostfix
 The postfix for the histogram THx name.
std::string m_histTitlePrefix
 The prefix for the histogram THx title.
std::string m_histTitlePostfix
 The postfix for the histogram THx title.
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
HistMap_t m_histMap
 The map of histogram names to their pointers.
EffMap_t m_effMap
 The map of histogram names to their pointers.
TreeMap_t m_treeMap
 The map of TTree names to their pointers.
GraphMap_t m_graphMap
 The map of TGraph names to their pointers.
std::string m_streamName
 Name of the ROOT output stream (file).
std::string m_name
 Instance name.
MsgStream m_msg
 Cached Message Stream.

Detailed Description

Definition at line 12 of file NswOccupancyAlg.h.

Member Typedef Documentation

◆ EffMap_t

typedef std::map< const hash_t, TEfficiency* > AthHistogramming::EffMap_t
privateinherited

Typedef for convenience.

Definition at line 206 of file AthHistogramming.h.

◆ GraphMap_t

typedef std::map< const hash_t, TGraph* > AthHistogramming::GraphMap_t
privateinherited

Typedef for convenience.

Definition at line 220 of file AthHistogramming.h.

◆ hash_t

typedef uint32_t AthHistogramming::hash_t
privateinherited

typedef for the internal hash

Definition at line 171 of file AthHistogramming.h.

◆ HistMap_t

typedef std::map< const hash_t, TH1* > AthHistogramming::HistMap_t
privateinherited

Typedef for convenience.

Definition at line 199 of file AthHistogramming.h.

◆ Layer

using NswOccupancyAlg::Layer = std::vector<Identifier>
private

Definition at line 25 of file NswOccupancyAlg.h.

◆ LayerVec

using NswOccupancyAlg::LayerVec = std::vector<Layer>
private

Definition at line 26 of file NswOccupancyAlg.h.

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t
privateinherited

Definition at line 388 of file AthCommonDataStore.h.

◆ TreeMap_t

typedef std::map< const hash_t, TTree* > AthHistogramming::TreeMap_t
privateinherited

Typedef for convenience.

Definition at line 213 of file AthHistogramming.h.

Constructor & Destructor Documentation

◆ NswOccupancyAlg()

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

Definition at line 11 of file NswOccupancyAlg.cxx.

11 :
12 AthHistogramAlgorithm(name, pSvcLocator){}
AthHistogramAlgorithm(const std::string &name, ISvcLocator *pSvcLocator)
Constructor with parameters:

Member Function Documentation

◆ book() [1/8]

StatusCode AthHistogramming::book ( const TEfficiency & eff,
const std::string & tDir = "",
const std::string & stream = "" )
inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 336 of file AthHistogramming.h.

337{
338 // We need to create a non-const clone
339 TEfficiency* effClone = dynamic_cast< TEfficiency* >( eff.Clone() );
340 if ( !effClone ) {
341 m_msg << MSG::ERROR << "Couldn't create a TEfficiency clone" << endmsg;
342 return StatusCode::FAILURE;
343 }
344 return this->book( *effClone, tDir, stream );
345}
#define endmsg
StatusCode book(const TH1 &hist, const std::string &tDir="", const std::string &stream="")
Simplify the booking and registering (into THistSvc) of histograms.
MsgStream m_msg
Cached Message Stream.

◆ book() [2/8]

StatusCode AthHistogramming::book ( const TGraph & graphRef,
const std::string & tDir = "",
const std::string & stream = "" )
inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TGraphs.

◆ book() [3/8]

StatusCode AthHistogramming::book ( const TH1 & hist,
const std::string & tDir = "",
const std::string & stream = "" )
inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 304 of file AthHistogramming.h.

305{
306 // We need to create a non-const clone
307 TH1* histClone = dynamic_cast< TH1* >( hist.Clone() );
308 if ( !histClone ) {
309 m_msg << MSG::ERROR << "Couldn't create a TH1 clone" << endmsg;
310 return StatusCode::FAILURE;
311 }
312 return this->book( *histClone, tDir, stream );
313}
TH1 * hist(std::string_view histName, const std::string &tDir="", const std::string &stream="")
Simplify the retrieval of registered histograms of any type.

◆ book() [4/8]

StatusCode AthHistogramming::book ( const TTree & treeRef,
const std::string & tDir = "",
const std::string & stream = "" )
inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TTrees.

Definition at line 404 of file AthHistogramming.h.

405{
406 // Call the other Book method and see if it returns a valid pointer
407 TTree* treePointer = this->bookGetPointer( treeRef, tDir, stream );
408 if ( treePointer )
409 {
410 return StatusCode::SUCCESS;
411 }
412 else
413 {
414 return StatusCode::FAILURE;
415 }
416}
TH1 * bookGetPointer(const TH1 &hist, const std::string &tDir="", const std::string &stream="")
Simplify the booking and registering (into THistSvc) of histograms.

◆ book() [5/8]

StatusCode AthHistogramming::book ( TEfficiency & effRef,
const std::string & tDir = "",
const std::string & stream = "" )
inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 357 of file AthHistogramming.h.

358{
359 // Call the other Book method and see if it returns a valid pointer
360 TEfficiency* effPointer = this->bookGetPointer( effRef, tDir, stream );
361 if ( !effPointer ) {
362 m_msg << MSG::ERROR << "Couldn't book a TEfficiency" << endmsg;
363 return StatusCode::FAILURE;
364 }
365 return StatusCode::SUCCESS;
366}

◆ book() [6/8]

StatusCode AthHistogramming::book ( TEfficiency * eff,
const std::string & tDir = "",
const std::string & stream = "" )
inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 347 of file AthHistogramming.h.

348{
349 if ( !eff ) {
350 m_msg << MSG::ERROR << "Got a zero pointer to a TEfficiency" << endmsg;
351 return StatusCode::FAILURE;
352 }
353 return this->book( *eff, tDir, stream );
354}

◆ book() [7/8]

StatusCode AthHistogramming::book ( TH1 & histRef,
const std::string & tDir = "",
const std::string & stream = "" )
inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 325 of file AthHistogramming.h.

326{
327 // Call the other Book method and see if it returns a valid pointer
328 TH1* histPointer = this->bookGetPointer( histRef, tDir, stream );
329 if ( !histPointer ) {
330 m_msg << MSG::ERROR << "Couldn't book a TH1" << endmsg;
331 return StatusCode::FAILURE;
332 }
333 return StatusCode::SUCCESS;
334}

◆ book() [8/8]

StatusCode AthHistogramming::book ( TH1 * hist,
const std::string & tDir = "",
const std::string & stream = "" )
inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 315 of file AthHistogramming.h.

316{
317 if ( !hist ) {
318 m_msg << MSG::ERROR << "Got a zero pointer to a TH1" << endmsg;
319 return StatusCode::FAILURE;
320 }
321 return this->book( *hist, tDir, stream );
322}

◆ bookGetPointer() [1/8]

TEfficiency * AthHistogramming::bookGetPointer ( const TEfficiency & eff,
const std::string & tDir = "",
const std::string & stream = "" )
inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 282 of file AthHistogramming.h.

283{
284 // We need to create a non-const clone
285 TEfficiency* histClone = dynamic_cast< TEfficiency* >( hist.Clone() );
286 if ( !histClone ) {
287 m_msg << MSG::ERROR << "Couldn't create a TEfficiency clone in bookGetPointer" << endmsg;
288 return 0;
289 }
290 return this->bookGetPointer( *histClone, tDir, stream );
291
292}

◆ bookGetPointer() [2/8]

TGraph * AthHistogramming::bookGetPointer ( const TGraph & graphRef,
std::string tDir = "",
std::string stream = "" )
protectedinherited

Simplify the booking and registering (into THistSvc) of TGraphs.

Definition at line 378 of file AthHistogramming.cxx.

379{
380 // Get a pointer
381 const TGraph* graphPointer = &graphRef;
382
383 // Check that we got a valid pointer
384 if ( !graphPointer )
385 {
386 m_msg << MSG::WARNING
387 << "We got an invalid TGraph pointer in the BookGetPointer(TGraph*) method of the class" << m_name
388 << "!" << endmsg;
389 return NULL;
390 }
391
392 // Modify the name and title according to the prefixes of this classes instance
393 std::string graphName = graphPointer->GetName();
394 const std::string graphTitle = graphPointer->GetTitle();
395
396 // Check if the hash for this graphName already exists, i.e., if we have a hash collision
397 const hash_t graphHash = this->hash(graphName);
398 GraphMap_t::const_iterator it = m_graphMap.find( graphHash );
399 if ( it != m_graphMap.end() ) // It does exist!
400 {
401 m_msg << MSG::WARNING
402 << "Detected a hash collision. The hash for the TGraph with name=" << graphName
403 << " already exists and points to a TGraph with name=" << it->second->GetName()
404 << " NOT going to book the new histogram and returning a NULL pointer!" << endmsg;
405 return NULL;
406 }
407
408 // Create a clone that has the new name
409 TGraph* graphClone = dynamic_cast< TGraph* >( graphPointer->Clone((m_histNamePrefix+graphName+m_histNamePostfix).c_str()) );
410 if( !graphClone )
411 {
412 m_msg << MSG::WARNING
413 << "We couldn't clone the TGraph in the BookGetPointer(TGraph&) method of the class" << m_name
414 << "!" << endmsg;
415 return NULL;
416 }
417 graphClone->SetTitle ((m_histTitlePrefix+graphTitle+m_histTitlePostfix).c_str());
418
419 // Massage the final string to book things
420 std::string bookingString = buildBookingString( graphName, tDir, stream );
421
422 // Register the TGraph into the THistSvc
423 if ( !((histSvc()->regGraph(bookingString, graphClone)).isSuccess()) )
424 {
425 m_msg << MSG::WARNING
426 << "Problem registering TGraph with name " << graphName
427 << ", title " << graphTitle
428 << " in " << m_name << "!" << endmsg;
429 return NULL;
430 }
431
432 // Also register it in the local map of string to pointer
433 m_graphMap.insert( m_graphMap.end(), std::pair< const hash_t, TGraph* >( graphHash, graphClone ) );
434
435 return graphClone;
436}
const ServiceHandle< ITHistSvc > & histSvc() const
The standard THistSvc (for writing histograms and TTrees and more to a root file) Returns (kind of) a...
std::string m_histNamePostfix
The postfix for the histogram THx name.
std::string buildBookingString(std::string &histName, std::string &tDir, std::string &stream, bool usePrefixPostfix=false)
Method to build individual booking string.
hash_t hash(const std::string &histName) const
Method to calculate a 32-bit hash from a string.
uint32_t hash_t
typedef for the internal hash
std::string m_histTitlePostfix
The postfix for the histogram THx title.
std::string m_histTitlePrefix
The prefix for the histogram THx title.
std::string m_name
Instance name.
std::string m_histNamePrefix
The prefix for the histogram THx name.
GraphMap_t m_graphMap
The map of TGraph names to their pointers.

◆ bookGetPointer() [3/8]

TH1 * AthHistogramming::bookGetPointer ( const TH1 & hist,
const std::string & tDir = "",
const std::string & stream = "" )
inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 261 of file AthHistogramming.h.

262{
263 // We need to create a non-const clone
264 TH1* histClone = dynamic_cast< TH1* >( hist.Clone() );
265 if ( !histClone ) {
266 m_msg << MSG::ERROR << "Couldn't create a TH1 clone in bookGetPointer" << endmsg;
267 return 0;
268 }
269 return this->bookGetPointer( *histClone, tDir, stream );
270
271}

◆ bookGetPointer() [4/8]

TTree * AthHistogramming::bookGetPointer ( const TTree & treeRef,
std::string tDir = "",
std::string stream = "" )
protectedinherited

Simplify the booking and registering (into THistSvc) of TTrees.

Definition at line 265 of file AthHistogramming.cxx.

266{
267 // Get a pointer
268 const TTree* treePointer = &treeRef;
269
270 // Check that we got a valid pointer
271 if ( !treePointer )
272 {
273 m_msg << MSG::WARNING
274 << "We got an invalid TTree pointer in the BookGetPointer(TTree*) method of the class" << m_name
275 << "!" << endmsg;
276 return NULL;
277 }
278
279 // Modify the name and title according to the prefixes of this classes instance
280 std::string treeName = treePointer->GetName();
281 const std::string treeTitle = treePointer->GetTitle();
282
283 // Check if the hash for this treeName already exists, i.e., if we have a hash collision
284 const hash_t treeHash = this->hash(treeName);
285 TreeMap_t::const_iterator it = m_treeMap.find( treeHash );
286 if ( it != m_treeMap.end() ) // It does exist!
287 {
288 m_msg << MSG::WARNING
289 << "Detected a hash collision. The hash for the TTree with name=" << treeName
290 << " already exists and points to a TTree with name=" << it->second->GetName()
291 << " NOT going to book the new histogram and returning a NULL pointer!" << endmsg;
292 return NULL;
293 }
294
295 // Create a clone that has the new name
296 TTree* treeClone = dynamic_cast< TTree* >( treePointer->Clone(treeName.c_str()) );
297 if( !treeClone )
298 {
299 m_msg << MSG::WARNING
300 << "We couldn't clone the TTree in the BookGetPointer(TTree&) method of the class" << m_name
301 << "!" << endmsg;
302 return NULL;
303 }
304 treeClone->SetTitle (treeTitle.c_str());
305
306 // Massage the final string to book things
307 std::string bookingString = buildBookingString( treeName, tDir, stream );
308
309 // Register the TTree into the THistSvc
310 if ( !((histSvc()->regTree(bookingString, treeClone)).isSuccess()) )
311 {
312 m_msg << MSG::WARNING
313 << "Problem registering TTree with name " << treeName
314 << ", title " << treeTitle
315 << " in " << m_name << "!" << endmsg;
316 return NULL;
317 }
318
319 // Also register it in the local map of string to pointer
320 m_treeMap.insert( m_treeMap.end(), std::pair< const hash_t, TTree* >( treeHash, treeClone ) );
321
322 return treeClone;
323}
TreeMap_t m_treeMap
The map of TTree names to their pointers.

◆ bookGetPointer() [5/8]

TEfficiency * AthHistogramming::bookGetPointer ( TEfficiency & effRef,
std::string tDir = "",
std::string stream = "" )
protectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 121 of file AthHistogramming.cxx.

122{
123 std::string effName(effRef.GetName());
124 const std::string effTitle(effRef.GetTitle());
125 std::string bookingString = buildBookingString(effName, tDir, stream);
126 const std::string finalEffName = m_histNamePrefix + effName + m_histNamePostfix;
127 effRef.SetTitle((m_histTitlePrefix + effTitle + m_histTitlePostfix).c_str());
128 effRef.SetName(finalEffName.c_str());
129
130 const hash_t effHash = this->hash(effName);
131 EffMap_t::const_iterator it = m_effMap.find(effHash);
132 if (it != m_effMap.end()) {
133 m_msg << MSG::WARNING
134 << "Detected a hash collision. The hash for the TEfficiency with name=" << effName
135 << " already exists and points to a TEfficiency with name=" << it->second->GetName()
136 << " NOT going to book the new TEfficiency and returning a NULL pointer!" << endmsg;
137 return nullptr;
138 }
139
140 if (!histSvc()->regEfficiency(bookingString, &effRef).isSuccess()) {
141 m_msg << MSG::WARNING
142 << "Problem registering TEfficiency with name " << effName
143 << ", name prefix " << m_histNamePrefix
144 << ", title " << effTitle
145 << ", title prefix " << m_histTitlePrefix
146 << ", and title postfix " << m_histTitlePostfix
147 << " in " << m_name << "!" << endmsg;
148 return nullptr;
149 }
150
151 m_effMap.insert(m_effMap.end(), std::pair<const hash_t, TEfficiency*>(effHash, &effRef));
152
153 return &effRef;
154}
EffMap_t m_effMap
The map of histogram names to their pointers.

◆ bookGetPointer() [6/8]

TEfficiency * AthHistogramming::bookGetPointer ( TEfficiency * eff,
const std::string & tDir = "",
const std::string & stream = "" )
inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 294 of file AthHistogramming.h.

295{
296 if ( !hist ) {
297 m_msg << MSG::ERROR << "Got a zero pointer to a TEfficiency in bookGetPointer" << endmsg;
298 return 0;
299 }
300 return this->bookGetPointer( *hist, tDir, stream );
301}

◆ bookGetPointer() [7/8]

TH1 * AthHistogramming::bookGetPointer ( TH1 & histRef,
std::string tDir = "",
std::string stream = "" )
protectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 83 of file AthHistogramming.cxx.

84{
85 std::string histName(histRef.GetName());
86 const std::string histTitle(histRef.GetTitle());
87 std::string bookingString = buildBookingString(histName, tDir, stream);
88
89 const std::string finalHistName = m_histNamePrefix + histName + m_histNamePostfix;
90
91 histRef.SetTitle((m_histTitlePrefix + histTitle + m_histTitlePostfix).c_str());
92 histRef.SetName(finalHistName.c_str());
93
94 const hash_t histHash = this->hash(histName);
95 HistMap_t::const_iterator it = m_histMap.find(histHash);
96 if (it != m_histMap.end()) {
97 m_msg << MSG::WARNING
98 << "Detected a hash collision. The hash for the histogram with name=" << histName
99 << " already exists and points to a histogram with name=" << it->second->GetName()
100 << " NOT going to book the new histogram and returning a NULL pointer!" << endmsg;
101 return nullptr;
102 }
103
104 if (!histSvc()->regHist(bookingString, &histRef).isSuccess()) {
105 m_msg << MSG::WARNING
106 << "Problem registering histogram with name " << histName
107 << ", name prefix " << m_histNamePrefix
108 << ", title " << histTitle
109 << ", title prefix " << m_histTitlePrefix
110 << ", and title postfix " << m_histTitlePostfix
111 << " in " << m_name << "!" << endmsg;
112 return nullptr;
113 }
114
115 m_histMap.insert(m_histMap.end(), std::pair<const hash_t, TH1*>(histHash, &histRef));
116
117 return &histRef;
118}
HistMap_t m_histMap
The map of histogram names to their pointers.

◆ bookGetPointer() [8/8]

TH1 * AthHistogramming::bookGetPointer ( TH1 * hist,
const std::string & tDir = "",
const std::string & stream = "" )
inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 273 of file AthHistogramming.h.

274{
275 if ( !hist ) {
276 m_msg << MSG::ERROR << "Got a zero pointer to a TH1 in bookGetPointer" << endmsg;
277 return 0;
278 }
279 return this->bookGetPointer( *hist, tDir, stream );
280}

◆ buildBookingString()

std::string AthHistogramming::buildBookingString ( std::string & histName,
std::string & tDir,
std::string & stream,
bool usePrefixPostfix = false )
privateinherited

Method to build individual booking string.

Definition at line 509 of file AthHistogramming.cxx.

511{
512 std::string bookingString;
513 // Massage the final string to book things
514 if(tDir.empty()) tDir = m_rootDir;
515 size_t pos = histName.rfind('/');
516 if(pos != std::string::npos){
517 tDir+='/';
518 tDir.append(histName, 0,pos);
519 histName.erase(0,pos+1);
520 };
521 if(stream.empty()) stream = m_streamName;
522
523 if(usePrefixPostfix){
524 bookingString = "/"+stream+"/"+tDir+"/"+m_histNamePrefix+histName+m_histNamePostfix;
525 } else {
526 bookingString = "/"+stream+"/"+tDir+"/"+histName;
527 }
528 while(bookingString.find("//") != std::string::npos){
529 this->myReplace(bookingString,"//","/");
530 }
531
532 return bookingString;
533}
std::string m_rootDir
Name of the ROOT directory.
std::string m_streamName
Name of the ROOT output stream (file).
void myReplace(std::string &str, const std::string &oldStr, const std::string &newStr)
Helper method to replace sub-string.

◆ cardinality()

unsigned int NswOccupancyAlg::cardinality ( ) const
inlinefinaloverride

Definition at line 19 of file NswOccupancyAlg.h.

19{ return 1; }

◆ configAthHistogramming()

StatusCode AthHistogramming::configAthHistogramming ( const ServiceHandle< ITHistSvc > & histSvc,
const std::string & prefix,
const std::string & rootDir,
const std::string & histNamePrefix,
const std::string & histNamePostfix,
const std::string & histTitlePrefix,
const std::string & histTitlePostfix )
protectedinherited

To be called by the derived classes to fill the internal configuration.

Definition at line 51 of file AthHistogramming.cxx.

55{
58 m_rootDir = rootDir;
59 m_histNamePrefix = histNamePrefix;
60 m_histNamePostfix = histNamePostfix;
61 m_histTitlePrefix = histTitlePrefix;
62 m_histTitlePostfix = histTitlePostfix;
63
64 return StatusCode::SUCCESS;
65}
ServiceHandle< ITHistSvc > m_histSvc
Pointer to the THistSvc (event store by default).

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

◆ efficiency()

TEfficiency * AthHistogramming::efficiency ( const std::string & effName,
const std::string & tDir = "",
const std::string & stream = "" )
protectedinherited

Simplify the retrieval of registered TEfficiency.

Definition at line 205 of file AthHistogramming.cxx.

206{
207 // Build a 32 bit hash out of the name
208 const hash_t effHash = this->hash(effName);
209
210 // See if this entry exists in the map
211 EffMap_t::const_iterator it = m_effMap.find( effHash );
212 if ( it == m_effMap.end() ) // It doesn't exist!
213 { // Let's see into the THistSvc if somebody else has registered the TEfficiency...
214
215 // Need to copy the strings as we will massage them from here on
216 std::string effNameCopy = effName;
217 std::string tDirCopy = tDir;
218 std::string streamCopy = stream;
219
220 // Massage the final string to book things
221 std::string bookingString = buildBookingString(effNameCopy, tDirCopy, streamCopy ,false);
222
223 TEfficiency* effPointer(NULL);
224 if ( !((histSvc()->getEfficiency(bookingString, effPointer)).isSuccess()) )
225 {
226 // Massage the final string to book things
227 std::string bookingString = buildBookingString( effNameCopy, tDirCopy, streamCopy, true );
228
229 if ( !((histSvc()->getEfficiency(bookingString, effPointer)).isSuccess()) )
230 {
231 m_msg << MSG::WARNING
232 << "Problem retrieving the TEfficiency with name (including pre- and post-fixes) "
233 << m_histNamePrefix + effNameCopy + m_histNamePostfix
234 << " or with name " << effNameCopy
235 << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
236 << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
237 return NULL;
238 }
239 // If we get to here, we actually found the TEfficiency in the THistSvc.
240 // So let's add it to the local cache map and return its pointer
241 m_effMap.insert( m_effMap.end(), std::pair< const hash_t, TEfficiency* >( effHash, effPointer ) );
242 return effPointer;
243 }
244 // If we get to here, we actually found the TEfficiency in the THistSvc.
245 // So let's add it to the local cache map and return its pointer
246 m_effMap.insert( m_effMap.end(), std::pair< const hash_t, TEfficiency* >( effHash, effPointer ) );
247 return effPointer;
248 }
249
250 // Return the pointer to the TEfficiency that we got from the local cache map
251 return it->second;
252}
std::pair< StatusCode, TEfficiency * > getEfficiency(ITHistSvc &svc, const std::string &name)

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

Execute method.

Collect all the hit identifiers

Implements AthAlgorithm.

Definition at line 33 of file NswOccupancyAlg.cxx.

33 {
34 SG::ReadHandle<MuonPatternCombinationCollection> pattCol{m_patternCollKey, ctx};
35 if (!pattCol.isValid()){
36 ATH_MSG_FATAL("Failed to retrieve the pattern collection "<<m_patternCollKey.fullKey());
37 return StatusCode::FAILURE;
38 }
39
40 for (const Muon::MuonPatternCombination* patComb : *pattCol ) {
42 std::map<unsigned int, Layer> sectorsHits{};
43 for (const Muon::MuonPatternChamberIntersect& it :patComb->chamberData()) {
44 if (it.prepRawDataVec().empty()) continue;
45 const Identifier id = it.prepRawDataVec().front()->identify();
46 if (!m_idHelperSvc->isMM(id) && !m_idHelperSvc->issTgc(id)) continue;
47 Layer& hitIds = sectorsHits[m_idHelperSvc->sector(id)];
48 hitIds.reserve(it.prepRawDataVec().size() + hitIds.size());
49
50 for (const Trk::PrepRawData* prd : it.prepRawDataVec()) {
51 if (prd->type(Trk::PrepRawDataType::MMPrepData)) hitIds.push_back(prd->identify());
52 }
53 }
54 for (auto& [sector, hitIds] : sectorsHits ) {
55 LayerVec sortedHits = sortByLayer(hitIds);
56 for (Layer& lay : sortedHits) {
57 fillHistograms(lay);
58 }
59 }
60 }
61
62 return StatusCode::SUCCESS;
63}
#define ATH_MSG_FATAL(x,...)
std::vector< Layer > LayerVec
void fillHistograms(const Layer &layers)
ServiceHandle< Muon::IMuonIdHelperSvc > m_idHelperSvc
std::vector< Identifier > Layer
LayerVec sortByLayer(std::vector< Identifier > &micromegaHits) const
SG::ReadHandleKey< MuonPatternCombinationCollection > m_patternCollKey
virtual bool isValid() override final
Can the handle be successfully dereferenced?

◆ 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 & AthCommonAlgorithm< 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 89 of file AthCommonAlgorithm.cxx.

54{
55 // If we didn't find any symlinks to add, just return the collection
56 // from the base class. Otherwise, return the extended collection.
57 if (!m_extendedExtraObjects.empty()) {
59 }
61}
Common base class for algorithms.

◆ fillHistograms()

void NswOccupancyAlg::fillHistograms ( const Layer & layers)
private

Define the number of bins

Definition at line 85 of file NswOccupancyAlg.cxx.

85 {
86 if (clustInLay.size() < 2) return;
87 std::vector<unsigned int> histogram{};
88 const unsigned int firstCh = m_idHelperSvc->mmIdHelper().channel(clustInLay[0]);
89 const unsigned int lastCh = m_idHelperSvc->mmIdHelper().channel(clustInLay[clustInLay.size() -1]);
91 const unsigned int deltaCh = lastCh - firstCh;
92 const unsigned int nBins = deltaCh / m_binWidth + (deltaCh % m_binWidth > 0);
93 if (!nBins) return;
94 histogram.resize(nBins);
95 for (const Identifier&id : clustInLay) {
96 const int bin_num = (m_idHelperSvc->mmIdHelper().channel(id) - firstCh) %nBins;
97 ++(histogram[bin_num]);
98 }
99 for (unsigned int occup : histogram){
100 if (occup) m_singleBinOccupancy->Fill(occup);
101 }
102 for (unsigned int i = 0 ; i < histogram.size() -1 ; ++i){
103 unsigned int pair = histogram[i]+ histogram[i+1];
104 if (!pair) continue;
105 m_pairBinOccupancy->Fill(pair);
106
107 if (histogram[i]) m_pairVsSingleOccupancy->Fill(histogram[i], pair);
108 if (histogram[i+1]) m_pairVsSingleOccupancy->Fill(histogram[i+1], pair);
109
110 }
111
112}
std::string histogram
Definition chains.cxx:52
TH1 * m_pairVsSingleOccupancy
Gaudi::Property< unsigned int > m_binWidth

◆ filterPassed()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx) const
inlinevirtualinherited

Get filter decision:

Definition at line 93 of file AthCommonAlgorithm.h.

93 {
94 return execState( ctx ).filterPassed();
95 }
virtual bool filterPassed(const EventContext &ctx) const
Get filter decision:

◆ graph()

TGraph * AthHistogramming::graph ( const std::string & graphName,
const std::string & tDir = "",
const std::string & stream = "" )
protectedinherited

Simplify the retrieval of registered TGraphs.

Definition at line 442 of file AthHistogramming.cxx.

443{
444 // Build a 32 bit hash out of the name
445 const hash_t graphHash = this->hash(graphName);
446
447 // See if this entry exists in the map
448 GraphMap_t::const_iterator it = m_graphMap.find( graphHash );
449 if ( it == m_graphMap.end() ) // It doesn't exist!
450 { // Let's see into the THistSvc if somebody else has registered the TGraph...
451
452 // Need to copy the strings as we will massage them from here on
453 std::string graphNameCopy = graphName;
454 std::string tDirCopy = tDir;
455 std::string streamCopy = stream;
456
457 // Massage the final string to book things
458 std::string bookingString = buildBookingString( graphNameCopy, tDirCopy, streamCopy, false);
459
460 TGraph* graphPointer(nullptr);
461 if ( !((histSvc()->getGraph(bookingString, graphPointer)).isSuccess()) )
462 {
463 // Massage the final string to book things
464 std::string bookingString = buildBookingString( graphNameCopy, tDirCopy, streamCopy, true );
465
466 if ( !((histSvc()->getGraph(bookingString, graphPointer)).isSuccess()) )
467 {
468 m_msg << MSG::WARNING
469 << "Problem retrieving the TGraph with name (including pre- and post-fixes) "
470 << m_histNamePrefix + graphNameCopy + m_histNamePostfix
471 << " or with name " << graphNameCopy
472 << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
473 << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
474 return nullptr;
475 }
476 // If we get to here, we actually found the TGraph in the THistSvc.
477 // So let's add it to the local cache map and return its pointer
478 m_graphMap.insert( m_graphMap.end(), std::pair< const hash_t, TGraph* >( graphHash, graphPointer ) );
479 return graphPointer;
480 }
481 // If we get to here, we actually found the TGraph in the THistSvc.
482 // So let's add it to the local cache map and return its pointer
483 m_graphMap.insert( m_graphMap.end(), std::pair< const hash_t, TGraph* >( graphHash, graphPointer ) );
484 return graphPointer;
485 }
486
487
488 // Return the pointer to the TGraph that we got from the local cache map
489 return it->second;
490}
std::pair< StatusCode, TGraph * > getGraph(ITHistSvc &svc, const std::string &name)

◆ hash()

AthHistogramming::hash_t AthHistogramming::hash ( const std::string & histName) const
inlineprivateinherited

Method to calculate a 32-bit hash from a string.

Definition at line 429 of file AthHistogramming.h.

430{
431 const uint64_t hash64 = CxxUtils::crc64( histName );
432 return (hash_t)(hash64 & 0xFFFFFFFF);
433}
uint64_t crc64(const CRCTable &table, const char *data, size_t data_len)
Find the CRC-64 of a string,.
Definition crc64.cxx:696
std::uint64_t hash64(const void *data, std::size_t size)
Passthrough to XXH3_64bits.
Definition XXH.cxx:9

◆ hist()

TH1 * AthHistogramming::hist ( std::string_view histName,
const std::string & tDir = "",
const std::string & stream = "" )
protectedinherited

Simplify the retrieval of registered histograms of any type.

Definition at line 161 of file AthHistogramming.cxx.

164{
165 std::string histNameCopy{histName};
166 std::string tDirCopy = tDir;
167 std::string streamCopy = stream;
168
169 std::string bookingString = buildBookingString(histNameCopy, tDirCopy, streamCopy, false);
170
171 const hash_t histHash = this->hash(histNameCopy);
172
173 HistMap_t::const_iterator it = m_histMap.find(histHash);
174 if (it == m_histMap.end()) {
175 TH1* histPointer(nullptr);
176
177 if (!histSvc()->getHist(bookingString, histPointer).isSuccess()) {
178 std::string prefixedHistNameCopy{histName};
179 std::string prefixedTDirCopy = tDir;
180 std::string prefixedStreamCopy = stream;
181
182 std::string prefixedBookingString = buildBookingString(prefixedHistNameCopy,
183 prefixedTDirCopy,
184 prefixedStreamCopy,
185 true);
186
187 if (!histSvc()->getHist(prefixedBookingString, histPointer).isSuccess()) {
188 m_msg << MSG::WARNING
189 << "Problem retrieving the histogram with name (including pre- and post-fixes) "
190 << m_histNamePrefix + histNameCopy + m_histNamePostfix
191 << " or with name " << histNameCopy
192 << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
193 << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
194 return nullptr;
195 }
196 }
197
198 m_histMap.insert(m_histMap.end(), std::pair<const hash_t, TH1*>(histHash, histPointer));
199 return histPointer;
200 }
201
202 return it->second;
203}
std::pair< StatusCode, TH1 * > getHist(ITHistSvc &svc, const std::string &name, size_t index=0)

◆ hist2d()

TH2 * AthHistogramming::hist2d ( std::string_view histName,
const std::string & tDir = "",
const std::string & stream = "" )
inlineprotectedinherited

Simplify the retrieval of registered 2-d histograms.

Definition at line 370 of file AthHistogramming.h.

371{
372 // Get the TH1 pointer
373 TH1* th1Pointer = this->hist(histName, tDir, stream);
374 if ( !th1Pointer )
375 {
376 m_msg << MSG::ERROR
377 << "Cannot get a 2-d histogram with name " << histName
378 << "... will probably seg-fault!" << endmsg;
379 return NULL;
380 }
381 // If the TH1 pointer is valid, simply return the dynamic_cast
382 return dynamic_cast<TH2*>( th1Pointer );
383}

◆ hist3d()

TH3 * AthHistogramming::hist3d ( std::string_view histName,
const std::string & tDir = "",
const std::string & stream = "" )
inlineprotectedinherited

Simplify the retrieval of registered 3-d histograms.

Definition at line 387 of file AthHistogramming.h.

388{
389 // Get the TH1 pointer
390 TH1* th1Pointer = this->hist(histName, tDir, stream);
391 if ( !th1Pointer )
392 {
393 m_msg << MSG::ERROR
394 << "Cannot get a 3-d histogram with name " << histName
395 << "... will probably seg-fault!" << endmsg;
396 return NULL;
397 }
398 // If the TH1 pointer is valid, simply return the dynamic_cast
399 return dynamic_cast<TH3*>( th1Pointer );
400}

◆ histSvc()

const ServiceHandle< ITHistSvc > & AthHistogramAlgorithm::histSvc ( ) const
inlineinherited

The standard THistSvc (for writing histograms and TTrees and more to a root file) Returns (kind of) a pointer to the THistSvc.

Definition at line 113 of file AthHistogramAlgorithm.h.

114{
115 return m_histSvc;
116}
ServiceHandle< ITHistSvc > m_histSvc
Default constructor: AthHistogramAlgorithm();.

◆ initialize()

StatusCode NswOccupancyAlg::initialize ( )
override

Definition at line 14 of file NswOccupancyAlg.cxx.

14 {
15 ATH_CHECK(m_idHelperSvc.retrieve());
16 ATH_CHECK(m_patternCollKey.initialize());
17 std::stringstream selection_title{};
18 selection_title<<"Bin size "<<m_binWidth.value()<<";";
19 selection_title<<"Hit occupancy;";
20 m_singleBinOccupancy = new TH1I("SingleBinOccupancy", selection_title.str().c_str(), 50, 0, 50);
21 m_pairBinOccupancy = new TH1I("PairBinOccupancy", selection_title.str().c_str(), 50, 0, 50);
22 selection_title<<"; Pair occupancy";
23 m_pairVsSingleOccupancy = new TH2I("PairVsSingleOccupancy",selection_title.str().c_str(), 50,0,50,50,0,50);
24 std::stringstream folderName{};
25 folderName<<"/"<<m_fileStream.value()<<"/OccupancyBinWidth"<<m_binWidth.value()<<"/";
26 ATH_MSG_INFO("Write out histograms in "<<folderName.str());
28 ATH_CHECK(histSvc()->regHist(folderName.str() + m_pairBinOccupancy->GetName(), m_pairBinOccupancy));
30
31 return StatusCode::SUCCESS;
32}
#define ATH_CHECK
Evaluate an expression and check for errors.
#define ATH_MSG_INFO(x,...)
const ServiceHandle< ITHistSvc > & histSvc() const
The standard THistSvc (for writing histograms and TTrees and more to a root file) Returns (kind of) a...
Gaudi::Property< std::string > m_fileStream

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

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::isClonable ( ) const
inlineoverridevirtualinherited

Specify if the algorithm is clonable.

Only relevant for non-reentrant algorithms. Actual number of clones needs to be set via the "Cardinality" property.

Reimplemented in AFP_DigiTop, AlgB, AlgT, BCM_Digitization, CscDigitBuilder, CscDigitToCscRDO, G4AtlasAlg, G4RunAlg, HGTD_Digitization, HiveAlgBase, InDet::GNNSeedingTrackMaker, InDet::SCT_Clusterization, InDet::SiSPGNNTrackMaker, InDet::SiSPSeededTrackFinder, InDet::SiTrackerSpacePointFinder, ISF::SimKernelMT, ITk::StripDigitization, ITkPixelCablingAlg, ITkStripCablingAlg, LArHitEMapMaker, LArTTL1Maker, LUCID_DigiTop, LVL1::L1TopoSimulation, MergeCalibHits, MergeGenericMuonSimHitColl, MergeHijingPars, MergeMcEventCollection, MergeTrackRecordCollection, MergeTruthJets, MergeTruthParticles, MuonDigitizer, PileUpMTAlg, PixelDigitization, RoIBResultToxAOD, SCT_ByteStreamErrorsTestAlg, SCT_CablingCondAlgFromCoraCool, SCT_CablingCondAlgFromText, SCT_ConditionsParameterTestAlg, SCT_ConditionsSummaryTestAlg, SCT_ConfigurationConditionsTestAlg, SCT_Digitization, SCT_FlaggedConditionTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_PrepDataToxAOD, SCT_RawDataToxAOD, SCT_ReadCalibChipDataTestAlg, SCT_ReadCalibDataTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_SiliconConditionsTestAlg, SCT_StripVetoTestAlg, SCT_TdaqEnabledTestAlg, SCT_TestCablingAlg, SCTEventFlagWriter, SCTRawDataProvider, SCTSiLorentzAngleTestAlg, SCTSiPropertiesTestAlg, SGInputLoader, Simulation::BeamEffectsAlg, TileHitVecToCnt, TileMuonFitter, TilePulseForTileMuonReceiver, TileRawChannelMaker, TRTDigitization, and ZDC_DigiTop.

Definition at line 68 of file AthCommonAlgorithm.h.

68 {
69 return true;
70 }

◆ isReEntrant()

virtual bool AthAlgorithm::isReEntrant ( ) const
inlinefinaloverrideprotectedvirtualinherited

Legacy algorithms are not thread-safe.

Definition at line 47 of file AthAlgorithm.h.

47{ 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 }

◆ myReplace()

void AthHistogramming::myReplace ( std::string & str,
const std::string & oldStr,
const std::string & newStr )
privateinherited

Helper method to replace sub-string.

Definition at line 537 of file AthHistogramming.cxx.

540{
541 size_t pos = 0;
542 while((pos = str.find(oldStr, pos)) != std::string::npos)
543 {
544 str.replace(pos, oldStr.length(), newStr);
545 pos += newStr.length();
546 }
547}

◆ 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 AthCommonAlgorithm< Gaudi::Algorithm >::setFilterPassed ( bool state,
const EventContext & ctx ) const
inlinevirtualinherited

Set filter decision:

Reimplemented in AthFilterAlgorithm.

Definition at line 99 of file AthCommonAlgorithm.h.

99 {
101 }
virtual void setFilterPassed(bool state, const EventContext &ctx) const
Set filter decision:

◆ sortByLayer()

std::vector< std::vector< Identifier > > NswOccupancyAlg::sortByLayer ( std::vector< Identifier > & micromegaHits) const
private

Definition at line 64 of file NswOccupancyAlg.cxx.

64 {
65 LayerVec layerVec;
66 std::stable_sort(micromegaHits.begin(), micromegaHits.end(),[this](const Identifier& a, const Identifier& b){
67 return m_idHelperSvc->gasGapId(a) < m_idHelperSvc->gasGapId(b);
68 });
69 std::set<Identifier> unique_set{};
70 for (const Identifier& id : micromegaHits) {
71 if (!unique_set.insert(id).second) continue;
72 if (layerVec.empty() || m_idHelperSvc->gasGapId(id) != m_idHelperSvc->gasGapId(layerVec.back().back()) ){
73 layerVec.emplace_back();
74 layerVec.back().reserve(micromegaHits.size());
75 }
76 layerVec.back().push_back(id);
77 }
78 for (Layer& lay : layerVec) {
79 std::sort(lay.begin(),lay.end(),[this] (const Identifier&a ,const Identifier& b){
80 return m_idHelperSvc->mmIdHelper().channel(a) < m_idHelperSvc->mmIdHelper().channel(b);
81 });
82 }
83 return layerVec;
84}
static Double_t a
void sort(typename DataModel_detail::iterator< DVL > beg, typename DataModel_detail::iterator< DVL > end)
Specialization of sort for DataVector/List.
void stable_sort(DataModel_detail::iterator< DVL > beg, DataModel_detail::iterator< DVL > end)
Specialization of stable_sort for DataVector/List.

◆ sysExecute()

StatusCode AthCommonAlgorithm< 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.

Reimplemented in AthAnalysisAlgorithm.

Definition at line 80 of file AthCommonAlgorithm.cxx.

41{
42 return BaseAlg::sysExecute (ctx);
43}

◆ sysInitialize()

StatusCode AthHistogramAlgorithm::sysInitialize ( )
virtualinherited

Initialization method invoked by the framework.

This method is responsible for any bookkeeping of initialization required by the framework itself. It will in turn invoke the initialize() method of the derived algorithm, and of any sub-algorithms which it creates.

Reimplemented from AthCommonAlgorithm< Gaudi::Algorithm >.

Reimplemented in AthAnalysisAlgorithm.

Definition at line 75 of file AthHistogramAlgorithm.cxx.

76{
77 // ---- stolen from GaudiKernel/Algorithm::sysInitialize -------
78 // Bypass the initialization if the algorithm
79 // has already been initialized.
80 if ( Gaudi::StateMachine::INITIALIZED <= FSMState() ) return StatusCode::SUCCESS;
81
82 // Set the Algorithm's properties
83 bindPropertiesTo( serviceLocator()->getOptsSvc() );
84
85 // Bypass the initialization if the algorithm is disabled.
86 // Need to do this after bindPropertiesTo.
87 if ( !isEnabled( ) ) return StatusCode::SUCCESS;
88
89 // ---- stolen from GaudiKernel/Algorithm::sysInitialize ------- END ---
90
91
92 // Get the THistSvc
93 ATH_CHECK ( histSvc().retrieve() );
94
95 // Configure the underlying AthHistogramming helper
100
101 // Print some setup information into the log file
102 ATH_MSG_DEBUG ("Initializing " << name() << "...");
103 ATH_MSG_DEBUG (" using THistService = " << m_histSvc );
104 ATH_MSG_DEBUG (" using RootStreamName = " << m_prefix );
105 ATH_MSG_DEBUG (" using RootDirName = " << m_rootDir );
106 ATH_MSG_DEBUG (" using HistNamePrefix = " << m_histNamePrefix );
107 ATH_MSG_DEBUG (" using HistNamePostfix = " << m_histNamePostfix );
108 ATH_MSG_DEBUG (" using HistTitlePrefix = " << m_histTitlePrefix );
109 ATH_MSG_DEBUG (" using HistTitlePostfix = " << m_histTitlePostfix );
110
111
112 // re-direct to base class...
114}
#define ATH_MSG_DEBUG(x,...)
virtual StatusCode sysInitialize() override
std::string m_histNamePrefix
The prefix for the histogram THx name.
std::string m_prefix
Name of the ROOT output stream (file).
std::string m_histNamePostfix
The postfix for the histogram THx name.
std::string m_histTitlePostfix
The postfix for the histogram THx title.
std::string m_rootDir
Name of the ROOT directory.
std::string m_histTitlePrefix
The prefix for the histogram THx title.
StatusCode configAthHistogramming(const ServiceHandle< ITHistSvc > &histSvc, const std::string &prefix, const std::string &rootDir, const std::string &histNamePrefix, const std::string &histNamePostfix, const std::string &histTitlePrefix, const std::string &histTitlePostfix)
To be called by the derived classes to fill the internal configuration.

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

◆ tree()

TTree * AthHistogramming::tree ( const std::string & treeName,
const std::string & tDir = "",
const std::string & stream = "" )
protectedinherited

Simplify the retrieval of registered TTrees.

Definition at line 330 of file AthHistogramming.cxx.

331{
332 // Build a 32 bit hash out of the name
333 const hash_t treeHash = this->hash(treeName);
334
335 // See if this entry exists in the map
336 TreeMap_t::const_iterator it = m_treeMap.find( treeHash );
337 if ( it == m_treeMap.end() ) // It doesn't exist!
338 { // Let's see into the THistSvc if somebody else has registered the TTree...
339
340 // Need to copy the strings as we will massage them from here on
341 std::string treeNameCopy = treeName;
342 std::string tDirCopy = tDir;
343 std::string streamCopy = stream;
344
345 // Massage the final string to book things
346 std::string bookingString = buildBookingString( treeNameCopy, tDirCopy, streamCopy );
347
348 TTree* treePointer(NULL);
349 if ( !((histSvc()->getTree(bookingString, treePointer)).isSuccess()) )
350 {
351 m_msg << MSG::WARNING
352 << "Problem retrieving the TTree with name " << treeNameCopy
353 << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
354 << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
355 return NULL;
356 }
357 // If we get to here, we actually found the TTree in the THistSvc.
358 // So let's add it to the local cache map and return its pointer
359 m_treeMap.insert( m_treeMap.end(), std::pair< const hash_t, TTree* >( treeHash, treePointer ) );
360 return treePointer;
361 }
362
363 // Return the pointer to the TTree that we got from the local cache map
364 return it->second;
365}
std::pair< StatusCode, TTree * > getTree(ITHistSvc &svc, const std::string &name)

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

Gaudi::Property<unsigned int> NswOccupancyAlg::m_binWidth {this, "BinWidth", 100}
private

Definition at line 41 of file NswOccupancyAlg.h.

41{this, "BinWidth", 100};

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

EffMap_t AthHistogramming::m_effMap
privateinherited

The map of histogram names to their pointers.

Definition at line 209 of file AthHistogramming.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 AthCommonAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects
privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 108 of file AthCommonAlgorithm.h.

◆ m_fileStream

Gaudi::Property<std::string> NswOccupancyAlg::m_fileStream {this, "FileStream", "NSWSTORIES"}
private

Definition at line 40 of file NswOccupancyAlg.h.

40{this, "FileStream", "NSWSTORIES"};

◆ m_graphMap

GraphMap_t AthHistogramming::m_graphMap
privateinherited

The map of TGraph names to their pointers.

Definition at line 223 of file AthHistogramming.h.

◆ m_histMap

HistMap_t AthHistogramming::m_histMap
privateinherited

The map of histogram names to their pointers.

Definition at line 202 of file AthHistogramming.h.

◆ m_histNamePostfix

std::string AthHistogramAlgorithm::m_histNamePostfix
privateinherited

The postfix for the histogram THx name.

Definition at line 97 of file AthHistogramAlgorithm.h.

◆ m_histNamePrefix

std::string AthHistogramAlgorithm::m_histNamePrefix
privateinherited

The prefix for the histogram THx name.

Definition at line 94 of file AthHistogramAlgorithm.h.

◆ m_histSvc

ServiceHandle<ITHistSvc> AthHistogramAlgorithm::m_histSvc
privateinherited

Default constructor: AthHistogramAlgorithm();.

a handle on the Hist/TTree registration service

Definition at line 83 of file AthHistogramAlgorithm.h.

◆ m_histTitlePostfix

std::string AthHistogramAlgorithm::m_histTitlePostfix
privateinherited

The postfix for the histogram THx title.

Definition at line 103 of file AthHistogramAlgorithm.h.

◆ m_histTitlePrefix

std::string AthHistogramAlgorithm::m_histTitlePrefix
privateinherited

The prefix for the histogram THx title.

Definition at line 100 of file AthHistogramAlgorithm.h.

◆ m_idHelperSvc

ServiceHandle<Muon::IMuonIdHelperSvc> NswOccupancyAlg::m_idHelperSvc
private
Initial value:
{ this, "MuonIdHelperSvc",
"Muon::MuonIdHelperSvc/MuonIdHelperSvc"}

Definition at line 22 of file NswOccupancyAlg.h.

22 { this, "MuonIdHelperSvc",
23 "Muon::MuonIdHelperSvc/MuonIdHelperSvc"};

◆ m_msg

MsgStream AthHistogramming::m_msg
privateinherited

Cached Message Stream.

Definition at line 249 of file AthHistogramming.h.

◆ m_name

std::string AthHistogramming::m_name
privateinherited

Instance name.

Definition at line 246 of file AthHistogramming.h.

◆ m_pairBinOccupancy

TH1* NswOccupancyAlg::m_pairBinOccupancy {nullptr}
private

Definition at line 44 of file NswOccupancyAlg.h.

44{nullptr};

◆ m_pairVsSingleOccupancy

TH1* NswOccupancyAlg::m_pairVsSingleOccupancy {nullptr}
private

Definition at line 45 of file NswOccupancyAlg.h.

45{nullptr};

◆ m_patternCollKey

SG::ReadHandleKey<MuonPatternCombinationCollection> NswOccupancyAlg::m_patternCollKey
private
Initial value:
{
this,
"MuonLayerHoughCombisKey",
"MuonLayerHoughCombis",
"Hough combinations",
}

Definition at line 33 of file NswOccupancyAlg.h.

33 {
34 this,
35 "MuonLayerHoughCombisKey",
36 "MuonLayerHoughCombis",
37 "Hough combinations",
38 };

◆ m_prefix

std::string AthHistogramAlgorithm::m_prefix
privateinherited

Name of the ROOT output stream (file).

Definition at line 88 of file AthHistogramAlgorithm.h.

◆ m_rootDir

std::string AthHistogramAlgorithm::m_rootDir
privateinherited

Name of the ROOT directory.

Definition at line 91 of file AthHistogramAlgorithm.h.

◆ m_singleBinOccupancy

TH1* NswOccupancyAlg::m_singleBinOccupancy {nullptr}
private

Definition at line 43 of file NswOccupancyAlg.h.

43{nullptr};

◆ m_streamName

std::string AthHistogramming::m_streamName
privateinherited

Name of the ROOT output stream (file).

Definition at line 227 of file AthHistogramming.h.

◆ m_treeMap

TreeMap_t AthHistogramming::m_treeMap
privateinherited

The map of TTree names to their pointers.

Definition at line 216 of file AthHistogramming.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.


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