Inheritance diagram for opdet::SIPMOpSensorSim:

Classes
struct	Config

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

Public Types inherited from art::EDProducer
using	ModuleType = EDProducer

using	WorkerType = WorkerT< EDProducer >

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

Public Types inherited from art::Modifier
template<typename UserConfig , typename UserKeysToIgnore = void>
using	Table = ProducerTable< UserConfig, detail::ModuleConfig, UserKeysToIgnore >

Public Member Functions
	SIPMOpSensorSim (Parameters const &config)

void	produce (art::Event &) override

Public Member Functions inherited from art::EDProducer
	EDProducer (fhicl::ParameterSet const &pset)

template<typename Config >
	EDProducer (Table< Config > const &config)

std::string	workerType () const

Public Member Functions inherited from art::detail::Producer
virtual	~Producer () noexcept

	Producer (fhicl::ParameterSet const &)

	Producer (Producer const &)=delete

	Producer (Producer &&)=delete

Producer &	operator= (Producer const &)=delete

Producer &	operator= (Producer &&)=delete

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)

Public Member Functions inherited from art::Modifier
	~Modifier () noexcept

	Modifier ()

	Modifier (Modifier const &)=delete

	Modifier (Modifier &&)=delete

Modifier &	operator= (Modifier const &)=delete

Modifier &	operator= (Modifier &&)=delete

Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept

	ModuleBase ()

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)

template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)

template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Private Member Functions
void	PhotonsToPE (sim::OpDetBacktrackerRecord const &btr, sim::OpDetDivRec &dr_plusnoise)

void	AddDarkNoise (sim::OpDetDivRec &)

unsigned short	CrossTalk ()

void	SetBeginEndTimes ()

Private Attributes
art::InputTag	fInputTag

art::ProductToken< std::vector< sim::OpDetBacktrackerRecord > >	fInputToken

double	fQE

double	fDarkNoiseRate

double	fCrossTalk

double	fTimeBegin

double	fTimeEnd

bool	fCorrectLateLight

double	fLateLightCorrection

double	fLateLightBoundary

CLHEP::HepRandomEngine &	fSIPMEngine

CLHEP::RandExponential	fRandExponential

CLHEP::RandFlat	fRandFlat

CLHEP::RandPoissonQ	fRandPoissPhot

Additional Inherited Members
Static Public Member Functions inherited from art::EDProducer
static void	commitEvent (EventPrincipal &ep, Event &e)

Protected Member Functions inherited from art::ModuleBase
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 ()

Detailed Description

Definition at line 69 of file SIPMOpSensorSim_module.cc.

Member Typedef Documentation

using opdet::SIPMOpSensorSim::Parameters = art::EDProducer::Table<Config>

Definition at line 85 of file SIPMOpSensorSim_module.cc.

Constructor & Destructor Documentation

opdet::SIPMOpSensorSim::SIPMOpSensorSim ( Parameters const & config )

explicit

Definition at line 136 of file SIPMOpSensorSim_module.cc.

     : art::EDProducer{config}
     , fInputTag{     config().InputTag()}
     , fInputToken{   consumes< std::vector<sim::OpDetBacktrackerRecord> >(fInputTag) }
     , fDarkNoiseRate{config().DarkNoiseRate()}
     , fCrossTalk{    config().CrossTalk()}
     , fSIPMEngine(   art::ServiceHandle<rndm::NuRandomService>()->createEngine(*this, 
                                                                                "HepJamesRandom",
                                                                                "sipm", 
                                                                                config.get_PSet(), 
                                                                                "SeedSiPM"))
     , fRandExponential(fSIPMEngine)
     , fRandFlat(fSIPMEngine)
     , fRandPoissPhot(fSIPMEngine)
   {
 
     // This module produces (infrastructure piece)
     produces< std::vector< sim::OpDetDivRec > >();
 
 
     if (fDarkNoiseRate < 0.0) {
       throw art::Exception(art::errors::Configuration) 
         << "fDarkNoiseRate: " << fDarkNoiseRate << '\n'
         << "Dark noise rate should be non-negative!\n";
     }
 
 
     double tempQE = config().QuantumEfficiency() * config().Correction();
     if (tempQE < 0 || tempQE > 1) {
       throw art::Exception(art::errors::Configuration) 
         << "QuantumEfficiency in SIPMSensorSim: " << config().QuantumEfficiency() << "\n"
         << "                   with correction: " << config().Correction() << "\n"
         << "       leading to total efficiency: " << tempQE << "\n"
         << "It should be between 0 and 1!\n";
     }
 
     // Correct out the prescaling applied during simulation
     auto const *LarProp = lar::providerFrom<detinfo::LArPropertiesService>();
     fQE = tempQE / LarProp->ScintPreScale();
 
     if (fQE > 1.0001 ) {
       throw art::Exception(art::errors::Configuration)
         << "QuantumEfficiency in SIPMSensorSim: " << config().QuantumEfficiency() << "\n"
         << "                   with correction: " << config().Correction() << "\n"
         << "       leading to total efficiency: " << tempQE << "\n"
         << "is too large.\n"
         << "It is larger than the prescaling applied during simulation, " << LarProp->ScintPreScale() << ".\n"
         << "Final QE must be equal to or smaller than the QE applied at simulation time.\n";
     }
 
 
     // Check for non-trivial channel mapping which is not supported
     art::ServiceHandle< geo::Geometry > geometry;
     for (unsigned int opDet = 0; opDet < geometry->NOpDets() ; ++opDet) {
       if (geometry->NOpHardwareChannels(opDet) > 1)
         throw art::Exception(art::errors::Configuration)
           << "OpDet #" << opDet << " has " << geometry->NOpHardwareChannels(opDet) 
           << " channels associated with it. \n"
           << "This kind of channel mapping is not supported by SIPMOpSensorSim.\n"
           << "You need to use the legacy OpDetDigitizerDUNE instead.\n";
     }
 
     // Set time ranges if needed for dark noise
     if (fDarkNoiseRate > 0) SetBeginEndTimes();
 
     // Check for optional parameters for adjusting late light.
     // Apply adjustments if both are given.
     // Throw an error if only one is specified.
     bool haveCorrection = config().LateLightCorrection(fLateLightCorrection);
     bool haveBoundary   = config().LateLightBoundary(fLateLightBoundary);
     fCorrectLateLight = haveBoundary && haveCorrection;
 
     if (haveBoundary != haveCorrection) {
       throw art::Exception(art::errors::Configuration)
         << "Must specify both LateLightCorrection and LateLightBoundary in order to apply correction.\n"
         << "Leave both out to not adjust late light.\n";
     }
 
     if (fCorrectLateLight && fLateLightCorrection*tempQE > LarProp->ScintPreScale())
     {
       throw art::Exception(art::errors::Configuration)
         << "QuantumEfficiency in SIPMSensorSim: " << config().QuantumEfficiency() << "\n"
         << "                   with correction: " << config().Correction() << "\n"
         << "         and late light correction: " << fLateLightCorrection << "\n"
         << "       leading to total efficiency: " << tempQE * fLateLightCorrection << "\n"
         << "is too large.\n"
         << "It is larger than the prescaling applied during simulation, " << LarProp->ScintPreScale() << ".\n"
         << "Final QE must be equal to or smaller than the QE applied at simulation time.\n";
     }
   }

Member Function Documentation

void opdet::SIPMOpSensorSim::AddDarkNoise ( sim::OpDetDivRec & dr_plusnoise )

private

Definition at line 314 of file SIPMOpSensorSim_module.cc.

   {
 
     double tau = 1.0/fDarkNoiseRate*1.e6; // Typical time between Dark counts in us
                                           // Multiply by 10^6 since fDarkNoiseRate is in Hz
 
     double darkNoiseTime = fRandExponential.fire(tau) + fTimeBegin;
     while (darkNoiseTime < fTimeEnd) {
             //Currently using all zeros as an indicator of Dark Noise for the trackID.
       int PE = 1+CrossTalk();
       for(int j = 0; j < PE; j++) {
         dr_plusnoise.AddPhoton(dr_plusnoise.OpDetNum(), 0, darkNoiseTime);
       }
 
       // Find next time to simulate a single PE pulse
       darkNoiseTime += fRandExponential.fire(tau);
     }
   }

unsigned short opdet::SIPMOpSensorSim::CrossTalk ( )

private

Definition at line 305 of file SIPMOpSensorSim_module.cc.

   {
     // Use recursion to allow cross talk to create cross talk
     if      (fCrossTalk <= 0.0)                 return 0;
     else if (fRandFlat.fire(1.0) > fCrossTalk)  return 0;
     else                                        return 1+CrossTalk();
   }

void opdet::SIPMOpSensorSim::PhotonsToPE	(	sim::OpDetBacktrackerRecord const &	btr,
		sim::OpDetDivRec &	dr_plusnoise
	)

private

Definition at line 257 of file SIPMOpSensorSim_module.cc.

   {
     // Don't do anything without any records
     if (btr.timePDclockSDPsMap().size() == 0)
       return;
 
     // Get the earliest time in the BTR
     double firstTime = btr.timePDclockSDPsMap()[0].first;
     if (fCorrectLateLight) {
       for (auto time_sdps : btr.timePDclockSDPsMap()) {
         double time = btr.timePDclockSDPsMap()[0].first;
         if (time < firstTime) firstTime = time;
       }
     }
 
     // Loop through times in vector< pair< arrival time (in ns), vector< SDP > > >
     for (auto const& [time, sdps]: btr.timePDclockSDPsMap()) {
 
       double lateScale = 1.;
       if (fCorrectLateLight) {
         if (time > firstTime + fLateLightBoundary)
           lateScale = fLateLightCorrection;
       }
 
       // Loop through SDPs
       for(auto const& sdp : sdps) {
 
         // Reduce true photons by QE, poisson-fluctuate
         int nphot = fRandPoissPhot.fire(fQE * (double)sdp.numPhotons * lateScale);
 
         // For each true photon detected
         for(int truePh=0; truePh<nphot; ++truePh) {
 
           // Determine actual PE with Cross Talk
           unsigned int PE = 1+CrossTalk();
           for(unsigned int i = 0; i < PE; i++) {
             // Add to collection
             dr_plusnoise.AddPhoton(btr.OpDetNum(), // Channel
                                    sdp.trackID,    // TrackID
                                    time);          // Time
           }
         }
       }
     }
   }

void opdet::SIPMOpSensorSim::produce ( art::Event & event )

overridevirtual

Implements art::EDProducer.

Definition at line 229 of file SIPMOpSensorSim_module.cc.

   {
     // A pointer that will store produced OpDetDivRec
     auto OpDetDivRecPtr = std::make_unique< std::vector< sim::OpDetDivRec > >();
 
     // Get OpDetBacktrackerRecord from the event
     auto const & btr_handle = event.getValidHandle(fInputToken);
 
     // For every optical detector:
     for (auto const& btr : *btr_handle) {
       int opDet = btr.OpDetNum();
 
       auto DivRecPlusNoise = sim::OpDetDivRec(opDet);
 
       PhotonsToPE(btr, DivRecPlusNoise);
 
       // Generate dark noise
       if (fDarkNoiseRate > 0.0) AddDarkNoise(DivRecPlusNoise);
 
       // AddAfterPulsing();
 
       OpDetDivRecPtr->emplace_back(DivRecPlusNoise);
     }
 
     event.put(std::move(OpDetDivRecPtr));
   }

void opdet::SIPMOpSensorSim::SetBeginEndTimes ( )

private

Definition at line 334 of file SIPMOpSensorSim_module.cc.

   {
 
     // Get the window start/end time from the detector properties services
     auto const clockData = art::ServiceHandle<detinfo::DetectorClocksService const>()->DataForJob();
     auto const detProp   = art::ServiceHandle<detinfo::DetectorPropertiesService const>()->DataForJob(clockData);
     auto const geometry  = art::ServiceHandle< geo::Geometry >();
 
     double maxDrift = 0.0;
     for (geo::TPCGeo const& tpc : geometry->IterateTPCs())
       if (maxDrift < tpc.DriftDistance()) maxDrift = tpc.DriftDistance();
 
     // Start at -1 drift window
     fTimeBegin = -1*maxDrift/detProp.DriftVelocity();
 
     // Take the TPC readout window size and convert
     // to us with the electronics clock frequency
     fTimeEnd   = detProp.ReadOutWindowSize() / clockData.TPCClock().Frequency();
   }

Member Data Documentation

bool opdet::SIPMOpSensorSim::fCorrectLateLight

private

Definition at line 103 of file SIPMOpSensorSim_module.cc.

double opdet::SIPMOpSensorSim::fCrossTalk

private

Definition at line 97 of file SIPMOpSensorSim_module.cc.

double opdet::SIPMOpSensorSim::fDarkNoiseRate

private

Definition at line 96 of file SIPMOpSensorSim_module.cc.

art::InputTag opdet::SIPMOpSensorSim::fInputTag

private

Definition at line 93 of file SIPMOpSensorSim_module.cc.

art::ProductToken< std::vector<sim::OpDetBacktrackerRecord> > opdet::SIPMOpSensorSim::fInputToken

private

Definition at line 94 of file SIPMOpSensorSim_module.cc.

double opdet::SIPMOpSensorSim::fLateLightBoundary

private

Definition at line 105 of file SIPMOpSensorSim_module.cc.

double opdet::SIPMOpSensorSim::fLateLightCorrection

private

Definition at line 104 of file SIPMOpSensorSim_module.cc.

double opdet::SIPMOpSensorSim::fQE

private

Definition at line 95 of file SIPMOpSensorSim_module.cc.

CLHEP::RandExponential opdet::SIPMOpSensorSim::fRandExponential

private

Definition at line 109 of file SIPMOpSensorSim_module.cc.

CLHEP::RandFlat opdet::SIPMOpSensorSim::fRandFlat

private

Definition at line 110 of file SIPMOpSensorSim_module.cc.

CLHEP::RandPoissonQ opdet::SIPMOpSensorSim::fRandPoissPhot

private

Definition at line 111 of file SIPMOpSensorSim_module.cc.

CLHEP::HepRandomEngine& opdet::SIPMOpSensorSim::fSIPMEngine

private

Definition at line 108 of file SIPMOpSensorSim_module.cc.

double opdet::SIPMOpSensorSim::fTimeBegin

private

Definition at line 99 of file SIPMOpSensorSim_module.cc.

double opdet::SIPMOpSensorSim::fTimeEnd

private

Definition at line 100 of file SIPMOpSensorSim_module.cc.

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

duneopdet/duneopdet/OpticalDetector/SIPMOpSensorSim_module.cc

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation