ATLAS Offline Software
OnDemandMinbiasSvc.h
Go to the documentation of this file.
1 /* -*- C++ -*- */
2 /*
3  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
4 */
5 
6 #ifndef PILEUPMT_ONDEMANDMINBIASSVC_H
7 #define PILEUPMT_ONDEMANDMINBIASSVC_H
8 
9 #include <atomic>
10 #include <deque>
11 #include <format>
12 #include <map>
13 #include <memory>
14 #include <mutex>
15 #include <string>
16 #include <vector>
17 
19 #include "Gaudi/Property.h"
20 #include "GaudiKernel/IEvtSelector.h"
21 #include "GaudiKernel/ServiceHandle.h"
22 #include "PileUpMT/IMinbiasSvc.h"
25 #include "StoreGate/StoreGateSvc.h"
26 #include "src/ISkipEventIdxSvc.h"
27 
28 class OnDemandMinbiasSvc final : public extends<AthService, IMinbiasSvc> {
29  public:
31  OnDemandMinbiasSvc(const std::string& name, ISvcLocator* svc);
33  ~OnDemandMinbiasSvc() final;
34 
36  StatusCode initialize() final;
37 
38  StatusCode beginHardScatter(const EventContext& ctx) override;
39  StoreGateSvc* getMinbias(const EventContext& ctx,
40  std::uint64_t mb_id) override;
41  std::size_t getNumForBunch(const EventContext& ctx, int bunch) const override;
42  inline virtual
43  std::int64_t get_hs_id(const EventContext& ctx) const override {
44  return m_skippedHSEvents.value() + ctx.evt();
45  }
46 
47  StatusCode endHardScatter(const EventContext& ctx) override;
48 
49  private:
51 
52  Gaudi::Property<std::uint64_t> m_seed{this, "Seed", 0,
53  "Additional seed for PRNGs"};
54  Gaudi::Property<bool> m_onDemandMB{
55  this, "OnDemandMB", false,
56  "Should minbias event contents be read on demand"};
57  Gaudi::Property<int> m_skippedHSEvents{this, "SkippedHSEvents", 0,
58  "Number of skipped HS events"};
59  Gaudi::Property<float> m_nPerBunch{
60  this, "AvgMBPerBunch", 0.f,
61  "Average (max) number of minbias events per bunch"};
62  Gaudi::Property<bool> m_usePoisson{this, "UsePoisson", true,
63  "Whether to use a Poisson distribution "
64  "(if False, use a delta distribution)"};
65  Gaudi::Property<bool> m_useBeamInt{
66  this, "UseBeamInt", true, "Whether to use the beam intensity service"};
67  Gaudi::Property<bool> m_useBeamLumi{
68  this, "UseBeamLumi", true, "Whether to use the beam luminosity service"};
69  Gaudi::Property<int> m_earliestDeltaBC{
70  this, "EarliestDeltaBC", -32,
71  "Earliest bunch crossing to consider (as delta)"};
72  Gaudi::Property<int> m_latestDeltaBC{
73  this, "LatestDeltaBC", +6,
74  "Latest bunch crossing to consider (as delta)"};
76  this, "SkipEvtIdxSvc", "SkipEventIdxSvc",
77  "Skipped event index (run / lb num) provider"};
79  this, "BkgEventSelector", {}, "Event selector for minbias events"};
80  ServiceHandle<IBeamIntensity> m_beamInt{this, "BeamIntSvc", "FlatBM",
81  "Beam intensity service"};
83  this, "BeamLumiSvc", "LumiProfileSvc", "Beam luminosity service"};
85  this, "ActiveStoreSvc", "ActiveStoreSvc", "ActiveStoreSvc"};
86 
87  SGHandle m_spare_store{this, "StoreGateSvc",
88  std::format("StoreGateSvc/discards_{}", name()),
89  "StoreGate for discarding events"};
90  IEvtSelector::Context* m_bkg_evt_sel_ctx;
92 
93  std::vector<std::vector<SGHandle>> m_stores;
94  std::vector<std::vector<std::uint64_t>> m_num_mb_by_bunch;
95  std::vector<std::vector<std::uint64_t>> m_idx_lists;
96  // prevents attempting to read multiple batches at once
98  std::atomic_int64_t m_last_loaded_hs{-1};
99 
100  static constexpr std::size_t s_NoSlot =
101  std::numeric_limits<std::size_t>::max(); // "slot" to pass when we don't
102  // have a slot
103  std::size_t calcMBRequired(std::int64_t hs_id, std::size_t slot,
104  unsigned int run, unsigned int lumi,
106 };
107 
108 #endif // PILEUPMT_ONDEMANDMINBIASSVC_H
ISkipEventIdxSvc.h
OnDemandMinbiasSvc::m_beamLumi
ServiceHandle< IBeamLuminosity > m_beamLumi
Definition: OnDemandMinbiasSvc.h:82
vtune_athena.format
format
Definition: vtune_athena.py:14
BeamSpot::mutex
std::mutex mutex
Definition: InDetBeamSpotVertex.cxx:18
max
constexpr double max()
Definition: ap_fixedTest.cxx:33
OnDemandMinbiasSvc::m_useBeamInt
Gaudi::Property< bool > m_useBeamInt
Definition: OnDemandMinbiasSvc.h:65
OnDemandMinbiasSvc::m_num_mb_by_bunch
std::vector< std::vector< std::uint64_t > > m_num_mb_by_bunch
Definition: OnDemandMinbiasSvc.h:94
OnDemandMinbiasSvc::OnDemandMinbiasSvc
OnDemandMinbiasSvc(const std::string &name, ISvcLocator *svc)
Constructor.
Definition: OnDemandMinbiasSvc.cxx:30
OnDemandMinbiasSvc::m_skipEventIdxSvc
ServiceHandle< ISkipEventIdxSvc > m_skipEventIdxSvc
Definition: OnDemandMinbiasSvc.h:75
OnDemandMinbiasSvc::calcMBRequired
std::size_t calcMBRequired(std::int64_t hs_id, std::size_t slot, unsigned int run, unsigned int lumi, std::uint64_t event)
Definition: OnDemandMinbiasSvc.cxx:148
OnDemandMinbiasSvc::m_bkgEventSelector
ServiceHandle< IEvtSelector > m_bkgEventSelector
Definition: OnDemandMinbiasSvc.h:78
OnDemandMinbiasSvc::m_idx_lists
std::vector< std::vector< std::uint64_t > > m_idx_lists
Definition: OnDemandMinbiasSvc.h:95
OnDemandMinbiasSvc::m_usePoisson
Gaudi::Property< bool > m_usePoisson
Definition: OnDemandMinbiasSvc.h:62
OnDemandMinbiasSvc::m_proxyProviderSvc
ServiceHandle< IProxyProviderSvc > m_proxyProviderSvc
Definition: OnDemandMinbiasSvc.h:91
OnDemandMinbiasSvc::~OnDemandMinbiasSvc
~OnDemandMinbiasSvc() final
Destructor.
Definition: OnDemandMinbiasSvc.cxx:38
StoreGateSvc
The Athena Transient Store API.
Definition: StoreGateSvc.h:120
OnDemandMinbiasSvc::get_hs_id
virtual std::int64_t get_hs_id(const EventContext &ctx) const override
Definition: OnDemandMinbiasSvc.h:43
IMinbiasSvc.h
OnDemandMinbiasSvc::getMinbias
StoreGateSvc * getMinbias(const EventContext &ctx, std::uint64_t mb_id) override
Definition: OnDemandMinbiasSvc.cxx:295
event
POOL::TEvent event(POOL::TEvent::kClassAccess)
OnDemandMinbiasSvc::m_last_loaded_hs
std::atomic_int64_t m_last_loaded_hs
Definition: OnDemandMinbiasSvc.h:98
OnDemandMinbiasSvc::m_onDemandMB
Gaudi::Property< bool > m_onDemandMB
Definition: OnDemandMinbiasSvc.h:54
EL::StatusCode
::StatusCode StatusCode
StatusCode definition for legacy code.
Definition: PhysicsAnalysis/D3PDTools/EventLoop/EventLoop/StatusCode.h:22
OnDemandMinbiasSvc::m_useBeamLumi
Gaudi::Property< bool > m_useBeamLumi
Definition: OnDemandMinbiasSvc.h:67
OnDemandMinbiasSvc::s_NoSlot
static constexpr std::size_t s_NoSlot
Definition: OnDemandMinbiasSvc.h:100
OnDemandMinbiasSvc::beginHardScatter
StatusCode beginHardScatter(const EventContext &ctx) override
Definition: OnDemandMinbiasSvc.cxx:215
xAOD::uint64_t
uint64_t
Definition: EventInfo_v1.cxx:123
OnDemandMinbiasSvc::m_stores
std::vector< std::vector< SGHandle > > m_stores
Definition: OnDemandMinbiasSvc.h:93
run
Definition: run.py:1
Handler::svc
AthROOTErrorHandlerSvc * svc
Definition: AthROOTErrorHandlerSvc.cxx:10
columnar::final
CM final
Definition: ColumnAccessor.h:106
OnDemandMinbiasSvc::m_bkg_evt_sel_ctx
IEvtSelector::Context * m_bkg_evt_sel_ctx
Definition: OnDemandMinbiasSvc.h:90
OnDemandMinbiasSvc::initialize
StatusCode initialize() final
AthService initialize.
Definition: OnDemandMinbiasSvc.cxx:40
OnDemandMinbiasSvc::m_nPerBunch
Gaudi::Property< float > m_nPerBunch
Definition: OnDemandMinbiasSvc.h:59
OnDemandMinbiasSvc::m_latestDeltaBC
Gaudi::Property< int > m_latestDeltaBC
Definition: OnDemandMinbiasSvc.h:72
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:240
OnDemandMinbiasSvc::endHardScatter
StatusCode endHardScatter(const EventContext &ctx) override
Definition: OnDemandMinbiasSvc.cxx:312
OnDemandMinbiasSvc::m_skippedHSEvents
Gaudi::Property< int > m_skippedHSEvents
Definition: OnDemandMinbiasSvc.h:57
OnDemandMinbiasSvc::m_beamInt
ServiceHandle< IBeamIntensity > m_beamInt
Definition: OnDemandMinbiasSvc.h:80
lumiFormat.lumi
lumi
Definition: lumiFormat.py:106
IBeamIntensity.h
provides the relative beam intensity as a function of the bunch xing.
OnDemandMinbiasSvc::getNumForBunch
std::size_t getNumForBunch(const EventContext &ctx, int bunch) const override
Definition: OnDemandMinbiasSvc.cxx:302
AthService.h
OnDemandMinbiasSvc::m_reading_batch_mtx
std::mutex m_reading_batch_mtx
Definition: OnDemandMinbiasSvc.h:97
OnDemandMinbiasSvc::m_earliestDeltaBC
Gaudi::Property< int > m_earliestDeltaBC
Definition: OnDemandMinbiasSvc.h:69
OnDemandMinbiasSvc
Definition: OnDemandMinbiasSvc.h:28
OnDemandMinbiasSvc::m_activeStoreSvc
ServiceHandle< ActiveStoreSvc > m_activeStoreSvc
Definition: OnDemandMinbiasSvc.h:84
StoreGateSvc.h
OnDemandMinbiasSvc::m_spare_store
SGHandle m_spare_store
Definition: OnDemandMinbiasSvc.h:87
IBeamLuminosity.h
provides the relative beam luminosity as a function of the bunch xing.
OnDemandMinbiasSvc::m_seed
Gaudi::Property< std::uint64_t > m_seed
Definition: OnDemandMinbiasSvc.h:52
ServiceHandle< StoreGateSvc >