icarus::opdet::PMTsimulationAlgMaker Class Reference

Returns a new PMTsimulationAlg with an updated configuration. More...

#include <PMTsimulationAlg.h>

Classes
struct	Config
	Main algorithm FHiCL configuration. More...
struct	PMTspecConfig

Public Types
using	microseconds = util::quantities::microsecond
using	nanoseconds = util::quantities::nanosecond
using	hertz = util::quantities::hertz
using	picocoulomb = util::quantities::picocoulomb

Public Member Functions
	PMTsimulationAlgMaker (Config const &config)
	Constructor. More...
std::unique_ptr< PMTsimulationAlg >	operator() (detinfo::LArProperties const &larProp, detinfo::DetectorClocksData const &detClocks, SinglePhotonResponseFunc_t const &SPRfunction, CLHEP::HepRandomEngine &mainRandomEngine, CLHEP::HepRandomEngine &darkNoiseRandomEngine, CLHEP::HepRandomEngine &elecNoiseRandomEngine, bool trackSelectedPhotons=false) const
	Creates and returns a new algorithm instance. More...
PMTsimulationAlg::ConfigurationParameters_t	makeParams (detinfo::LArProperties const &larProp, detinfo::DetectorClocksData const &clockData, SinglePhotonResponseFunc_t const &SPRfunction, CLHEP::HepRandomEngine &mainRandomEngine, CLHEP::HepRandomEngine &darkNoiseRandomEngine, CLHEP::HepRandomEngine &elecNoiseRandomEngine, bool trackSelectedPhotons=false) const
	Returns a data structure to construct the algorithm. More...

Private Attributes
PMTsimulationAlg::ConfigurationParameters_t	fBaseConfig
	Part of the configuration learned from configuration files. More...

Detailed Description

Returns a new PMTsimulationAlg with an updated configuration.

Definition at line 791 of file PMTsimulationAlg.h.

Member Typedef Documentation

using icarus::opdet::PMTsimulationAlgMaker::hertz = util::quantities::hertz

Definition at line 796 of file PMTsimulationAlg.h.

using icarus::opdet::PMTsimulationAlgMaker::microseconds = util::quantities::microsecond

Definition at line 794 of file PMTsimulationAlg.h.

using icarus::opdet::PMTsimulationAlgMaker::nanoseconds = util::quantities::nanosecond

Definition at line 795 of file PMTsimulationAlg.h.

using icarus::opdet::PMTsimulationAlgMaker::picocoulomb = util::quantities::picocoulomb

Definition at line 797 of file PMTsimulationAlg.h.

Constructor & Destructor Documentation

icarus::opdet::PMTsimulationAlgMaker::PMTsimulationAlgMaker

(

Config const &

config

)

Constructor.

Definition at line 747 of file PMTsimulationAlg.cxx.

{
  using util::quantities::microsecond;
  using util::quantities::nanosecond;
  using util::quantities::hertz;
  using util::quantities::megahertz;
  using util::quantities::picocoulomb;
  using ADCcount = icarus::opdet::PMTsimulationAlg::ADCcount;

  //
  // readout settings
  //
  fBaseConfig.readoutEnablePeriod      = config.ReadoutEnablePeriod();
  fBaseConfig.readoutWindowSize        = config.ReadoutWindowSize();
  fBaseConfig.baseline                 = ADCcount(config.Baseline());
  fBaseConfig.ADCbits                  = config.ADCBits();
  fBaseConfig.pulsePolarity            = config.PulsePolarity();
  fBaseConfig.pretrigFraction          = config.PreTrigFraction();
  fBaseConfig.triggerOffsetPMT         = config.TriggerOffsetPMT();

  //
  // PMT settings
  //
  auto const& PMTspecs = config.PMTspecs();
  fBaseConfig.saturation               = config.Saturation().value_or(0);
  fBaseConfig.QEbase                   = config.QE();
  fBaseConfig.PMTspecs.dynodeK         = PMTspecs.DynodeK();
  fBaseConfig.PMTspecs.setVoltageDistribution
                                        (PMTspecs.VoltageDistribution());
  fBaseConfig.PMTspecs.gain            = PMTspecs.Gain();
  fBaseConfig.doGainFluctuations       = config.FluctuateGain();

  //
  // single photoelectron response
  //
  fBaseConfig.pulseSubsamples          = config.PulseSubsamples();

  //
  // dark noise
  //
  fBaseConfig.darkNoiseRate            = hertz(config.DarkNoiseRate());

  //
  // electronics noise
  //
  fBaseConfig.ampNoise                 = ADCcount(config.AmpNoise());
  fBaseConfig.useFastElectronicsNoise  = config.FastElectronicsNoise();

  //
  // trigger
  //
  fBaseConfig.thresholdADC             = ADCcount(config.ThresholdADC());
  fBaseConfig.createBeamGateTriggers   = config.CreateBeamGateTriggers();
  fBaseConfig.beamGateTriggerRepPeriod = microsecond(config.BeamGateTriggerRepPeriod());
  fBaseConfig.beamGateTriggerNReps     = config.BeamGateTriggerNReps();

  //
  // parameter checks
  //
  if (std::abs(fBaseConfig.pulsePolarity) != 1.0) {
    throw cet::exception("PMTsimulationAlg")
      << "Pulse polarity settings can be only +1.0 or -1.0 (got: "
      << fBaseConfig.pulsePolarity << ")\n"
      ;
  } // check pulse polarity

  if (fBaseConfig.doGainFluctuations) {
    double const mu0 = fBaseConfig.PMTspecs.firstStageGain();
    if (!std::isnormal(mu0) || (mu0 < 0.0)) {
      cet::exception e("PMTsimulationAlg");
      e << "PMT gain " << fBaseConfig.PMTspecs.gain
        << ", dynode resistance values {";
      for (double rho: fBaseConfig.PMTspecs.voltageDistribution)
        e << " " << rho;
      e << " } and dynode k constant " << fBaseConfig.PMTspecs.dynodeK
        << " resulted in an invalid gain " << mu0
        << " for the first multiplication stage!\n";
      throw e;
    }
  } // if invalid gain fluctuation

} // icarus::opdet::PMTsimulationAlgMaker::PMTsimulationAlgMaker()

Member Function Documentation

auto icarus::opdet::PMTsimulationAlgMaker::makeParams	(	detinfo::LArProperties const &	larProp,
		detinfo::DetectorClocksData const &	clockData,
		SinglePhotonResponseFunc_t const &	SPRfunction,
		CLHEP::HepRandomEngine &	mainRandomEngine,
		CLHEP::HepRandomEngine &	darkNoiseRandomEngine,
		CLHEP::HepRandomEngine &	elecNoiseRandomEngine,
		bool	trackSelectedPhotons = false
	)		const

Returns a data structure to construct the algorithm.

Parameters

larProp	instance of detinfo::LArProperties to be used
detClocks	instance of detinfo::DetectorClocks to be used
SPRfunction	function to use for the single photon response
mainRandomEngine	main random engine (quantum efficiency, etc.)
darkNoiseRandomEngine	random engine for dark noise simulation
elecNoiseRandomEngine	random engine for electronics noise simulation

Returns a data structure ready to be used to construct a PMTsimulationAlg algorithm object, based on the configuration passed at construction time and the arguments specified in this function call.

All random engines are required in this interface, even if the configuration disabled noise simulation.

Definition at line 854 of file PMTsimulationAlg.cxx.

{
  using namespace util::quantities::electronics_literals;
  
  //
  // set the configuration
  //
  auto params = fBaseConfig;

  //
  // set up parameters
  //
  params.larProp = &larProp;
  params.clockData = &clockData;

  params.pulseFunction = &SPRfunction;

  params.randomEngine = &mainRandomEngine;
  params.gainRandomEngine = params.randomEngine;
  params.darkNoiseRandomEngine = &darkNoiseRandomEngine;
  params.elecNoiseRandomEngine = &elecNoiseRandomEngine;
  
  params.trackSelectedPhotons = trackSelectedPhotons;
  
  //
  // setup checks
  //
  bool const expectedNegativePolarity
    = (SPRfunction.peakAmplitude() < 0.0_ADCf);
  
  if (std::signbit(params.pulsePolarity) != expectedNegativePolarity) {
    throw cet::exception("PMTsimulationAlg")
      << "Inconsistent settings: pulse polarity declared "
      << params.pulsePolarity << ", but photoelectron waveform amplitude is "
      << SPRfunction.peakAmplitude()
      << "\n"
      ;
  } // check polarity consistency

  return params;
  
} // icarus::opdet::PMTsimulationAlgMaker::create()

std::unique_ptr< icarus::opdet::PMTsimulationAlg > icarus::opdet::PMTsimulationAlgMaker::operator()	(	detinfo::LArProperties const &	larProp,
		detinfo::DetectorClocksData const &	detClocks,
		SinglePhotonResponseFunc_t const &	SPRfunction,
		CLHEP::HepRandomEngine &	mainRandomEngine,
		CLHEP::HepRandomEngine &	darkNoiseRandomEngine,
		CLHEP::HepRandomEngine &	elecNoiseRandomEngine,
		bool	trackSelectedPhotons = false
	)		const

Creates and returns a new algorithm instance.

Parameters

larProp	instance of detinfo::LArProperties to be used
detClocks	instance of detinfo::DetectorClocks to be used
SPRfunction	function to use for the single photon response
mainRandomEngine	main random engine (quantum efficiency, etc.)
darkNoiseRandomEngine	random engine for dark noise simulation
elecNoiseRandomEngine	random engine for electronics noise simulation
trackSelectedPhotons	(default: false) keep track and return a copy of the scintillation photons used

All random engines are required in this interface, even if the configuration disabled noise simulation.

Definition at line 833 of file PMTsimulationAlg.cxx.

{
  return std::make_unique<PMTsimulationAlg>(makeParams(
    larProp, clockData,
    SPRfunction,
    mainRandomEngine, darkNoiseRandomEngine, elecNoiseRandomEngine,
    trackSelectedPhotons
    ));

} // icarus::opdet::PMTsimulationAlgMaker::operator()

Member Data Documentation

PMTsimulationAlg::ConfigurationParameters_t icarus::opdet::PMTsimulationAlgMaker::fBaseConfig

private

Part of the configuration learned from configuration files.

Definition at line 1007 of file PMTsimulationAlg.h.

---

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

• PMTsimulationAlg.h
• PMTsimulationAlg.cxx