Inheritance diagram for opdet::OpMCDigi:

Public Types
using	ModuleType = EDProducer

using	WorkerType = WorkerT< EDProducer >

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

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

virtual	~OpMCDigi ()

void	produce (art::Event &)

void	beginJob ()

template<typename PROD , BranchType B = InEvent>
ProductID	getProductID (std::string const &instanceName={}) const

template<typename PROD , BranchType B>
ProductID	getProductID (ModuleDescription const &moduleDescription, std::string const &instanceName) const

bool	modifiesEvent () const

template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)

template<typename T , art::BranchType BT>
art::ProductToken< T >	consumes (InputTag const &it)

template<typename T , BranchType = InEvent>
void	consumesMany ()

template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)

template<typename T , art::BranchType BT>
art::ViewToken< T >	consumesView (InputTag const &it)

template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)

template<typename T , art::BranchType BT>
art::ProductToken< T >	mayConsume (InputTag const &it)

template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)

template<typename T , art::BranchType BT>
art::ViewToken< T >	mayConsumeView (InputTag const &it)

base_engine_t &	createEngine (seed_t seed)

base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make)

base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make, label_t const &engine_label)

seed_t	get_seed_value (fhicl::ParameterSet const &pset, char const key[]="seed", seed_t const implicit_seed=-1)

Static Public Member Functions
static cet::exempt_ptr< Consumer >	non_module_context ()

Protected Member Functions
CurrentProcessingContext const *	currentContext () const

void	validateConsumedProduct (BranchType const bt, ProductInfo const &pi)

void	prepareForJob (fhicl::ParameterSet const &pset)

void	showMissingConsumes () const

Private Member Functions
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::RandFlat *	fFlatRandom

CLHEP::RandPoisson *	fPoissonRandom

Detailed Description

Definition at line 38 of file OpMCDigi_module.cc.

Member Typedef Documentation

using art::EDProducer::ModuleType = EDProducer

inherited

Definition at line 34 of file EDProducer.h.

template<typename UserConfig , typename KeysToIgnore = void>

using art::EDProducer::Table = ProducerBase::Table<UserConfig, KeysToIgnore>

inherited

Definition at line 43 of file EDProducer.h.

using art::EDProducer::WorkerType = WorkerT<EDProducer>

inherited

Definition at line 35 of file EDProducer.h.

Constructor & Destructor Documentation

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

Definition at line 136 of file OpMCDigi_module.cc.

References art::EngineCreator::createEngine(), fDarkRate, fFlatRandom, fInputModule, fPoissonRandom, fSampleFreq, fSaturationScale, fSinglePEWaveform, fTimeBegin, fTimeEnd, fhicl::ParameterSet::get(), art::RandomNumberGenerator::getEngine(), and art::EngineCreator::rng().

   {
     // Infrastructure piece
     produces<std::vector< raw::OpDetPulse> >();
 
 
     // Input Module and histogram parameters come from .fcl
     fInputModule = pset.get<std::string>("InputModule");
  
     art::ServiceHandle<OpDigiProperties> odp;
     fTimeBegin  = odp->TimeBegin();
     fTimeEnd    = odp->TimeEnd();
     fSampleFreq = odp->SampleFreq();
 
     //fQE              = pset.get<double>("QE");
     fDarkRate        = pset.get<double>("DarkRate");
     fSaturationScale = pset.get<double>("SaturationScale");
 
     // Initialize toy waveform vector fSinglePEWaveform
     fSinglePEWaveform = odp->SinglePEWaveform();
 
 
     
     // create a default random engine; obtain the random seed from NuRandomService,
     // unless overridden in configuration with key "Seed"
     art::ServiceHandle<rndm::NuRandomService>()
       ->createEngine(*this, pset, "Seed");
 
     // Sample a random fraction of detected photons 
     art::ServiceHandle<art::RandomNumberGenerator> rng;
     CLHEP::HepRandomEngine &engine = rng->getEngine();
     fFlatRandom       = new CLHEP::RandFlat(engine);
     fPoissonRandom    = new CLHEP::RandPoisson(rng->getEngine());
 
 
 
 
   }

opdet::OpMCDigi::~OpMCDigi ( )

virtual

Definition at line 185 of file OpMCDigi_module.cc.

186 {

187 }

Member Function Documentation

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

private

Definition at line 193 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);
       }
   }       

void opdet::OpMCDigi::beginJob ( )

virtual

Reimplemented from art::EDProducer.

Definition at line 178 of file OpMCDigi_module.cc.

179 {

180 }

template<typename T , BranchType = InEvent>

ProductToken<T> art::Consumer::consumes ( InputTag const & )

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::consumes ( InputTag const & it )

inherited

Definition at line 147 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ProductToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::Product,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ProductToken<T>{it};
 }

template<typename T , art::BranchType BT>

void art::Consumer::consumesMany ( )

inherited

Definition at line 162 of file Consumer.h.

 {
   if (!moduleContext_)
     return;
 
   consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
 }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::Consumer::consumesView ( InputTag const & )

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::consumesView ( InputTag const & it )

inherited

Definition at line 172 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ViewToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ViewToken<T>{it};
 }

EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t seed )

inherited

Definition at line 26 of file EngineCreator.cc.

References art::EngineCreator::rng().

Referenced by evgen::CosmicsGen::CosmicsGen(), rndm::NuRandomService::createEngine(), cluster::fuzzyCluster::fuzzyCluster(), cluster::HoughLineFinder::HoughLineFinder(), art::MixFilter< T >::initEngine_(), larg4::LArG4::LArG4(), evgen::LightSource::LightSource(), evgen::NeutronOsc::NeutronOsc(), evgen::NucleonDecay::NucleonDecay(), OpMCDigi(), opdet::OptDetDigitizer::OptDetDigitizer(), phot::PhotonLibraryPropagation::PhotonLibraryPropagation(), detsim::SimDriftElectrons::SimDriftElectrons(), evgen::SingleGen::SingleGen(), evgen::SNNueAr40CCGen::SNNueAr40CCGen(), ToyOneShowerGen::ToyOneShowerGen(), and trkf::Track3DKalman::Track3DKalman().

 {
   return rng()->createEngine(placeholder_schedule_id(), seed);
 }

EngineCreator::base_engine_t & EngineCreator::createEngine	(	seed_t	seed,
		std::string const &	kind_of_engine_to_make
	)

inherited

Definition at line 32 of file EngineCreator.cc.

References art::EngineCreator::rng().

 {
   return rng()->createEngine(
     placeholder_schedule_id(), seed, kind_of_engine_to_make);
 }

EngineCreator::base_engine_t & EngineCreator::createEngine	(	seed_t	seed,
		std::string const &	kind_of_engine_to_make,
		label_t const &	engine_label
	)

inherited

Definition at line 40 of file EngineCreator.cc.

References art::EngineCreator::rng().

 {
   return rng()->createEngine(
     placeholder_schedule_id(), seed, kind_of_engine_to_make, engine_label);
 }

CurrentProcessingContext const * art::EDProducer::currentContext ( ) const

protectedinherited

Definition at line 120 of file EDProducer.cc.

References art::EDProducer::current_context_.

   {
     return current_context_.get();
   }

EngineCreator::seed_t EngineCreator::get_seed_value	(	fhicl::ParameterSet const &	pset,
		char const	key[] = `"seed"`,
		seed_t const	implicit_seed = `-1`
	)

inherited

Definition at line 49 of file EngineCreator.cc.

References fhicl::ParameterSet::get().

Referenced by art::MixFilter< T >::initEngine_().

 {
   auto const& explicit_seeds = pset.get<std::vector<int>>(key, {});
   return explicit_seeds.empty() ? implicit_seed : explicit_seeds.front();
 }

template<typename PROD , BranchType B>

ProductID art::EDProducer::getProductID ( std::string const & instanceName = {} ) const

inlineinherited

Definition at line 123 of file EDProducer.h.

References art::EDProducer::moduleDescription_.

   {
     return ProducerBase::getProductID<PROD, B>(moduleDescription_,
                                                instanceName);
   }

template<typename PROD , BranchType B>

ProductID art::ProducerBase::getProductID	(	ModuleDescription const &	moduleDescription,
		std::string const &	instanceName
	)		const

inherited

Definition at line 56 of file ProducerBase.h.

References B, and art::ModuleDescription::moduleLabel().

Referenced by art::ProducerBase::modifiesEvent().

   {
     auto const& pd =
       get_ProductDescription<PROD>(B, md.moduleLabel(), instanceName);
     return pd.productID();
   }

template<typename T , BranchType = InEvent>

ProductToken<T> art::Consumer::mayConsume ( InputTag const & )

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::mayConsume ( InputTag const & it )

inherited

Definition at line 190 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ProductToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::Product,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ProductToken<T>{it};
 }

template<typename T , art::BranchType BT>

void art::Consumer::mayConsumeMany ( )

inherited

Definition at line 205 of file Consumer.h.

 {
   if (!moduleContext_)
     return;
 
   consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
 }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::Consumer::mayConsumeView ( InputTag const & )

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::mayConsumeView ( InputTag const & it )

inherited

Definition at line 215 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ViewToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ViewToken<T>{it};
 }

bool art::ProducerBase::modifiesEvent ( ) const

inlineinherited

Definition at line 40 of file ProducerBase.h.

References art::ProducerBase::getProductID().

     {
       return true;
     }

cet::exempt_ptr< art::Consumer > art::Consumer::non_module_context ( )

staticinherited

Definition at line 76 of file Consumer.cc.

 {
   static Consumer invalid{InvalidTag{}};
   return &invalid;
 }

void art::Consumer::prepareForJob ( fhicl::ParameterSet const & pset )

protectedinherited

Definition at line 89 of file Consumer.cc.

References fhicl::ParameterSet::get_if_present().

Referenced by art::EDProducer::doBeginJob(), art::EDFilter::doBeginJob(), and art::EDAnalyzer::doBeginJob().

 {
   if (!moduleContext_)
     return;
 
   pset.get_if_present("errorOnMissingConsumes", requireConsumes_);
   for (auto& consumablesPerBranch : consumables_) {
     cet::sort_all(consumablesPerBranch);
   }
 }

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

virtual

Implements art::EDProducer.

Definition at line 211 of file OpMCDigi_module.cc.

References AddTimedWaveform(), opdet::OpDetResponseInterface::detected(), opdet::OpDetResponseInterface::detectedLite(), fDarkRate, fFlatRandom, fInputModule, fPoissonRandom, fSampleFreq, fSaturationScale, fSinglePEWaveform, fTimeBegin, fTimeEnd, art::DataViewImpl::getByLabel(), sim::SimListUtils::GetSimPhotonsCollection(), opdet::OpDetResponseInterface::NOpChannels(), sim::SimPhotons::OpChannel(), art::Event::put(), art::EngineCreator::rng(), and sim::LArG4Parameters::UseLitePhotons().

   {
     // Infrastructure piece
     std::unique_ptr<std::vector< raw::OpDetPulse > >  StoragePtr (new std::vector<raw::OpDetPulse>);
 
    
     art::ServiceHandle<sim::LArG4Parameters> lgp;
     bool fUseLitePhotons = lgp->UseLitePhotons();
 
     // Service for determining opdet responses
     art::ServiceHandle<opdet::OpDetResponseInterface> odresponse;
 
     
     
     double TimeBegin_ns  = fTimeBegin  *  1000;
     double TimeEnd_ns    = fTimeEnd    *  1000;
     double SampleFreq_ns = fSampleFreq /  1000;
 
     int nSamples = ( TimeEnd_ns-TimeBegin_ns)*SampleFreq_ns;
     
     int 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(sim::SimPhotonsCollection::const_iterator itOpDet=ThePhotCollection.begin(); itOpDet!=ThePhotCollection.end(); itOpDet++)
       {
         const sim::SimPhotons& ThePhot=itOpDet->second;
         
         int 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))
               {
                 
                 // 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))
                   {
                     int binTime = int((Phot.Time - TimeBegin_ns) * SampleFreq_ns);              
         
                     // Call function to add waveforms to our pulse
                     AddTimedWaveform( binTime, PulsesFromDetPhotons[readoutCh], fSinglePEWaveform );
                     
                   }
               } // random QE cut
           } // for each Photon in SimPhotons
         
       }
     }
     else
     {
       art::Handle< std::vector<sim::SimPhotonsLite> > photonHandle;
       evt.getByLabel("largeant", photonHandle);
     // For every OpDet:
     for ( auto const& photon : (*photonHandle) )
     {
       int Ch=photon.OpChannel;
       int readoutCh;
       
       std::map<int, int> PhotonsMap = photon.DetectedPhotons;
         
       // For every photon in the hit:
           for(auto it = PhotonsMap.begin(); it!= PhotonsMap.end(); it++)
       {
         for(int i = 0; i < it->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((it->first > TimeBegin_ns) && (it->first < TimeEnd_ns))
               {
                 int binTime = int((it->first - TimeBegin_ns) * SampleFreq_ns);          
         
                 // Call function to add waveforms to our pulse
                 AddTimedWaveform( binTime, PulsesFromDetPhotons[readoutCh], fSinglePEWaveform );
               }
           } // random QE cut
         }
       } // for each Photon in SimPhotons
     }
     }
 
     art::ServiceHandle<art::RandomNumberGenerator> rng;
 
     
     // 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 MeanDarkPulses = fDarkRate * (fTimeEnd-fTimeBegin) / 1000000;
 
         unsigned int NumberOfPulses = fPoissonRandom->fire(MeanDarkPulses);
         
         for(size_t i=0; i!=NumberOfPulses; ++i)
           {
             double PulseTime = (fTimeEnd-fTimeBegin)*fFlatRandom->fire(1.0);
             int binTime = 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->push_back(  raw::OpDetPulse( iCh, shortvec ,0, fTimeBegin) );
         
       } // for each OpDet in SimPhotonsCollection
     
 
     evt.put(std::move(StoragePtr));
   }  

void art::Consumer::showMissingConsumes ( ) const

protectedinherited

Definition at line 125 of file Consumer.cc.

Referenced by art::EDProducer::doEndJob(), art::EDFilter::doEndJob(), art::EDAnalyzer::doEndJob(), and art::RootOutput::endJob().

 {
   if (!moduleContext_)
     return;
 
   // If none of the branches have missing consumes statements, exit early.
   if (std::all_of(cbegin(missingConsumes_),
                   cend(missingConsumes_),
                   [](auto const& perBranch) { return perBranch.empty(); }))
     return;
 
   constexpr cet::HorizontalRule rule{60};
   mf::LogPrint log{"MTdiagnostics"};
   log << '\n'
       << rule('=') << '\n'
       << "The following consumes (or mayConsume) statements are missing from\n"
       << module_context(moduleDescription_) << '\n'
       << rule('-') << '\n';
 
   cet::for_all_with_index(
     missingConsumes_, [&log](std::size_t const i, auto const& perBranch) {
       for (auto const& pi : perBranch) {
         log << "  "
             << assemble_consumes_statement(static_cast<BranchType>(i), pi)
             << '\n';
       }
     });
   log << rule('=');
 }

void art::Consumer::validateConsumedProduct	(	BranchType const	bt,
		ProductInfo const &	pi
	)

protectedinherited

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

 {
   // Early exits if consumes tracking has been disabled or if the
   // consumed product is an allowed consumable.
   if (!moduleContext_)
     return;
 
   if (cet::binary_search_all(consumables_[bt], pi))
     return;
 
   if (requireConsumes_) {
     throw Exception(errors::ProductRegistrationFailure,
                     "Consumer: an error occurred during validation of a "
                     "retrieved product\n\n")
       << "The following consumes (or mayConsume) statement is missing from\n"
       << module_context(moduleDescription_) << ":\n\n"
       << "  " << assemble_consumes_statement(bt, pi) << "\n\n";
   }
 
   missingConsumes_[bt].insert(pi);
 }

Member Data Documentation

float opdet::OpMCDigi::fDarkRate

private

Definition at line 59 of file OpMCDigi_module.cc.

Referenced by OpMCDigi(), and produce().

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 52 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 53 of file OpMCDigi_module.cc.

Referenced by OpMCDigi(), and produce().

float opdet::OpMCDigi::fSaturationScale

private

Definition at line 57 of file OpMCDigi_module.cc.

Referenced by OpMCDigi(), and produce().

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

private

Definition at line 61 of file OpMCDigi_module.cc.

Referenced by OpMCDigi(), and produce().

float opdet::OpMCDigi::fTimeBegin

private

Definition at line 54 of file OpMCDigi_module.cc.

Referenced by OpMCDigi(), and produce().

float opdet::OpMCDigi::fTimeEnd

private

Definition at line 55 of file OpMCDigi_module.cc.

Referenced by OpMCDigi(), and produce().

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

/cvmfs/larsoft.opensciencegrid.org/products/larana/v07_04_02/source/larana/OpticalDetector/OpMCDigi_module.cc

Public Types

Public Member Functions

Static 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