Simulates the digitization of ICARUS PMT response and trigger. More...

Inheritance diagram for icarus::opdet::SimPMTIcarus:

Classes
struct	Config

Public Types
using	Parameters = art::EDProducer::Table< Config >

Public Member Functions
	SimPMTIcarus (Parameters const &config)

	SimPMTIcarus (SimPMTIcarus const &)=delete

	SimPMTIcarus (SimPMTIcarus &&)=delete

SimPMTIcarus &	operator= (SimPMTIcarus const &)=delete

SimPMTIcarus &	operator= (SimPMTIcarus &&)=delete

void	produce (art::Event &e) override

Private Types
using	SinglePhotonResponseFunc_t = icarus::opdet::SinglePhotonResponseFunc_t const
	Type of single photoelectron response function. More...

Private Member Functions
bool	firstTime ()
	Returns whether no other event has been processed yet. More...

Private Attributes
art::InputTag	fInputModuleName
	Input tag for simulated scintillation photons (or photoelectrons). More...

bool	fWritePhotons { false }
	Whether to save contributing photons. More...

std::unique_ptr < SinglePhotonResponseFunc_t > const	fSinglePhotonResponseFunc
	Single photoelectron response function. More...

icarus::opdet::PMTsimulationAlgMaker	makePMTsimulator
	The actual simulation algorithm. More...

CLHEP::HepRandomEngine &	fEfficiencyEngine

CLHEP::HepRandomEngine &	fDarkNoiseEngine

CLHEP::HepRandomEngine &	fElectronicsNoiseEngine

std::atomic_flag	fNotFirstTime
	True if `firstTime()` has already been called. More...

Detailed Description

Simulates the digitization of ICARUS PMT response and trigger.

The module is a simple interface to the simulation algorithm, icarus::opdet::PMTsimulationAlg.

Configuration

All the configuration parameters are passed directly to the icarus::opdet::PMTsimulationAlg algorithm, with the following exceptions:

InputModule (input tag): tag of the data product containing the sim::SimPhotons collection to be digitized;
SinglePhotonResponse (configuration table): configuration of the art tool delivering the single photon response function (see below);
EfficiencySeed, DarkNoiseSeed and ElectronicsNoiseSeed (integers, optional): if specified, each number is used to seed the pertaining random engine; otherwise, the seed is assigned by NuRandomService;
ElectronicsNoiseRandomEngine and DarkNoiseRandomEngine (strings, default: HepJamesRandom): name of the random number generation algorithm to use; valid values are all the ones supported by art::RandomNumberGenerator (which match the random engine classes derived from clhep::HepRandomEngine in CLHEP 2.3 except NonRandomEngine and RandEngine);
WritePhotons (boolean, default: false): saves in an additional sim::SimPhotons collection the photons effectively contributing to the waveforms; currently, no selection ever happens and all photons are contributing, making this collection the same as the input one.

See the documentation of icarus::PMTsimulationAlg for the purpose of the three random number engines.

Currently, no configuration interface is provided to directly control their seeds, which is delegated to rndm::NuRandomService service.

Input

The module utilizes as input a collection of sim::SimPhotons, each containing the photons propagated to a single optical detector channel.

Output

A collection of optical detector waveforms (std::vector<raw::OpDetWaveform>) is produced. See icarus::opdet::PMTsimulationAlg algorithm documentation for details.

If WritePhotons configuration parameter is set true, a collection of the scintillation photons (std::vector<sim::SimPhotons>) which contributed to the waveforms is also produced.

Requirements

This module currently requires LArSoft services:

DetectorClocksService for timing conversions and settings
LArPropertiesService for the scintillation yield(s)

Three random streams are also used.

Single photon response function tool

The single photon response function passed to the underlying algorithm, icarus::opdet::PMTsimulationAlg, is extracted from an art tool. The specifications of the tool are:

the art tool class must implement the icarus::opdet::SinglePhotonPulseFunctionTool interface;
the resulting function describes the signal as digitized by the PMT readout;
the function must therefore express the level of the response as digitized ADC count above the baseline; this level is negative if the signal polarity is negative;
the time scale of this function has 0 as the photoelectron production time.

These requirements imply that the tool (or the underlying function) must include electronics effects like the the time it takes to form the signal, the signal shape at PMT output, the delay and distortion of the cables and the ones of the digitization electronics, but the baseline is assumed flat at 0.

Definition at line 144 of file SimPMTIcarus_module.cc.

Member Typedef Documentation

using icarus::opdet::SimPMTIcarus::Parameters = art::EDProducer::Table<Config>

Definition at line 203 of file SimPMTIcarus_module.cc.

using icarus::opdet::SimPMTIcarus::SinglePhotonResponseFunc_t = icarus::opdet::SinglePhotonResponseFunc_t const

private

Type of single photoelectron response function.

Definition at line 221 of file SimPMTIcarus_module.cc.

Constructor & Destructor Documentation

icarus::opdet::SimPMTIcarus::SimPMTIcarus ( Parameters const & config )

explicit

Definition at line 251 of file SimPMTIcarus_module.cc.

     : EDProducer{config}
     , fInputModuleName(config().inputModuleLabel())
     , fWritePhotons(config().writePhotons())
     , fSinglePhotonResponseFunc{
         art::make_tool<icarus::opdet::SinglePhotonPulseFunctionTool>
           (config().SinglePhotonResponse.get<fhicl::ParameterSet>())
           ->getPulseFunction()
       }
     , makePMTsimulator(config().algoConfig())
     , fEfficiencyEngine(art::ServiceHandle<rndm::NuRandomService>()->createEngine
         (*this, "HepJamesRandom", "Efficiencies", config().EfficiencySeed)
       )
     , fDarkNoiseEngine(art::ServiceHandle<rndm::NuRandomService>()->createEngine(
         *this,
         config().darkNoiseRandomEngine(),
         "DarkNoise",
         config().DarkNoiseSeed
       ))
     , fElectronicsNoiseEngine(art::ServiceHandle<rndm::NuRandomService>()->createEngine(
         *this,
         config().electronicsNoiseRandomEngine(),
         "ElectronicsNoise",
         config().ElectronicsNoiseSeed
       ))
   {
     // Call appropriate produces<>() functions here.
     produces<std::vector<raw::OpDetWaveform>>();
     if (fWritePhotons) produces<std::vector<sim::SimPhotons> >();
     
     fNotFirstTime.clear(); // superfluous in C++20
   } // SimPMTIcarus::SimPMTIcarus()

icarus::opdet::SimPMTIcarus::SimPMTIcarus ( SimPMTIcarus const & )

delete

icarus::opdet::SimPMTIcarus::SimPMTIcarus ( SimPMTIcarus && )

delete

Member Function Documentation

bool icarus::opdet::SimPMTIcarus::firstTime ( )

inlineprivate

Returns whether no other event has been processed yet.

Definition at line 243 of file SimPMTIcarus_module.cc.

243 { return !fNotFirstTime.test_and_set(); }

icarus::opdet::SimPMTIcarus::fNotFirstTime

std::atomic_flag fNotFirstTime

True if firstTime() has already been called.

Definition: SimPMTIcarus_module.cc:240

SimPMTIcarus& icarus::opdet::SimPMTIcarus::operator= ( SimPMTIcarus const & )

delete

SimPMTIcarus& icarus::opdet::SimPMTIcarus::operator= ( SimPMTIcarus && )

delete

void icarus::opdet::SimPMTIcarus::produce ( art::Event & e )

override

Definition at line 286 of file SimPMTIcarus_module.cc.

   {
     mf::LogDebug("SimPMTIcarus") << e.id();
     
     //
     // fetch the input
     //
     auto pulseVecPtr = std::make_unique< std::vector< raw::OpDetWaveform > > ();
     
     std::unique_ptr<std::vector<sim::SimPhotons>> simphVecPtr;
     if (fWritePhotons)
       simphVecPtr = std::make_unique< std::vector< sim::SimPhotons > > ();
     
     //
     // prepare the output
     //
     art::Handle<std::vector<sim::SimPhotons> > pmtVector;
     art::Handle<std::vector<sim::SimPhotonsLite> > pmtLiteVector;
     pmtVector = e.getHandle< std::vector<sim::SimPhotons> >(fInputModuleName);
     if(!pmtVector.isValid())
       pmtLiteVector = e.getHandle< std::vector<sim::SimPhotonsLite> >(fInputModuleName);
     
     auto const clockData =
       art::ServiceHandle<detinfo::DetectorClocksService const>()->DataFor(e);
     //
     // prepare the algorithm
     //
     auto PMTsimulator = makePMTsimulator(
       *(lar::providerFrom<detinfo::LArPropertiesService>()),
       clockData,
       *fSinglePhotonResponseFunc,
       fEfficiencyEngine,
       fDarkNoiseEngine,
       fElectronicsNoiseEngine,
       fWritePhotons
       );
     
     if (firstTime()) {
       mf::LogDebug log { "SimPMTIcarus" };
       log << "PMT simulation configuration (first event):\n";
       PMTsimulator->printConfiguration(log);
     } // if first time
     
     //
     // run the algorithm
     //
     unsigned int nopch = 0;
     if(pmtVector.isValid()) {
       nopch = pmtVector->size();
       for(auto const& photons : *pmtVector) {
       
         // Make an empty SimPhotonsLite with the same channel number.
 
         sim::SimPhotonsLite lite_photons(photons.OpChannel());
 
         auto const& [ channelWaveforms, photons_used ]
           = PMTsimulator->simulate(photons, lite_photons);
         std::move(
           channelWaveforms.cbegin(), channelWaveforms.cend(),
           std::back_inserter(*pulseVecPtr)
           );
         if (simphVecPtr && photons_used)
           simphVecPtr->emplace_back(std::move(photons_used.value()));
 
       } // for
     }
     else if(pmtLiteVector.isValid()) {
       nopch = pmtLiteVector->size();
       for(auto const& lite_photons : *pmtLiteVector) {
 
         // Make an empty SimPhotons with the same channel number.
 
         sim::SimPhotons photons(lite_photons.OpChannel);
       
         auto const& [ channelWaveforms, photons_used ]
           = PMTsimulator->simulate(photons, lite_photons);
         std::move(
           channelWaveforms.cbegin(), channelWaveforms.cend(),
           std::back_inserter(*pulseVecPtr)
           );
 
       } // for
     }
 
     mf::LogInfo("SimPMTIcarus") << "Generated " << pulseVecPtr->size()
       << " waveforms out of " << nopch << " optical channels.";
     
     //
     // save the result
     //
     e.put(std::move(pulseVecPtr));
     if (simphVecPtr) e.put(std::move(simphVecPtr));
   } // SimPMTIcarus::produce()

Member Data Documentation

CLHEP::HepRandomEngine& icarus::opdet::SimPMTIcarus::fDarkNoiseEngine

private

Definition at line 235 of file SimPMTIcarus_module.cc.

CLHEP::HepRandomEngine& icarus::opdet::SimPMTIcarus::fEfficiencyEngine

private

Definition at line 234 of file SimPMTIcarus_module.cc.

CLHEP::HepRandomEngine& icarus::opdet::SimPMTIcarus::fElectronicsNoiseEngine

private

Definition at line 236 of file SimPMTIcarus_module.cc.

art::InputTag icarus::opdet::SimPMTIcarus::fInputModuleName

private

Input tag for simulated scintillation photons (or photoelectrons).

Definition at line 224 of file SimPMTIcarus_module.cc.

std::atomic_flag icarus::opdet::SimPMTIcarus::fNotFirstTime

private

True if firstTime() has already been called.

Definition at line 240 of file SimPMTIcarus_module.cc.

std::unique_ptr<SinglePhotonResponseFunc_t> const icarus::opdet::SimPMTIcarus::fSinglePhotonResponseFunc

private

Single photoelectron response function.

Definition at line 229 of file SimPMTIcarus_module.cc.

bool icarus::opdet::SimPMTIcarus::fWritePhotons { false }

private

Whether to save contributing photons.

Definition at line 226 of file SimPMTIcarus_module.cc.

icarus::opdet::PMTsimulationAlgMaker icarus::opdet::SimPMTIcarus::makePMTsimulator

private

The actual simulation algorithm.

Definition at line 232 of file SimPMTIcarus_module.cc.

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

SimPMTIcarus_module.cc

Classes

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Configuration

Input

Output

Requirements

Single photon response function tool

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation