S1PhotonPropagation

Link to source: S1PhotonPropagation

Plugin Description

Child plugin to simulate the propagation of S1 photons using optical propagation and luminescence timing from nestpy.

Technical Details

depends_on = ('microphysics_summary', 's1_photon_hits')
provides = ('propagated_s1_photons',)
data_kind = s1_photons
__version__ = 0.3.2

child_plugin = True
parent_plugin_version = 0.3.3

Provided Columns

propagated_s1_photons

Field Name	Data Type	Comment
channel	int16	PMT channel of the photon
dpe	bool	Photon creates a double photo-electron emission
photon_gain	int32	Sampled PMT gain for the photon
cluster_id	int32	ID of the cluster creating the photon
photon_type	int8	Type of the photon. S1 (1), S2 (2) or PMT AP (0)
time	int64	Start time since unix epoch [ns]
endtime	int64	Exclusive end time since unix epoch [ns]

Config Options

Option	default	track	Help
debug	False	False	Show debug informations
deterministic_seed	True	True	Set the random seed from lineage and run_id, or pull the seed from the OS
digitizer_bits	take://resource://SIMULATION_CONFIG_FILE.json?&fmt=json&take=digitizer_bits	True	Number of bits of the digitizer boards
digitizer_voltage_range	take://resource://SIMULATION_CONFIG_FILE.json?&fmt=json&take=digitizer_voltage_range	True	Voltage range of the digitizer boards [V]
gain_model_mc	list-to-array://xedocs://pmt_area_to_pes?as_list=True&sort=pmt&detector=tpc&run_id=plugin.run_id&version=ONLINE&attr=value	True	PMT gain model
maximum_recombination_time	take://resource://SIMULATION_CONFIG_FILE.json?&fmt=json&take=maximum_recombination_time	True	Maximum recombination time [ns]
n_top_pmts	<OMITTED>	True	Number of PMTs on top array
n_tpc_pmts	<OMITTED>	True	Number of PMTs in the TPC
nest_time_sampling_max_loops	10	True	Maximum number of loops in the scintillation time calculation.

This is used to ensure that the number of drawn photon times after truncation is greateror equal to the number of photon hits.

• • override_s1_nr_scint_time

  • take://resource://SIMULATION_CONFIG_FILE.json?&fmt=json&take=override_s1_nr_scint_time

  • True

  • Whether to override arguments for NEST scintillation delay model for NRs.

• • p_double_pe_emision

  • take://resource://SIMULATION_CONFIG_FILE.json?&fmt=json&take=p_double_pe_emision

  • True

  • Probability of double photo-electron emission

• • photon_area_distribution

  • simple_load://resource://simulation_config://SIMULATION_CONFIG_FILE.json?&key=photon_area_distribution&fmt=csv

  • True

  • Photon area distribution

• • pmt_circuit_load_resistor

  • take://resource://SIMULATION_CONFIG_FILE.json?&fmt=json&take=pmt_circuit_load_resistor

  • True

  • PMT circuit load resistor [kg m^2/(s^3 A)]

• • pmt_transit_time_mean

  • take://resource://SIMULATION_CONFIG_FILE.json?&fmt=json&take=pmt_transit_time_mean

  • True

  • Mean of the PMT transit times [ns]

• • pmt_transit_time_spread

  • take://resource://SIMULATION_CONFIG_FILE.json?&fmt=json&take=pmt_transit_time_spread

  • True

  • Spread of the PMT transit times [ns]

• • s1_nr_scint_time_ed_override

  • take://resource://SIMULATION_CONFIG_FILE.json?&fmt=json&take=s1_nr_scint_time_ed_override

  • True

  • [keV] Used in NR scintillation delay calculation if override_s1_nr_scint_time==true.Overrides energy of NEST scintillation delay model for better match to NR data.

• • s1_nr_scint_time_excitonfrac_override

  • take://resource://SIMULATION_CONFIG_FILE.json?&fmt=json&take=s1_nr_scint_time_excitonfrac_override

  • True

  • Used in NR scintillation delay calculation if override_s1_nr_scint_time==true.Overrides exciton fraction of NEST scintillation delay model for better match to NR data.

• • s1_nr_scint_time_nesttype_override

  • take://resource://SIMULATION_CONFIG_FILE.json?&fmt=json&take=s1_nr_scint_time_nesttype_override

  • True

  • Used in NR scintillation delay calculation if override_s1_nr_scint_time==true.Overrides NESTtype of NEST scintillation delay model for better match to NR data.

• • s1_optical_propagation_spline

  • itp_map://resource://simulation_config://SIMULATION_CONFIG_FILE.json?&key=s1_time_spline&fmt=json.gz&method=RegularGridInterpolator

  • True

  • Spline for the optical propagation of S1 signals

• • s1_pattern_map

  • pattern_map://resource://simulation_config://SIMULATION_CONFIG_FILE.json?&key=s1_pattern_map&fmt=pkl&pmt_mask=plugin.pmt_mask

  • True

  • S1 pattern map

• • user_defined_random_seed

  • None

  • True

  • Define the random seed manually. You need to set deterministic_seed to False

Dependency Graph