LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
phot::PDFastSimPVS Class Reference
Inheritance diagram for phot::PDFastSimPVS:
art::EDProducer art::detail::Producer art::detail::LegacyModule art::Modifier art::ModuleBase art::ProductRegistryHelper

Public Types

using ModuleType = EDProducer
 
template<typename UserConfig , typename KeysToIgnore = void>
using Table = Modifier::Table< UserConfig, KeysToIgnore >
 

Public Member Functions

 PDFastSimPVS (fhicl::ParameterSet const &)
 
void produce (art::Event &) override
 
void AddOpDetBTR (std::vector< sim::OpDetBacktrackerRecord > &opbtr, std::vector< int > &ChannelMap, const sim::OpDetBacktrackerRecord &btr) const
 
void doBeginJob (SharedResources const &resources)
 
void doEndJob ()
 
void doRespondToOpenInputFile (FileBlock const &fb)
 
void doRespondToCloseInputFile (FileBlock const &fb)
 
void doRespondToOpenOutputFiles (FileBlock const &fb)
 
void doRespondToCloseOutputFiles (FileBlock const &fb)
 
bool doBeginRun (RunPrincipal &rp, ModuleContext const &mc)
 
bool doEndRun (RunPrincipal &rp, ModuleContext const &mc)
 
bool doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
 
bool doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
 
bool doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)
 
void fillProductDescriptions ()
 
void registerProducts (ProductDescriptions &productsToRegister)
 
ModuleDescription const & moduleDescription () const
 
void setModuleDescription (ModuleDescription const &)
 
std::array< std::vector< ProductInfo >, NumBranchTypes > const & getConsumables () const
 
void sortConsumables (std::string const &current_process_name)
 
std::unique_ptr< Worker > makeWorker (WorkerParams const &wp)
 
template<typename T , BranchType BT>
ViewToken< T > consumesView (InputTag const &tag)
 
template<typename T , BranchType BT>
ViewToken< T > mayConsumeView (InputTag const &tag)
 

Protected Member Functions

ConsumesCollector & consumesCollector ()
 
template<typename T , BranchType = InEvent>
ProductToken< T > consumes (InputTag const &)
 
template<typename Element , BranchType = InEvent>
ViewToken< Element > consumesView (InputTag const &)
 
template<typename T , BranchType = InEvent>
void consumesMany ()
 
template<typename T , BranchType = InEvent>
ProductToken< T > mayConsume (InputTag const &)
 
template<typename Element , BranchType = InEvent>
ViewToken< Element > mayConsumeView (InputTag const &)
 
template<typename T , BranchType = InEvent>
void mayConsumeMany ()
 

Private Attributes

art::ServiceHandle< PhotonVisibilityService const > fPVS
 
const bool fDoFastComponent
 
const bool fDoSlowComponent
 
const bool fIncludePropTime
 
const bool fUseLitePhotons
 
const bool fStoreReflected
 
const size_t fNOpChannels
 
const art::InputTag fSimTag
 
CLHEP::HepRandomEngine & fPhotonEngine
 
std::unique_ptr< CLHEP::RandPoissonQ > fRandPoissPhot
 
CLHEP::HepRandomEngine & fScintTimeEngine
 
std::unique_ptr< ScintTimefScintTime
 
std::unique_ptr< PropagationTimeModelfPropTimeModel
 

Detailed Description

Definition at line 61 of file PDFastSimPVS_module.cc.

Member Typedef Documentation

Definition at line 17 of file EDProducer.h.

template<typename UserConfig , typename KeysToIgnore = void>
using art::detail::Producer::Table = Modifier::Table<UserConfig, KeysToIgnore>
inherited

Definition at line 26 of file Producer.h.

Constructor & Destructor Documentation

phot::PDFastSimPVS::PDFastSimPVS ( fhicl::ParameterSet const &  pset)
explicit

Definition at line 86 of file PDFastSimPVS_module.cc.

References art::errors::Configuration, art::detail::EngineCreator::createEngine(), fDoFastComponent, fDoSlowComponent, fIncludePropTime, fNOpChannels, fPhotonEngine, fPropTimeModel, fPVS, fRandPoissPhot, fScintTime, fScintTimeEngine, fSimTag, fStoreReflected, and fUseLitePhotons.

87  : art::EDProducer{pset}
89  , fDoFastComponent(pset.get<bool>("DoFastComponent", true))
90  , fDoSlowComponent(pset.get<bool>("DoSlowComponent", true))
91  , fIncludePropTime(pset.get<bool>("IncludePropTime", false))
93  , fStoreReflected(fPVS->StoreReflected())
94  , fNOpChannels(fPVS->NOpChannels())
95  , fSimTag{pset.get<art::InputTag>("SimulationLabel")}
97  createEngine(0, "HepJamesRandom", "photon"),
98  "HepJamesRandom",
99  "photon",
100  pset,
101  "SeedPhoton"))
102  , fRandPoissPhot(std::make_unique<CLHEP::RandPoissonQ>(fPhotonEngine))
104  createEngine(0, "HepJamesRandom", "scinttime"),
105  "HepJamesRandom",
106  "scinttime",
107  pset,
108  "SeedScintTime"))
109  , fScintTime{art::make_tool<phot::ScintTime>(pset.get<fhicl::ParameterSet>("ScintTimeTool"))}
110  {
111  mf::LogInfo("PDFastSimPVS") << "Initializing PDFastSimPVS." << std::endl;
112  fhicl::ParameterSet VUVTimingParams;
113  fhicl::ParameterSet VISTimingParams;
114  // Validate configuration options
115  if (fIncludePropTime &&
116  !pset.get_if_present<fhicl::ParameterSet>("VUVTiming", VUVTimingParams)) {
118  << "Propagation time simulation requested, but VUVTiming not specified."
119  << "\n";
120  }
122  !pset.get_if_present<fhicl::ParameterSet>("VISTiming", VISTimingParams)) {
124  << "Reflected light propagation time simulation requested, but VISTiming not specified."
125  << "\n";
126  }
127  // Initialise the Scintillation Time
128  fScintTime->initRand(fScintTimeEngine);
129 
130  // propagation time model
131  if (fIncludePropTime)
132  fPropTimeModel = std::make_unique<PropagationTimeModel>(
133  VUVTimingParams, VISTimingParams, fScintTimeEngine, fStoreReflected);
134 
135  if (fUseLitePhotons) {
136  mf::LogInfo("PDFastSimPVS") << "Use Lite Photon." << std::endl;
137  produces<std::vector<sim::SimPhotonsLite>>();
138  produces<std::vector<sim::OpDetBacktrackerRecord>>();
139 
140  if (fStoreReflected) {
141  mf::LogInfo("PDFastSimPVS") << "Store Reflected Photons";
142  produces<std::vector<sim::SimPhotonsLite>>("Reflected");
143  produces<std::vector<sim::OpDetBacktrackerRecord>>("Reflected");
144  }
145  }
146  else {
147  mf::LogInfo("PDFastSimPVS") << "Use Sim Photon.";
148  produces<std::vector<sim::SimPhotons>>();
149  if (fStoreReflected) {
150  mf::LogInfo("PDFastSimPVS") << "Store Reflected Photons";
151  produces<std::vector<sim::SimPhotons>>("Reflected");
152  }
153  }
154  mf::LogInfo("PDFastSimPVS") << "PDFastSimPVS Initialization finish" << std::endl;
155  }
base_engine_t & createEngine(seed_t seed)
CLHEP::HepRandomEngine & fPhotonEngine
const art::InputTag fSimTag
std::unique_ptr< ScintTime > fScintTime
MaybeLogger_< ELseverityLevel::ELsev_info, false > LogInfo
art::ServiceHandle< PhotonVisibilityService const > fPVS
std::unique_ptr< CLHEP::RandPoissonQ > fRandPoissPhot
cet::coded_exception< errors::ErrorCodes, ExceptionDetail::translate > Exception
Definition: Exception.h:66
std::unique_ptr< PropagationTimeModel > fPropTimeModel
CLHEP::HepRandomEngine & fScintTimeEngine

Member Function Documentation

void phot::PDFastSimPVS::AddOpDetBTR ( std::vector< sim::OpDetBacktrackerRecord > &  opbtr,
std::vector< int > &  ChannelMap,
const sim::OpDetBacktrackerRecord btr 
) const

Definition at line 353 of file PDFastSimPVS_module.cc.

References DEFINE_ART_MODULE, sim::OpDetBacktrackerRecord::OpDetNum(), and sim::OpDetBacktrackerRecord::timePDclockSDPsMap().

Referenced by produce().

356  {
357  int iChan = btr.OpDetNum();
358  if (ChannelMap[iChan] < 0) {
359  ChannelMap[iChan] = opbtr.size();
360  opbtr.emplace_back(std::move(btr));
361  }
362  else {
363  size_t idtest = ChannelMap[iChan];
364  auto const& timePDclockSDPsMap = btr.timePDclockSDPsMap();
365  for (auto const& timePDclockSDP : timePDclockSDPsMap) {
366  for (auto const& sdp : timePDclockSDP.second) {
367  double xyz[3] = {sdp.x, sdp.y, sdp.z};
368  opbtr.at(idtest).AddScintillationPhotons(
369  sdp.trackID, timePDclockSDP.first, sdp.numPhotons, xyz, sdp.energy);
370  }
371  }
372  }
373  }
int OpDetNum() const
Returns the readout Optical Detector this object describes.
timePDclockSDPs_t const & timePDclockSDPsMap() const
Returns all the deposited energy information as stored.
template<typename T , BranchType BT>
ProductToken< T > art::ModuleBase::consumes ( InputTag const &  tag)
protectedinherited

Definition at line 61 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumes().

62  {
63  return collector_.consumes<T, BT>(tag);
64  }
ConsumesCollector collector_
Definition: ModuleBase.h:56
ProductToken< T > consumes(InputTag const &)
ConsumesCollector & art::ModuleBase::consumesCollector ( )
protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

58  {
59  return collector_;
60  }
ConsumesCollector collector_
Definition: ModuleBase.h:56
template<typename T , BranchType BT>
void art::ModuleBase::consumesMany ( )
protectedinherited

Definition at line 75 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesMany().

76  {
77  collector_.consumesMany<T, BT>();
78  }
ConsumesCollector collector_
Definition: ModuleBase.h:56
template<typename Element , BranchType = InEvent>
ViewToken<Element> art::ModuleBase::consumesView ( InputTag const &  )
protectedinherited
template<typename T , BranchType BT>
ViewToken<T> art::ModuleBase::consumesView ( InputTag const &  tag)
inherited

Definition at line 68 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesView().

69  {
70  return collector_.consumesView<T, BT>(tag);
71  }
ConsumesCollector collector_
Definition: ModuleBase.h:56
ViewToken< Element > consumesView(InputTag const &)
void art::detail::Producer::doBeginJob ( SharedResources const &  resources)
inherited

Definition at line 22 of file Producer.cc.

References art::detail::Producer::beginJobWithFrame(), and art::detail::Producer::setupQueues().

23  {
24  setupQueues(resources);
25  ProcessingFrame const frame{ScheduleID{}};
26  beginJobWithFrame(frame);
27  }
virtual void setupQueues(SharedResources const &)=0
virtual void beginJobWithFrame(ProcessingFrame const &)=0
bool art::detail::Producer::doBeginRun ( RunPrincipal rp,
ModuleContext const &  mc 
)
inherited

Definition at line 65 of file Producer.cc.

References art::detail::Producer::beginRunWithFrame(), art::RangeSet::forRun(), art::RunPrincipal::makeRun(), r, art::RunPrincipal::runID(), and art::ModuleContext::scheduleID().

66  {
67  auto r = rp.makeRun(mc, RangeSet::forRun(rp.runID()));
68  ProcessingFrame const frame{mc.scheduleID()};
69  beginRunWithFrame(r, frame);
70  r.commitProducts();
71  return true;
72  }
TRandom r
Definition: spectrum.C:23
virtual void beginRunWithFrame(Run &, ProcessingFrame const &)=0
static RangeSet forRun(RunID)
Definition: RangeSet.cc:51
bool art::detail::Producer::doBeginSubRun ( SubRunPrincipal srp,
ModuleContext const &  mc 
)
inherited

Definition at line 85 of file Producer.cc.

References art::detail::Producer::beginSubRunWithFrame(), art::RangeSet::forSubRun(), art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::SubRunPrincipal::subRunID().

86  {
87  auto sr = srp.makeSubRun(mc, RangeSet::forSubRun(srp.subRunID()));
88  ProcessingFrame const frame{mc.scheduleID()};
89  beginSubRunWithFrame(sr, frame);
90  sr.commitProducts();
91  return true;
92  }
virtual void beginSubRunWithFrame(SubRun &, ProcessingFrame const &)=0
static RangeSet forSubRun(SubRunID)
Definition: RangeSet.cc:57
void art::detail::Producer::doEndJob ( )
inherited

Definition at line 30 of file Producer.cc.

References art::detail::Producer::endJobWithFrame().

31  {
32  ProcessingFrame const frame{ScheduleID{}};
33  endJobWithFrame(frame);
34  }
virtual void endJobWithFrame(ProcessingFrame const &)=0
bool art::detail::Producer::doEndRun ( RunPrincipal rp,
ModuleContext const &  mc 
)
inherited

Definition at line 75 of file Producer.cc.

References art::detail::Producer::endRunWithFrame(), art::RunPrincipal::makeRun(), r, art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

76  {
77  auto r = rp.makeRun(mc, rp.seenRanges());
78  ProcessingFrame const frame{mc.scheduleID()};
79  endRunWithFrame(r, frame);
80  r.commitProducts();
81  return true;
82  }
TRandom r
Definition: spectrum.C:23
virtual void endRunWithFrame(Run &, ProcessingFrame const &)=0
bool art::detail::Producer::doEndSubRun ( SubRunPrincipal srp,
ModuleContext const &  mc 
)
inherited

Definition at line 95 of file Producer.cc.

References art::detail::Producer::endSubRunWithFrame(), art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

96  {
97  auto sr = srp.makeSubRun(mc, srp.seenRanges());
98  ProcessingFrame const frame{mc.scheduleID()};
99  endSubRunWithFrame(sr, frame);
100  sr.commitProducts();
101  return true;
102  }
virtual void endSubRunWithFrame(SubRun &, ProcessingFrame const &)=0
bool art::detail::Producer::doEvent ( EventPrincipal ep,
ModuleContext const &  mc,
std::atomic< std::size_t > &  counts_run,
std::atomic< std::size_t > &  counts_passed,
std::atomic< std::size_t > &  counts_failed 
)
inherited

Definition at line 105 of file Producer.cc.

References art::detail::Producer::checkPutProducts_, e, art::EventPrincipal::makeEvent(), art::detail::Producer::produceWithFrame(), and art::ModuleContext::scheduleID().

110  {
111  auto e = ep.makeEvent(mc);
112  ++counts_run;
113  ProcessingFrame const frame{mc.scheduleID()};
114  produceWithFrame(e, frame);
115  e.commitProducts(checkPutProducts_, &expectedProducts<InEvent>());
116  ++counts_passed;
117  return true;
118  }
bool const checkPutProducts_
Definition: Producer.h:70
Float_t e
Definition: plot.C:35
virtual void produceWithFrame(Event &, ProcessingFrame const &)=0
void art::detail::Producer::doRespondToCloseInputFile ( FileBlock const &  fb)
inherited

Definition at line 44 of file Producer.cc.

References art::detail::Producer::respondToCloseInputFileWithFrame().

45  {
46  ProcessingFrame const frame{ScheduleID{}};
48  }
virtual void respondToCloseInputFileWithFrame(FileBlock const &, ProcessingFrame const &)=0
TFile fb("Li6.root")
void art::detail::Producer::doRespondToCloseOutputFiles ( FileBlock const &  fb)
inherited

Definition at line 58 of file Producer.cc.

References art::detail::Producer::respondToCloseOutputFilesWithFrame().

59  {
60  ProcessingFrame const frame{ScheduleID{}};
62  }
virtual void respondToCloseOutputFilesWithFrame(FileBlock const &, ProcessingFrame const &)=0
TFile fb("Li6.root")
void art::detail::Producer::doRespondToOpenInputFile ( FileBlock const &  fb)
inherited

Definition at line 37 of file Producer.cc.

References art::detail::Producer::respondToOpenInputFileWithFrame().

38  {
39  ProcessingFrame const frame{ScheduleID{}};
41  }
virtual void respondToOpenInputFileWithFrame(FileBlock const &, ProcessingFrame const &)=0
TFile fb("Li6.root")
void art::detail::Producer::doRespondToOpenOutputFiles ( FileBlock const &  fb)
inherited

Definition at line 51 of file Producer.cc.

References art::detail::Producer::respondToOpenOutputFilesWithFrame().

52  {
53  ProcessingFrame const frame{ScheduleID{}};
55  }
virtual void respondToOpenOutputFilesWithFrame(FileBlock const &, ProcessingFrame const &)=0
TFile fb("Li6.root")
void art::Modifier::fillProductDescriptions ( )
inherited

Definition at line 10 of file Modifier.cc.

References art::ProductRegistryHelper::fillDescriptions(), and art::ModuleBase::moduleDescription().

11  {
13  }
void fillDescriptions(ModuleDescription const &md)
ModuleDescription const & moduleDescription() const
Definition: ModuleBase.cc:13
std::array< std::vector< ProductInfo >, NumBranchTypes > const & art::ModuleBase::getConsumables ( ) const
inherited

Definition at line 43 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::getConsumables().

44  {
45  return collector_.getConsumables();
46  }
ConsumesCollector collector_
Definition: ModuleBase.h:56
std::array< std::vector< ProductInfo >, NumBranchTypes > const & getConsumables() const
std::unique_ptr< Worker > art::ModuleBase::makeWorker ( WorkerParams const &  wp)
inherited

Definition at line 37 of file ModuleBase.cc.

References art::ModuleBase::doMakeWorker(), and art::NumBranchTypes.

38  {
39  return doMakeWorker(wp);
40  }
virtual std::unique_ptr< Worker > doMakeWorker(WorkerParams const &wp)=0
template<typename T , BranchType BT>
ProductToken< T > art::ModuleBase::mayConsume ( InputTag const &  tag)
protectedinherited

Definition at line 82 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsume().

83  {
84  return collector_.mayConsume<T, BT>(tag);
85  }
ProductToken< T > mayConsume(InputTag const &)
ConsumesCollector collector_
Definition: ModuleBase.h:56
template<typename T , BranchType BT>
void art::ModuleBase::mayConsumeMany ( )
protectedinherited

Definition at line 96 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeMany().

97  {
98  collector_.mayConsumeMany<T, BT>();
99  }
ConsumesCollector collector_
Definition: ModuleBase.h:56
template<typename Element , BranchType = InEvent>
ViewToken<Element> art::ModuleBase::mayConsumeView ( InputTag const &  )
protectedinherited
template<typename T , BranchType BT>
ViewToken<T> art::ModuleBase::mayConsumeView ( InputTag const &  tag)
inherited

Definition at line 89 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeView().

90  {
91  return collector_.mayConsumeView<T, BT>(tag);
92  }
ConsumesCollector collector_
Definition: ModuleBase.h:56
ViewToken< Element > mayConsumeView(InputTag const &)
ModuleDescription const & art::ModuleBase::moduleDescription ( ) const
inherited

Definition at line 13 of file ModuleBase.cc.

References art::errors::LogicError.

Referenced by art::OutputModule::doRespondToOpenInputFile(), art::OutputModule::doWriteEvent(), art::Modifier::fillProductDescriptions(), art::OutputModule::makePlugins_(), art::OutputWorker::OutputWorker(), reco::shower::LArPandoraModularShowerCreation::produce(), art::Modifier::registerProducts(), and art::OutputModule::registerProducts().

14  {
15  if (md_.has_value()) {
16  return *md_;
17  }
18 
20  "There was an error while calling moduleDescription().\n"}
21  << "The moduleDescription() base-class member function cannot be called\n"
22  "during module construction. To determine which module is "
23  "responsible\n"
24  "for calling it, find the '<module type>:<module "
25  "label>@Construction'\n"
26  "tag in the message prefix above. Please contact artists@fnal.gov\n"
27  "for guidance.\n";
28  }
cet::coded_exception< errors::ErrorCodes, ExceptionDetail::translate > Exception
Definition: Exception.h:66
std::optional< ModuleDescription > md_
Definition: ModuleBase.h:55
void phot::PDFastSimPVS::produce ( art::Event event)
overridevirtual

Implements art::EDProducer.

Definition at line 158 of file PDFastSimPVS_module.cc.

References AddOpDetBTR(), sim::OpDetBacktrackerRecord::AddScintillationPhotons(), e, util::end(), sim::OnePhoton::Energy, fDoFastComponent, fDoSlowComponent, fIncludePropTime, fNOpChannels, fPropTimeModel, fPVS, fRandPoissPhot, fScintTime, fSimTag, fStoreReflected, fUseLitePhotons, art::ProductRetriever::getByLabel(), sim::OnePhoton::InitialPosition, sim::OnePhoton::MotherTrackID, sim::OnePhoton::SetInSD, and sim::OnePhoton::Time.

159  {
160  std::vector<int> PDChannelToSOCMapDirect(fNOpChannels, -1); // Where each OpChan is.
161  std::vector<int> PDChannelToSOCMapReflect(fNOpChannels, -1); // Where each OpChan is.
162 
163  // SimPhotonsLite
164  auto phlit = std::make_unique<std::vector<sim::SimPhotonsLite>>();
165  auto opbtr = std::make_unique<std::vector<sim::OpDetBacktrackerRecord>>();
166  auto phlit_ref = std::make_unique<std::vector<sim::SimPhotonsLite>>();
167  auto opbtr_ref = std::make_unique<std::vector<sim::OpDetBacktrackerRecord>>();
168  auto& dir_phlitcol(*phlit);
169  auto& ref_phlitcol(*phlit_ref);
170  // SimPhotons
171  auto phot = std::make_unique<std::vector<sim::SimPhotons>>();
172  auto phot_ref = std::make_unique<std::vector<sim::SimPhotons>>();
173  auto& dir_photcol(*phot);
174  auto& ref_photcol(*phot_ref);
175  if (fUseLitePhotons) {
176  dir_phlitcol.resize(fNOpChannels);
177  ref_phlitcol.resize(fNOpChannels);
178  for (unsigned int i = 0; i < fNOpChannels; i++) {
179  dir_phlitcol[i].OpChannel = i;
180  ref_phlitcol[i].OpChannel = i;
181  }
182  }
183  else { // SimPhotons
184  dir_photcol.resize(fNOpChannels);
185  ref_photcol.resize(fNOpChannels);
186  for (unsigned int i = 0; i < fNOpChannels; i++) {
187  dir_photcol[i].fOpChannel = i;
188  ref_photcol[i].fOpChannel = i;
189  }
190  }
191 
193  if (!event.getByLabel(fSimTag, edepHandle)) {
194  mf::LogWarning("PDFastSimPVS") << "PDFastSimPVS Module Cannot getByLabel: " << fSimTag;
195  return;
196  }
197 
198  int num_points = 0;
199  auto const& edeps = edepHandle;
200  for (auto const& edepi : *edeps) {
201  num_points++;
202 
203  int nphot_fast = edepi.NumFPhotons();
204  int nphot_slow = edepi.NumSPhotons();
205  if (!((nphot_fast > 0 && fDoFastComponent) || (nphot_slow > 0 && fDoSlowComponent))) continue;
206 
207  auto const& prt = edepi.MidPoint();
208 
209  MappedCounts_t Visibilities = fPVS->GetAllVisibilities(prt);
210  MappedCounts_t Visibilities_Ref;
211  if (fStoreReflected) {
212  Visibilities_Ref = fPVS->GetAllVisibilities(prt, true);
213  if (!Visibilities_Ref)
214  mf::LogWarning("PDFastSimPVS") << "Fail to get visibilities for reflected photons.";
215  }
216 
217  if (!Visibilities) {
218  //throw cet::exception("PDFastSimPVS")
219  mf::LogWarning("PDFastSimPVS")
220  << "There is no entry in the PhotonLibrary for this position in space. Position: "
221  << edepi.MidPoint() << "\n Move to next point";
222  continue;
223  }
224 
225  int trackID = edepi.TrackID();
226  int nphot = edepi.NumPhotons();
227  double edeposit = edepi.Energy() / nphot;
228  double pos[3] = {edepi.MidPointX(), edepi.MidPointY(), edepi.MidPointZ()};
229 
230  geo::Point_t const ScintPoint = {pos[0], pos[1], pos[2]};
231 
232  // loop through direct photons then reflected photons cases
233  size_t DoReflected = (fStoreReflected) ? 1 : 0;
234  for (size_t Reflected = 0; Reflected <= DoReflected; ++Reflected) {
235  for (unsigned int channel = 0; channel < fNOpChannels; ++channel) {
236 
237  double visibleFraction = (Reflected) ? Visibilities_Ref[channel] : Visibilities[channel];
238  if (visibleFraction < 1e-9) continue; // voxel is not visible at this optical channel
239 
240  // number of detected photons
241  int ndetected_fast =
242  (nphot_fast > 0) ? fRandPoissPhot->fire(nphot_fast * visibleFraction) : 0;
243  int ndetected_slow =
244  (nphot_slow > 0) ? fRandPoissPhot->fire(nphot_slow * visibleFraction) : 0;
245  if (!((ndetected_fast > 0 && fDoFastComponent) ||
246  (ndetected_slow > 0 && fDoSlowComponent)))
247  continue;
248 
249  // calculate propagation times if included, does not matter whether fast or slow photon
250  std::vector<double> transport_time;
251  if (fIncludePropTime) {
252  transport_time.resize(ndetected_fast + ndetected_slow);
253  fPropTimeModel->propagationTime(transport_time, ScintPoint, channel, Reflected);
254  }
255 
256  // SimPhotonsLite case
257  if (fUseLitePhotons) {
258  sim::OpDetBacktrackerRecord tmpbtr(channel);
259  if (ndetected_fast > 0 && fDoFastComponent) {
260  for (int i = 0; i < ndetected_fast; ++i) {
261  // calculate the time at which each photon is seen
262  double dtime = edepi.StartT() + fScintTime->fastScintTime();
263  if (fIncludePropTime) dtime += transport_time[i];
264  int time(dtime > static_cast<double>(std::numeric_limits<int>::max()) ?
265  std::numeric_limits<int>::max() :
266  static_cast<int>(std::round(dtime)));
267  if (Reflected)
268  ++ref_phlitcol[channel].DetectedPhotons[time];
269  else
270  ++dir_phlitcol[channel].DetectedPhotons[time];
271  tmpbtr.AddScintillationPhotons(trackID, time, 1, pos, edeposit);
272  }
273  }
274  if ((ndetected_slow > 0) && fDoSlowComponent) {
275  for (int i = 0; i < ndetected_slow; ++i) {
276  // calculate the time at which each photon is seen
277  double dtime = edepi.StartT() + fScintTime->slowScintTime();
278  if (fIncludePropTime) dtime += transport_time[ndetected_fast + i];
279  int time(dtime > static_cast<double>(std::numeric_limits<int>::max()) ?
280  std::numeric_limits<int>::max() :
281  static_cast<int>(std::round(dtime)));
282  if (Reflected)
283  ++ref_phlitcol[channel].DetectedPhotons[time];
284  else
285  ++dir_phlitcol[channel].DetectedPhotons[time];
286  tmpbtr.AddScintillationPhotons(trackID, time, 1, pos, edeposit);
287  }
288  }
289  if (Reflected)
290  AddOpDetBTR(*opbtr_ref, PDChannelToSOCMapReflect, tmpbtr);
291  else
292  AddOpDetBTR(*opbtr, PDChannelToSOCMapDirect, tmpbtr);
293  }
294 
295  // SimPhotons case
296  else {
297  sim::OnePhoton photon;
298  photon.SetInSD = false;
299  photon.InitialPosition = edepi.End();
300  photon.MotherTrackID = edepi.TrackID();
301  if (Reflected)
302  photon.Energy = 2.9 * CLHEP::eV; // 430 nm
303  else
304  photon.Energy = 9.7 * CLHEP::eV; // 128 nm
305  // TODO: un-hardcode and add another energy for Xe scintillation
306  if (ndetected_fast > 0 && fDoFastComponent) {
307  for (int i = 0; i < ndetected_fast; ++i) {
308  // calculates the time at which the photon was produced
309  double dtime = edepi.StartT() + fScintTime->fastScintTime();
310  if (fIncludePropTime) dtime += transport_time[i];
311  int time = static_cast<int>(std::round(dtime));
312  photon.Time = time;
313  if (Reflected)
314  ref_photcol[channel].insert(ref_photcol[channel].end(), 1, photon);
315  else
316  dir_photcol[channel].insert(dir_photcol[channel].end(), 1, photon);
317  }
318  }
319  if (ndetected_slow > 0 && fDoSlowComponent) {
320  for (int i = 0; i < ndetected_slow; ++i) {
321  double dtime = edepi.StartT() + fScintTime->slowScintTime();
322  if (fIncludePropTime) dtime += transport_time[ndetected_fast + i];
323  int time = static_cast<int>(std::round(dtime));
324  photon.Time = time;
325  if (Reflected)
326  ref_photcol[channel].insert(ref_photcol[channel].end(), 1, photon);
327  else
328  dir_photcol[channel].insert(dir_photcol[channel].end(), 1, photon);
329  }
330  }
331  }
332  }
333  }
334  }
335 
336  if (fUseLitePhotons) {
337  event.put(move(phlit));
338  event.put(move(opbtr));
339  if (fStoreReflected) {
340  event.put(move(phlit_ref), "Reflected");
341  event.put(move(opbtr_ref), "Reflected");
342  }
343  }
344  else {
345  event.put(move(phot));
346  if (fStoreReflected) { event.put(move(phot_ref), "Reflected"); }
347  }
348 
349  return;
350  }
const art::InputTag fSimTag
std::unique_ptr< ScintTime > fScintTime
void AddOpDetBTR(std::vector< sim::OpDetBacktrackerRecord > &opbtr, std::vector< int > &ChannelMap, const sim::OpDetBacktrackerRecord &btr) const
art::ServiceHandle< PhotonVisibilityService const > fPVS
All information of a photon entering the sensitive optical detector volume.
Definition: SimPhotons.h:60
std::unique_ptr< CLHEP::RandPoissonQ > fRandPoissPhot
Energy deposited on a readout Optical Detector by simulated tracks.
geo::Point_t InitialPosition
Scintillation position in world coordinates [cm].
Definition: SimPhotons.h:63
decltype(auto) constexpr end(T &&obj)
ADL-aware version of std::end.
Definition: StdUtils.h:77
phot::IPhotonMappingTransformations::MappedOpDetData_t< phot::IPhotonLibrary::Counts_t > MappedCounts_t
Type of mapped visibility counts.
ROOT::Math::PositionVector3D< ROOT::Math::Cartesian3D< double >, ROOT::Math::GlobalCoordinateSystemTag > Point_t
Type for representation of position in physical 3D space.
Definition: geo_vectors.h:180
General LArSoft Utilities.
bool getByLabel(std::string const &label, std::string const &instance, Handle< PROD > &result) const
bool SetInSD
Whether the photon reaches the sensitive detector.
Definition: SimPhotons.h:84
MaybeLogger_< ELseverityLevel::ELsev_warning, false > LogWarning
float Energy
Scintillation photon energy [GeV].
Definition: SimPhotons.h:78
Float_t e
Definition: plot.C:35
std::unique_ptr< PropagationTimeModel > fPropTimeModel
int MotherTrackID
ID of the GEANT4 track causing the scintillation.
Definition: SimPhotons.h:81
void art::Modifier::registerProducts ( ProductDescriptions productsToRegister)
inherited

Definition at line 16 of file Modifier.cc.

References art::ModuleBase::moduleDescription(), and art::ProductRegistryHelper::registerProducts().

17  {
18  ProductRegistryHelper::registerProducts(productsToRegister,
20  }
void registerProducts(ProductDescriptions &productsToRegister, ModuleDescription const &md)
ModuleDescription const & moduleDescription() const
Definition: ModuleBase.cc:13
void art::ModuleBase::setModuleDescription ( ModuleDescription const &  md)
inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

32  {
33  md_ = md;
34  }
std::optional< ModuleDescription > md_
Definition: ModuleBase.h:55
void art::ModuleBase::sortConsumables ( std::string const &  current_process_name)
inherited

Definition at line 49 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::sortConsumables().

50  {
51  // Now that we know we have seen all the consumes declarations,
52  // sort the results for fast lookup later.
53  collector_.sortConsumables(current_process_name);
54  }
ConsumesCollector collector_
Definition: ModuleBase.h:56
void sortConsumables(std::string const &current_process_name)

Member Data Documentation

const bool phot::PDFastSimPVS::fDoFastComponent
private

Definition at line 71 of file PDFastSimPVS_module.cc.

Referenced by PDFastSimPVS(), and produce().

const bool phot::PDFastSimPVS::fDoSlowComponent
private

Definition at line 72 of file PDFastSimPVS_module.cc.

Referenced by PDFastSimPVS(), and produce().

const bool phot::PDFastSimPVS::fIncludePropTime
private

Definition at line 73 of file PDFastSimPVS_module.cc.

Referenced by PDFastSimPVS(), and produce().

const size_t phot::PDFastSimPVS::fNOpChannels
private

Definition at line 76 of file PDFastSimPVS_module.cc.

Referenced by PDFastSimPVS(), and produce().

CLHEP::HepRandomEngine& phot::PDFastSimPVS::fPhotonEngine
private

Definition at line 78 of file PDFastSimPVS_module.cc.

Referenced by PDFastSimPVS().

std::unique_ptr<PropagationTimeModel> phot::PDFastSimPVS::fPropTimeModel
private

Definition at line 82 of file PDFastSimPVS_module.cc.

Referenced by PDFastSimPVS(), and produce().

art::ServiceHandle<PhotonVisibilityService const> phot::PDFastSimPVS::fPVS
private

Definition at line 70 of file PDFastSimPVS_module.cc.

Referenced by PDFastSimPVS(), and produce().

std::unique_ptr<CLHEP::RandPoissonQ> phot::PDFastSimPVS::fRandPoissPhot
private

Definition at line 79 of file PDFastSimPVS_module.cc.

Referenced by PDFastSimPVS(), and produce().

std::unique_ptr<ScintTime> phot::PDFastSimPVS::fScintTime
private

Definition at line 81 of file PDFastSimPVS_module.cc.

Referenced by PDFastSimPVS(), and produce().

CLHEP::HepRandomEngine& phot::PDFastSimPVS::fScintTimeEngine
private

Definition at line 80 of file PDFastSimPVS_module.cc.

Referenced by PDFastSimPVS().

const art::InputTag phot::PDFastSimPVS::fSimTag
private

Definition at line 77 of file PDFastSimPVS_module.cc.

Referenced by PDFastSimPVS(), and produce().

const bool phot::PDFastSimPVS::fStoreReflected
private

Definition at line 75 of file PDFastSimPVS_module.cc.

Referenced by PDFastSimPVS(), and produce().

const bool phot::PDFastSimPVS::fUseLitePhotons
private

Definition at line 74 of file PDFastSimPVS_module.cc.

Referenced by PDFastSimPVS(), and produce().


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