NestYields
Link to source: NestYields
Plugin Description
Plugin that calculates the number of photons, electrons and excitons produced by energy deposit using nestpy.
Technical Details
depends_on = ('interactions_in_roi', 'electric_field_values')
provides = ('quanta',)
data_kind = interactions_in_roi
__version__ = 0.3.0
Provided Columns
quanta
Field Name |
Data Type |
Comment |
|---|---|---|
photons |
int32 |
Number of photons at interaction position |
electrons |
int32 |
Number of electrons at interaction position |
excitons |
int32 |
Number of excitons at interaction position |
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 |
fix_gamma_yield_field |
-1.0 |
True |
Field in V/cm to use for NEST gamma yield calculation. Only used if set to > 0. |
nest_er_yields_parameters |
take://resource://SIMULATION_CONFIG_FILE.json?&fmt=json&take=nest_er_yields_parameters |
True |
Set to modify default NEST ER yields parameters. Use -1 to keep default value. From NEST code https://github.com/NESTCollaboration/nest/blob/v2.4.0/src/NEST.cpp Used in the calcuations of BetaYieldsGR. |
nest_nr_yields_parameters |
take://resource://SIMULATION_CONFIG_FILE.json?&fmt=json&take=nest_nr_yields_parameters |
True |
Set to modify default NEST NR yields parameters. Use -1 to keep default value. |
nest_width_parameters |
take://resource://SIMULATION_CONFIG_FILE.json?&fmt=json&take=nest_width_parameters |
True |
Set to modify default NEST NRERWidthParameters to match recombination fluctuations. From NEST code https://github.com/NESTCollaboration/nest/blob/v2.4.0/src/NEST.cpp and NEST paper https://arxiv.org/abs/2211.10726 See self.get_nest_width_parameters() for the options and default values. Example use: {‘fano_ER’: -0.0015, ‘A_ER’: 0.096452} |
return_yields_only |
False |
True |
Set to True to return the yields model output directly instead of the calculated actual quanta with NEST getQuanta function. Only for testing purposes. |
user_defined_random_seed |
None |
True |
Define the random seed manually. You need to set deterministic_seed to False |