Type holding all configuration parameters for this algorithm. More...

#include <PMTsimulationAlg.h>

Classes
struct	PMTspecs_t

Public Member Functions
Derivative configuration parameters.
std::size_t	pretrigSize () const

std::size_t	posttrigSize () const

ADCcount	maxADC () const

std::pair< ADCcount, ADCcount >	ADCrange () const

Public Attributes
High level configuration parameters.
double	QEbase
	Uncorrected PMT quantum efficiency. More...

size_t	readoutWindowSize
	ReadoutWindowSize in samples. More...

float	pretrigFraction
	Fraction of window size to be before "trigger". More...

ADCcount	thresholdADC
	ADC Threshold for self-triggered readout. More...

int	pulsePolarity
	Pulse polarity (=1 for positive, =-1 for negative) More...

microseconds	triggerOffsetPMT
	Time relative to trigger when PMT readout starts TODO make it a `trigger_time` point. More...

microseconds	readoutEnablePeriod
	Time (us) for which pmt readout is enabled. More...

bool	createBeamGateTriggers
	Option to create unbiased readout around beam spill. More...

microseconds	beamGateTriggerRepPeriod
	Repetition Period (us) for BeamGateTriggers TODO make this a time_interval. More...

size_t	beamGateTriggerNReps
	Number of beamgate trigger reps to produce. More...

unsigned int	pulseSubsamples = 1U
	Number of tick subsamples. More...

unsigned int	ADCbits = 14U
	Number of bits of the digitizer. More...

ADCcount	baseline

ADCcount	ampNoise

bool	useFastElectronicsNoise
	Whether to use fast generator for electronics noise. More...

hertz	darkNoiseRate

float	saturation

PMTspecs_t	PMTspecs
	PMT specifications. More...

bool	doGainFluctuations

Setup parameters
detinfo::LArProperties const *	larProp = nullptr
	LarProperties service provider. More...

detinfo::DetectorClocksData const *	clockData = nullptr

SinglePhotonResponseFunc_t const *	pulseFunction
	Single photon response function. More...

CLHEP::HepRandomEngine *	randomEngine = nullptr
	Main random stream engine. More...

CLHEP::HepRandomEngine *	gainRandomEngine = nullptr
	Random stream engine for gain fluctuations. More...

CLHEP::HepRandomEngine *	darkNoiseRandomEngine = nullptr
	Dark noise random stream engine. More...

CLHEP::HepRandomEngine *	elecNoiseRandomEngine = nullptr
	Electronics noise random stream engine. More...

bool	trackSelectedPhotons = false
	Whether to track the scintillation photons used. More...

Detailed Description

Type holding all configuration parameters for this algorithm.

Definition at line 356 of file PMTsimulationAlg.h.

Member Function Documentation

std::pair<ADCcount, ADCcount> icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::ADCrange ( ) const

inline

Definition at line 481 of file PMTsimulationAlg.h.

482 { return { ADCcount{ 0 }, maxADC() }; }

icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::maxADC

ADCcount maxADC() const

Definition: PMTsimulationAlg.h:479

icarus::opdet::PMTsimulationAlg::ADCcount

DiscretePhotoelectronPulse::ADCcount ADCcount

Definition: PMTsimulationAlg.h:350

ADCcount icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::maxADC ( ) const

inline

Definition at line 479 of file PMTsimulationAlg.h.

479 { return ADCcount::castFrom((1 << ADCbits) - 1); }

util::quantities::concepts::Quantity::castFrom

static constexpr quantity_t castFrom(U value)

Returns a new quantity initialized with the specified value.

Definition: quantities.h:825

icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::ADCbits

unsigned int ADCbits

Number of bits of the digitizer.

Definition: PMTsimulationAlg.h:435

std::size_t icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::posttrigSize ( ) const

inline

Definition at line 477 of file PMTsimulationAlg.h.

477 { return readoutWindowSize - pretrigSize(); }

icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::pretrigSize

std::size_t pretrigSize() const

Definition: PMTsimulationAlg.h:476

icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::readoutWindowSize

size_t readoutWindowSize

ReadoutWindowSize in samples.

Definition: PMTsimulationAlg.h:421

std::size_t icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::pretrigSize ( ) const

inline

Definition at line 476 of file PMTsimulationAlg.h.

476 { return pretrigFraction * readoutWindowSize; }

icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::pretrigFraction

float pretrigFraction

Fraction of window size to be before "trigger".

Definition: PMTsimulationAlg.h:422

icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::readoutWindowSize

size_t readoutWindowSize

ReadoutWindowSize in samples.

Definition: PMTsimulationAlg.h:421

Member Data Documentation

unsigned int icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::ADCbits = 14U

Number of bits of the digitizer.

Definition at line 435 of file PMTsimulationAlg.h.

ADCcount icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::ampNoise

Definition at line 437 of file PMTsimulationAlg.h.

ADCcount icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::baseline

Definition at line 436 of file PMTsimulationAlg.h.

size_t icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::beamGateTriggerNReps

Number of beamgate trigger reps to produce.

Definition at line 431 of file PMTsimulationAlg.h.

microseconds icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::beamGateTriggerRepPeriod

Repetition Period (us) for BeamGateTriggers TODO make this a time_interval.

Definition at line 430 of file PMTsimulationAlg.h.

detinfo::DetectorClocksData const* icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::clockData = nullptr

Definition at line 451 of file PMTsimulationAlg.h.

bool icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::createBeamGateTriggers

Option to create unbiased readout around beam spill.

Definition at line 429 of file PMTsimulationAlg.h.

CLHEP::HepRandomEngine* icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::darkNoiseRandomEngine = nullptr

Dark noise random stream engine.

Definition at line 463 of file PMTsimulationAlg.h.

hertz icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::darkNoiseRate

Definition at line 439 of file PMTsimulationAlg.h.

bool icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::doGainFluctuations

Whether to simulate fain fluctuations.

Definition at line 442 of file PMTsimulationAlg.h.

CLHEP::HepRandomEngine* icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::elecNoiseRandomEngine = nullptr

Electronics noise random stream engine.

Definition at line 466 of file PMTsimulationAlg.h.

CLHEP::HepRandomEngine* icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::gainRandomEngine = nullptr

Random stream engine for gain fluctuations.

Definition at line 460 of file PMTsimulationAlg.h.

detinfo::LArProperties const* icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::larProp = nullptr

LarProperties service provider.

Definition at line 449 of file PMTsimulationAlg.h.

PMTspecs_t icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::PMTspecs

PMT specifications.

Definition at line 441 of file PMTsimulationAlg.h.

float icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::pretrigFraction

Fraction of window size to be before "trigger".

Definition at line 422 of file PMTsimulationAlg.h.

SinglePhotonResponseFunc_t const* icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::pulseFunction

Single photon response function.

Definition at line 454 of file PMTsimulationAlg.h.

int icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::pulsePolarity

Pulse polarity (=1 for positive, =-1 for negative)

Definition at line 424 of file PMTsimulationAlg.h.

unsigned int icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::pulseSubsamples = 1U

Number of tick subsamples.

Definition at line 433 of file PMTsimulationAlg.h.

double icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::QEbase

Uncorrected PMT quantum efficiency.

Definition at line 419 of file PMTsimulationAlg.h.

CLHEP::HepRandomEngine* icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::randomEngine = nullptr

Main random stream engine.

Definition at line 457 of file PMTsimulationAlg.h.

microseconds icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::readoutEnablePeriod

Time (us) for which pmt readout is enabled.

Definition at line 427 of file PMTsimulationAlg.h.

size_t icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::readoutWindowSize

ReadoutWindowSize in samples.

Definition at line 421 of file PMTsimulationAlg.h.

float icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::saturation

Definition at line 440 of file PMTsimulationAlg.h.

ADCcount icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::thresholdADC

ADC Threshold for self-triggered readout.

Definition at line 423 of file PMTsimulationAlg.h.

bool icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::trackSelectedPhotons = false

Whether to track the scintillation photons used.

Definition at line 469 of file PMTsimulationAlg.h.

microseconds icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::triggerOffsetPMT

Time relative to trigger when PMT readout starts TODO make it a trigger_time point.

Definition at line 425 of file PMTsimulationAlg.h.

bool icarus::opdet::PMTsimulationAlg::ConfigurationParameters_t::useFastElectronicsNoise

Whether to use fast generator for electronics noise.

Definition at line 438 of file PMTsimulationAlg.h.

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

PMTsimulationAlg.h

Classes

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation