Inheritance diagram for opdet::OpMCDigi:

Public Types
using	ModuleType = EDProducer

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

Public Member Functions
	OpMCDigi (const fhicl::ParameterSet &)

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 Member Functions
void	produce (art::Event &) override

void	AddTimedWaveform (int time, std::vector< double > &OldPulse, std::vector< double > &NewPulse)

Private Attributes
std::string	fInputModule

float	fSampleFreq

float	fTimeBegin

float	fTimeEnd

float	fSaturationScale

float	fDarkRate

std::vector< double >	fSinglePEWaveform

CLHEP::HepRandomEngine &	fEngine

CLHEP::RandFlat	fFlatRandom

CLHEP::RandPoisson	fPoissonRandom

Detailed Description

Definition at line 43 of file OpMCDigi_module.cc.

Member Typedef Documentation

using art::EDProducer::ModuleType = EDProducer

inherited

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

opdet::OpMCDigi::OpMCDigi ( const fhicl::ParameterSet & )

explicit

Definition at line 75 of file OpMCDigi_module.cc.

References art::detail::EngineCreator::createEngine(), fDarkRate, fEngine, fFlatRandom, fInputModule, fPoissonRandom, fSampleFreq, fSaturationScale, fSinglePEWaveform, fTimeBegin, and fTimeEnd.

     : EDProducer{pset}
     , fInputModule{pset.get<std::string>("InputModule")} //, fQE{pset.get<double>("QE")}
     , fSaturationScale{pset.get<float>("SaturationScale")}
     , fDarkRate{pset.get<float>("DarkRate")}
     // create a default random engine; obtain the random seed from NuRandomService,
     // unless overridden in configuration with key "Seed"
     , fEngine(art::ServiceHandle<rndm::NuRandomService>()->registerAndSeedEngine(createEngine(0),
                                                                                  pset,
                                                                                  "Seed"))
     , fFlatRandom{fEngine}
     , fPoissonRandom{fEngine}
   {
     produces<std::vector<raw::OpDetPulse>>();
 
     art::ServiceHandle<OpDigiProperties> odp;
     fSampleFreq = odp->SampleFreq();
     fTimeBegin = odp->TimeBegin();
     fTimeEnd = odp->TimeEnd();
     fSinglePEWaveform = odp->SinglePEWaveform();
   }

Member Function Documentation

void opdet::OpMCDigi::AddTimedWaveform	(	int	time,
		std::vector< double > &	OldPulse,
		std::vector< double > &	NewPulse
	)

private

Definition at line 99 of file OpMCDigi_module.cc.

Referenced by produce().

   {
 
     if ((binTime + NewPulse.size()) > OldPulse.size()) {
       OldPulse.resize(binTime + NewPulse.size());
     }
 
     // Add shifted NewWaveform to Waveform at pointer
     for (size_t i = 0; i != NewPulse.size(); ++i) {
       OldPulse.at(binTime + i) += NewPulse.at(i);
     }
   }

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

   {
     return collector_.consumes<T, BT>(tag);
   }

ConsumesCollector & art::ModuleBase::consumesCollector ( )

protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

   {
     return collector_;
   }

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

   {
     collector_.consumesMany<T, BT>();
   }

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

   {
     return collector_.consumesView<T, BT>(tag);
   }

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

   {
     setupQueues(resources);
     ProcessingFrame const frame{ScheduleID{}};
     beginJobWithFrame(frame);
   }

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

   {
     auto r = rp.makeRun(mc, RangeSet::forRun(rp.runID()));
     ProcessingFrame const frame{mc.scheduleID()};
     beginRunWithFrame(r, frame);
     r.commitProducts();
     return true;
   }

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

   {
     auto sr = srp.makeSubRun(mc, RangeSet::forSubRun(srp.subRunID()));
     ProcessingFrame const frame{mc.scheduleID()};
     beginSubRunWithFrame(sr, frame);
     sr.commitProducts();
     return true;
   }

void art::detail::Producer::doEndJob ( )

inherited

Definition at line 30 of file Producer.cc.

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

   {
     ProcessingFrame const frame{ScheduleID{}};
     endJobWithFrame(frame);
   }

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

   {
     auto r = rp.makeRun(mc, rp.seenRanges());
     ProcessingFrame const frame{mc.scheduleID()};
     endRunWithFrame(r, frame);
     r.commitProducts();
     return true;
   }

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

   {
     auto sr = srp.makeSubRun(mc, srp.seenRanges());
     ProcessingFrame const frame{mc.scheduleID()};
     endSubRunWithFrame(sr, frame);
     sr.commitProducts();
     return true;
   }

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

   {
     auto e = ep.makeEvent(mc);
     ++counts_run;
     ProcessingFrame const frame{mc.scheduleID()};
     produceWithFrame(e, frame);
     e.commitProducts(checkPutProducts_, &expectedProducts<InEvent>());
     ++counts_passed;
     return true;
   }

void art::detail::Producer::doRespondToCloseInputFile ( FileBlock const & fb )

inherited

Definition at line 44 of file Producer.cc.

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

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseInputFileWithFrame(fb, frame);
   }

void art::detail::Producer::doRespondToCloseOutputFiles ( FileBlock const & fb )

inherited

Definition at line 58 of file Producer.cc.

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

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseOutputFilesWithFrame(fb, frame);
   }

void art::detail::Producer::doRespondToOpenInputFile ( FileBlock const & fb )

inherited

Definition at line 37 of file Producer.cc.

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

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenInputFileWithFrame(fb, frame);
   }

void art::detail::Producer::doRespondToOpenOutputFiles ( FileBlock const & fb )

inherited

Definition at line 51 of file Producer.cc.

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

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenOutputFilesWithFrame(fb, frame);
   }

void art::Modifier::fillProductDescriptions ( )

inherited

Definition at line 10 of file Modifier.cc.

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

   {
     ProductRegistryHelper::fillDescriptions(moduleDescription());
   }

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

   {
     return collector_.getConsumables();
   }

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.

   {
     return doMakeWorker(wp);
   }

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

   {
     return collector_.mayConsume<T, BT>(tag);
   }

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

   {
     collector_.mayConsumeMany<T, BT>();
   }

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

   {
     return collector_.mayConsumeView<T, BT>(tag);
   }

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

   {
     if (md_.has_value()) {
       return *md_;
     }
 
     throw Exception{errors::LogicError,
                     "There was an error while calling moduleDescription().\n"}
       << "The moduleDescription() base-class member function cannot be called\n"
          "during module construction.  To determine which module is "
          "responsible\n"
          "for calling it, find the '<module type>:<module "
          "label>@Construction'\n"
          "tag in the message prefix above.  Please contact artists@fnal.gov\n"
          "for guidance.\n";
   }

void opdet::OpMCDigi::produce ( art::Event & evt )

overrideprivatevirtual

Implements art::EDProducer.

Definition at line 116 of file OpMCDigi_module.cc.

References AddTimedWaveform(), DEFINE_ART_MODULE, opdet::OpDetResponseInterface::detected(), opdet::OpDetResponseInterface::detectedLite(), fDarkRate, fFlatRandom, fInputModule, fPoissonRandom, fSampleFreq, fSaturationScale, fSinglePEWaveform, fTimeBegin, fTimeEnd, sim::SimListUtils::GetSimPhotonsCollection(), art::ProductRetriever::getValidHandle(), opdet::OpDetResponseInterface::NOpChannels(), sim::SimPhotons::OpChannel(), and art::Event::put().

   {
     auto StoragePtr = std::make_unique<std::vector<raw::OpDetPulse>>();
 
     bool const fUseLitePhotons = art::ServiceHandle<sim::LArG4Parameters const>
     {
       } -> UseLitePhotons();
 
     // Service for determining opdet responses
     art::ServiceHandle<opdet::OpDetResponseInterface const> odresponse;
 
     double const TimeBegin_ns = fTimeBegin * 1000;
     double const TimeEnd_ns = fTimeEnd * 1000;
     double const SampleFreq_ns = fSampleFreq / 1000;
 
     int const nSamples = (TimeEnd_ns - TimeBegin_ns) * SampleFreq_ns;
     int const NOpChannels = odresponse->NOpChannels();
 
     // This vector will store all the waveforms we will make
     std::vector<std::vector<double>> PulsesFromDetPhotons(NOpChannels,
                                                           std::vector<double>(nSamples, 0.0));
 
     if (!fUseLitePhotons) {
       // Read in the Sim Photons
       sim::SimPhotonsCollection ThePhotCollection =
         sim::SimListUtils::GetSimPhotonsCollection(evt, fInputModule);
       // For every OpDet:
       for (auto const& pr : ThePhotCollection) {
         const sim::SimPhotons& ThePhot = pr.second;
 
         int const Ch = ThePhot.OpChannel();
         int readoutCh;
 
         // For every photon in the hit:
         for (const sim::OnePhoton& Phot : ThePhot) {
           // Sample a random subset according to QE
           if (!odresponse->detected(Ch, Phot, readoutCh)) { continue; }
 
           // Convert photon arrival time to the appropriate bin,
           // dictated by fSampleFreq. Photon arrival time is in ns,
           // beginning time in us, and sample frequency in MHz. Notice
           // that we have to accommodate for the beginning time
           if ((Phot.Time > TimeBegin_ns) && (Phot.Time < TimeEnd_ns)) {
             auto const binTime = static_cast<int>((Phot.Time - TimeBegin_ns) * SampleFreq_ns);
             AddTimedWaveform(binTime, PulsesFromDetPhotons[readoutCh], fSinglePEWaveform);
           }
         } // for each Photon in SimPhotons
       }
     }
     else {
       auto const photons = *evt.getValidHandle<std::vector<sim::SimPhotonsLite>>("largeant");
       // For every OpDet:
       for (auto const& photon : photons) {
         int const Ch = photon.OpChannel;
         int readoutCh;
 
         std::map<int, int> PhotonsMap = photon.DetectedPhotons;
 
         // For every photon in the hit:
         for (auto const& pr : photon.DetectedPhotons) {
           for (int i = 0; i < pr.second; i++) {
             // Sample a random subset according to QE
             if (odresponse->detectedLite(Ch, readoutCh)) {
               // Convert photon arrival time to the appropriate bin, dictated by fSampleFreq.
               // Photon arrival time is in ns, beginning time in us, and sample frequency in MHz.
               // Notice that we have to accommodate for the beginning time
               if ((pr.first > TimeBegin_ns) && (pr.first < TimeEnd_ns)) {
                 auto const binTime = static_cast<int>((pr.first - TimeBegin_ns) * SampleFreq_ns);
                 AddTimedWaveform(binTime, PulsesFromDetPhotons[readoutCh], fSinglePEWaveform);
               }
             } // random QE cut
           }
         } // for each Photon in SimPhotons
       }
     }
 
     // Create vector of output objects, add dark noise and apply
     //  saturation
 
     std::vector<raw::OpDetPulse*> ThePulses(NOpChannels);
     for (int iCh = 0; iCh != NOpChannels; ++iCh) {
       PulsesFromDetPhotons[iCh].resize((TimeEnd_ns - TimeBegin_ns) * SampleFreq_ns);
 
       // Add dark noise
       double const MeanDarkPulses = fDarkRate * (fTimeEnd - fTimeBegin) / 1000000;
       unsigned const int NumberOfPulses = fPoissonRandom.fire(MeanDarkPulses);
 
       for (size_t i = 0; i != NumberOfPulses; ++i) {
         double const PulseTime = (fTimeEnd - fTimeBegin) * fFlatRandom.fire(1.0);
         int const binTime = static_cast<int>(PulseTime * fSampleFreq);
 
         AddTimedWaveform(binTime, PulsesFromDetPhotons[iCh], fSinglePEWaveform);
       }
 
       // Apply saturation for large signals
       for (size_t i = 0; i != PulsesFromDetPhotons[iCh].size(); ++i) {
         if (PulsesFromDetPhotons[iCh].at(i) > fSaturationScale)
           PulsesFromDetPhotons[iCh].at(i) = fSaturationScale;
       }
 
       // Produce ADC pulse of integers rather than doubles
 
       std::vector<short> shortvec;
 
       for (size_t i = 0; i != PulsesFromDetPhotons[iCh].size(); ++i) {
         // Throw randoms to fairly sample +ve and -ve side of doubles
         int ThisSample = PulsesFromDetPhotons[iCh].at(i);
         if (ThisSample > 0) {
           if (fFlatRandom.fire(1.0) > (ThisSample - int(ThisSample)))
             shortvec.push_back(int(ThisSample));
           else
             shortvec.push_back(int(ThisSample) + 1);
         }
         else {
           if (fFlatRandom.fire(1.0) > (int(ThisSample) - ThisSample))
             shortvec.push_back(int(ThisSample));
           else
             shortvec.push_back(int(ThisSample) - 1);
         }
       }
 
       StoragePtr->emplace_back(iCh, shortvec, 0, fTimeBegin);
 
     } // for each OpDet in SimPhotonsCollection
 
     evt.put(std::move(StoragePtr));
   }

void art::Modifier::registerProducts ( ProductDescriptions & productsToRegister )

inherited

Definition at line 16 of file Modifier.cc.

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

   {
     ProductRegistryHelper::registerProducts(productsToRegister,
                                             moduleDescription());
   }

void art::ModuleBase::setModuleDescription ( ModuleDescription const & md )

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

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

   {
     // Now that we know we have seen all the consumes declarations,
     // sort the results for fast lookup later.
     collector_.sortConsumables(current_process_name);
   }

Member Data Documentation

float opdet::OpMCDigi::fDarkRate

private

Definition at line 58 of file OpMCDigi_module.cc.

Referenced by OpMCDigi(), and produce().

CLHEP::HepRandomEngine& opdet::OpMCDigi::fEngine

private

Definition at line 62 of file OpMCDigi_module.cc.

Referenced by OpMCDigi().

CLHEP::RandFlat opdet::OpMCDigi::fFlatRandom

private

Definition at line 63 of file OpMCDigi_module.cc.

Referenced by OpMCDigi(), and produce().

std::string opdet::OpMCDigi::fInputModule

private

Definition at line 51 of file OpMCDigi_module.cc.

Referenced by OpMCDigi(), and produce().

CLHEP::RandPoisson opdet::OpMCDigi::fPoissonRandom

private

Definition at line 64 of file OpMCDigi_module.cc.

Referenced by OpMCDigi(), and produce().

float opdet::OpMCDigi::fSampleFreq

private

Definition at line 52 of file OpMCDigi_module.cc.

Referenced by OpMCDigi(), and produce().

float opdet::OpMCDigi::fSaturationScale

private

Definition at line 56 of file OpMCDigi_module.cc.

Referenced by OpMCDigi(), and produce().

std::vector<double> opdet::OpMCDigi::fSinglePEWaveform

private

Definition at line 60 of file OpMCDigi_module.cc.

Referenced by OpMCDigi(), and produce().

float opdet::OpMCDigi::fTimeBegin

private

Definition at line 53 of file OpMCDigi_module.cc.

Referenced by OpMCDigi(), and produce().

float opdet::OpMCDigi::fTimeEnd

private

Definition at line 54 of file OpMCDigi_module.cc.

Referenced by OpMCDigi(), and produce().

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

larana/v09_15_05/source/larana/OpticalDetector/OpMCDigi_module.cc

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation