Pema datastructure
This page is an autogenerated reference for all the plugins in straxen’s xenonnt_online context.
Colors indicate data kinds. To load tables with different data kinds, you currently need more than one get_df (or get_array) commands.
truth_extended
Description
Provided by plugin: TruthExtended
Data kind: truth
Merge the matched acceptance to the extended truth
Columns provided
| Field name | Data type | Comment |
|---|---|---|
| time | int64 | Start time since unix epoch [ns] |
| endtime | int64 | Exclusive end time since unix epoch [ns] |
| is_found | bool | Is the peak tagged "found" in the reconstructed data |
| acceptance_fraction | float64 | Acceptance of the peak can be negative for penalized reconstruction |
| rec_bias | float64 | Reconstruction bias 1 is perfect, 0.1 means incorrect |
| rec_area | float32 | Peak integral in PE |
| rec_range_50p_area | float32 | Width (in ns) of the central 50% area of the peak |
| rec_area_fraction_top | float32 | Fraction of area seen by the top array (NaN for peaks with non-positive area) |
| rec_rise_time | float32 | Time between 10% and 50% area quantiles [ns] |
| rec_tight_coincidence | int16 | Number of PMTs with hits within tight range of mean |
| event_number | int32 | Waveform simulator event number. |
| type | int8 | Quanta type (S1 photons or S2 electrons) |
| x | float32 | X position of the cluster [cm] |
| y | float32 | Y position of the cluster [cm] |
| z | float32 | Z position of the cluster [cm] |
| amp | int32 | Number of quanta |
| recoil | int8 | Recoil type of interaction. |
| e_dep | float32 | Energy deposit of interaction |
| tot_e | float32 | Total energy deposit in the sensitive volume |
| g4id | int32 | Eventid like in geant4 output rootfile |
| vol_id | int32 | Volume id giving the detector subvolume |
| local_field | float64 | Local field [ V / cm ] |
| n_excitons | int32 | Number of excitons |
| x_pri | float32 | X position of the primary particle [cm] |
| y_pri | float32 | Y position of the primary particle [cm] |
| z_pri | float32 | Z position of the primary particle [cm] |
| n_electron | int32 | Number of simulated electrons |
| n_photon | int32 | Number of photons reaching PMT |
| n_pe | int32 | Number of photons + dpe passing |
| n_photon_trigger | int32 | Number of photons passing trigger |
| n_pe_trigger | int32 | Number of photons + dpe passing trigger |
| raw_area | float64 | Raw area in pe |
| raw_area_trigger | float64 | Raw area in pe passing trigger |
| n_photon_bottom | int32 | Number of photons reaching PMT (bottom) |
| n_pe_bottom | int32 | Number of photons + dpe passing (bottom) |
| n_photon_trigger_bottom | int32 | Number of photons passing trigger (bottom) |
| n_pe_trigger_bottom | int32 | Number of photons + dpe passing trigger (bottom) |
| raw_area_bottom | float64 | Raw area in pe (bottom) |
| raw_area_trigger_bottom | float64 | Raw area in pe passing trigger (bottom) |
| t_first_photon | float64 | Arrival time of the first photon [ns] |
| t_last_photon | float64 | Arrival time of the last photon [ns] |
| t_mean_photon | float64 | Mean time of the photons [ns] |
| t_sigma_photon | float64 | Standard deviation of photon arrival times [ns] |
| x_mean_electron | float32 | X field-distorted mean position of the electrons [cm] |
| y_mean_electron | float32 | Y field-distorted mean position of the electrons [cm] |
| t_first_electron | float64 | Arrival time of the first electron [ns] |
| t_last_electron | float64 | Arrival time of the last electron [ns] |
| t_mean_electron | float64 | Mean time of the electrons [ns] |
| t_sigma_electron | float64 | Standard deviation of electron arrival times [ns] |
| id | int64 | Id of element in truth |
| outcome | <U32 | Outcome of matching to peaks |
| matched_to | int64 | Id of matching element in peaks |
Dependencies
Configuration options
These are all options that affect this data type. This also includes options taken by dependencies of this datatype, because changing any of those options affect this data indirectly.
| option | default | current | applies_to | help |
|---|---|---|---|---|
| allow_sloppy_chunking | False | <OMITTED> | (records, veto_regions, pulse_counts) | Use a default baseline for incorrectly chunked fragments. This is a kludge for improperly converted XENON1T data. |
| baseline_samples | 40 | <OMITTED> | (records, veto_regions, pulse_counts) | Number of samples to use at the start of the pulse to determine the baseline |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (raw_records, raw_records_he, raw_records_aqmon, truth) | immutabledict mapping subdetector to (min, max) channel number. Provided by context |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (peaklets, lone_hits) | immutabledict mapping subdetector to (min, max) channel number. |
| check_peak_sum_area_rtol | None | <OMITTED> | (peak_basics,) | Check if the sum area and the sum of area per channel are the same. If None, don't do the check. To perform the check, set to the desired rtol value used e.g. '1e-4' (see np.isclose). |
| check_raw_record_overlaps | True | False | (records, veto_regions, pulse_counts) | Crash if any of the pulses in raw_records overlap with others in the same channel |
| chunk_size | 100 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Duration of each chunk in seconds |
| detector | XENONnT | XENONnT | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| diagnose_sorting | False | <OMITTED> | (peaklets, lone_hits) | Enable runtime checks for sorting and disjointness |
| diagnose_sorting | False | <OMITTED> | (peaks,) | Enable runtime checks for sorting and disjointness |
| event_rate | 1000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Average number of events per second |
| fax_config | fax_config_nt_design.json | fax_config_nt_design.json | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| fax_config_override | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary with configuration option overrides |
| fax_config_override_from_cmt | None | {'drift_time_gate': ('cmt_run_id', '0', 'electron_drift_time_gate', 'ONLINE', True), 'drift_velocity_liquid': ('cmt_run_id', '0', 'electron_drift_velocity', 'ONLINE', True), 'electron_lifetime_liquid': ('cmt_run_id', '0', 'elife', 'ONLINE', True)} | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary of fax parameter names (key) mapped to CMT config names (value)where the fax parameter values will be replaced by CMT |
| fax_file | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Directory with fax instructions |
| gain_model | <OMITTED> | cmt://to_pe_model?run_id=0&version=ONLINE | (peaklets, lone_hits) | PMT gain model. Specify as URL or explicit value |
| gain_model | <OMITTED> | cmt://to_pe_model?run_id=0&version=ONLINE | (merged_s2s,) | PMT gain model. Specify as (str(model_config), str(version), nT-->boolean |
| gain_model_mc | cmt://to_p...gin.run_id | cmt://to_pe_model?run_id=0&version=ONLINE | (raw_records, raw_records_he, raw_records_aqmon, truth) | PMT gain model. Specify as (model_type, model_config). |
| hev_gain_model | None | <OMITTED> | (records, veto_regions, pulse_counts) | PMT gain model used in the software high-energy veto. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (peaklets, lone_hits) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (records, veto_regions, pulse_counts) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| keep_peak_fields | (area, range_50p_area, area_fraction_top, rise_time, tight_coincidence) | <OMITTED> | (match_acceptance,) | Add the reconstructed value of these variables |
| max_veto_value | None | <OMITTED> | (records, veto_regions, pulse_counts) | Optionally pass a HE peak that exceeds this absolute area. (if performing a hard veto, can keep a few statistics.) |
| merge_without_s1 | True | <OMITTED> | (peaks,) | If true, S1s will be igored during the merging. It's now possible for a S1 to be inside a S2 post merging |
| merge_without_s1 | True | <OMITTED> | (merged_s2s,) | If true, S1s will be igored during the merging. It's now possible for a S1 to be inside a S2 post merging |
| merged_s2s_get_window_size_factor | 5 | <OMITTED> | (merged_s2s,) | Factor of the window size for the merged_s2s plugin |
| min_s2_bias_rec | 0.85 | <OMITTED> | (match_acceptance,) | If the S2 fraction is greater or equal than this, consider a peak successfully found even if it is split or chopped. |
| n_chunk | 10 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of chunks to simulate |
| n_top_pmts | 253 | 253 | (peak_basics,) | Number of top PMTs |
| n_top_pmts | <OMITTED> | 253 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in top array. Provided by context |
| n_top_pmts | <OMITTED> | 253 | (merged_s2s,) | Number of top TPC array PMTs |
| n_top_pmts | 253 | 253 | (peaklet_classification,) | Number of top PMTs |
| n_top_pmts | <OMITTED> | 253 | (peaklets, lone_hits) | Number of top TPC array PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (records, veto_regions, pulse_counts) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (peaklets, lone_hits) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in tpc. Provided by context |
| n_tpc_pmts | <OMITTED> | 494 | (merged_s2s,) | Number of TPC PMTs |
| peak_left_extension | 30 | <OMITTED> | (peaklets, lone_hits) | Include this many ns left of hits in peaks |
| peak_min_pmts | 2 | <OMITTED> | (peaklets, lone_hits) | Minimum number of contributing PMTs needed to define a peak |
| peak_right_extension | 200 | <OMITTED> | (peaklets, lone_hits) | Include this many ns right of hits in peaks |
| peak_split_filter_wing_width | 70 | <OMITTED> | (peaklets, lone_hits) | Wing width of moving average filter for low-split natural breaks |
| peak_split_gof_threshold | (None, ((0.5, 1.0), (6.0, 0.4)), ((2.5, 1.0), (5.625, 0.4))) | <OMITTED> | (peaklets, lone_hits) | Natural breaks goodness of fit/split threshold to split a peak. Specify as tuples of (log10(area), threshold). |
| peak_split_iterations | 20 | <OMITTED> | (peaklets, lone_hits) | Maximum number of recursive peak splits to do. |
| peak_split_min_area | 40.0 | <OMITTED> | (peaklets, lone_hits) | Minimum area to evaluate natural breaks criterion. Smaller peaks are not split. |
| peaklet_gap_threshold | 700 | <OMITTED> | (peaklets, lone_hits) | No hits for this many ns triggers a new peak |
| peaklet_max_duration | 10000000 | <OMITTED> | (peaklets, lone_hits) | Maximum duration [ns] of a peaklet |
| penalty_s2_by | ((misid_as_s1, -1.0), (split_and_misid, -1.0)) | <OMITTED> | (match_acceptance,) | Add a penalty to the acceptance fraction if the peak has the outcome. Should be tuple of tuples where each tuple should have the format of (outcome, penalty_factor) |
| per_pmt_truth | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Store the info per channel in the truth file |
| pmt_pulse_filter | None | <OMITTED> | (records, veto_regions, pulse_counts) | Linear filter to apply to pulses, will be normalized. |
| right_raw_extension | 100000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| s1_flatten_threshold_aft | (0.6, 100) | <OMITTED> | (peaklet_classification,) | Threshold for AFT, above which we use a flatted boundary for rise timeSpecified values: (AFT boundary, constant rise time). |
| s1_max_rise_time_post100 | 200 | <OMITTED> | (peaklet_classification,) | Maximum S1 rise time for > 100 PE [ns] |
| s1_min_coincidence | 2 | <OMITTED> | (peaklet_classification,) | Minimum tight coincidence necessary to make an S1 |
| s1_risetime_aft_parameters | (-1, 2.6) | <OMITTED> | (peaklet_classification,) | Slope and offset in exponential of emperical boundary in the rise time-AFT plot. Specified as (slope, offset) |
| s1_risetime_area_parameters | (50, 80, 12) | <OMITTED> | (peaklet_classification,) | norm, const, tau in the empirical boundary in the risetime-area plot |
| s2_merge_gap_thresholds | ((1.7, 26500.0), (4.0, 2600.0), (5.0, 0.0)) | <OMITTED> | (merged_s2s,) | Points to define maximum separation between peaklets to allow merging [ns] depending on log10 area of the merged peak\nwhere the gap size of the first point is the maximum gap to allow mergingand the area of the last point is the maximum area to allow merging. The format is ((log10(area), max_gap), (..., ...), (..., ...)) |
| s2_merge_max_duration | 50000 | <OMITTED> | (merged_s2s,) | Do not merge peaklets at all if the result would be a peak longer than this [ns] |
| s2_min_pmts | 4 | <OMITTED> | (peaklet_classification,) | Minimum number of PMTs contributing to an S2 |
| saturation_correction_on | True | <OMITTED> | (peaklets, lone_hits) | On off switch for saturation correction |
| saturation_min_reference_length | 20 | <OMITTED> | (peaklets, lone_hits) | Minimum number of reference sample used to correct saturated samples |
| saturation_reference_length | 100 | <OMITTED> | (peaklets, lone_hits) | Maximum number of reference sample used to correct saturated samples |
| save_outside_hits | (3, 20) | <OMITTED> | (records, veto_regions, pulse_counts) | Save (left, right) samples besides hits; cut the rest |
| seed | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Option for setting the seed of the random number generator used forgeneration of the instructions |
| sum_waveform_top_array | True | <OMITTED> | (merged_s2s,) | Digitize the sum waveform of the top array separately |
| sum_waveform_top_array | True | <OMITTED> | (peaklets, lone_hits) | Digitize the sum waveform of the top array separately |
| tail_veto_duration | 3000000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time in ns to veto after large peaks |
| tail_veto_pass_extend | 3 | <OMITTED> | (records, veto_regions, pulse_counts) | Extend pass veto by this many samples (tail_veto_resolution!) |
| tail_veto_pass_fraction | 0.05 | <OMITTED> | (records, veto_regions, pulse_counts) | Pass veto if maximum amplitude above max * fraction |
| tail_veto_resolution | 1000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time resolution in ns for pass-veto waveform summation |
| tail_veto_threshold | 0 | <OMITTED> | (records, veto_regions, pulse_counts) | Minimum peakarea in PE to trigger tail veto.Set to None, 0 or False to disable veto. |
| tight_coincidence_window_left | 50 | <OMITTED> | (peaklets, lone_hits) | Time range left of peak center to call a hit a tight coincidence (ns) |
| tight_coincidence_window_right | 50 | <OMITTED> | (peaklets, lone_hits) | Time range right of peak center to call a hit a tight coincidence (ns) |
| truth_lookup_window | 1000000000 | <OMITTED> | (truth_matched,) | Look back and forth this many ns in the truth info |
match_acceptance
Description
Provided by plugin: AcceptanceComputer
Data kind: truth
Compute the acceptance of the matched peaks. This is done on the basis of arbitrary settings to allow better to disentangle possible scenarios that might be undesirable (like splitting an S2 into small S1 signals that could affect event reconstruction).
Columns provided
| Field name | Data type | Comment |
|---|---|---|
| time | int64 | Start time since unix epoch [ns] |
| endtime | int64 | Exclusive end time since unix epoch [ns] |
| is_found | bool | Is the peak tagged "found" in the reconstructed data |
| acceptance_fraction | float64 | Acceptance of the peak can be negative for penalized reconstruction |
| rec_bias | float64 | Reconstruction bias 1 is perfect, 0.1 means incorrect |
| rec_area | float32 | Peak integral in PE |
| rec_range_50p_area | float32 | Width (in ns) of the central 50% area of the peak |
| rec_area_fraction_top | float32 | Fraction of area seen by the top array (NaN for peaks with non-positive area) |
| rec_rise_time | float32 | Time between 10% and 50% area quantiles [ns] |
| rec_tight_coincidence | int16 | Number of PMTs with hits within tight range of mean |
Dependencies
Configuration options
These are all options that affect this data type. This also includes options taken by dependencies of this datatype, because changing any of those options affect this data indirectly.
| option | default | current | applies_to | help |
|---|---|---|---|---|
| allow_sloppy_chunking | False | <OMITTED> | (records, veto_regions, pulse_counts) | Use a default baseline for incorrectly chunked fragments. This is a kludge for improperly converted XENON1T data. |
| baseline_samples | 40 | <OMITTED> | (records, veto_regions, pulse_counts) | Number of samples to use at the start of the pulse to determine the baseline |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (raw_records, raw_records_he, raw_records_aqmon, truth) | immutabledict mapping subdetector to (min, max) channel number. Provided by context |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (peaklets, lone_hits) | immutabledict mapping subdetector to (min, max) channel number. |
| check_peak_sum_area_rtol | None | <OMITTED> | (peak_basics,) | Check if the sum area and the sum of area per channel are the same. If None, don't do the check. To perform the check, set to the desired rtol value used e.g. '1e-4' (see np.isclose). |
| check_raw_record_overlaps | True | False | (records, veto_regions, pulse_counts) | Crash if any of the pulses in raw_records overlap with others in the same channel |
| chunk_size | 100 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Duration of each chunk in seconds |
| detector | XENONnT | XENONnT | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| diagnose_sorting | False | <OMITTED> | (peaks,) | Enable runtime checks for sorting and disjointness |
| diagnose_sorting | False | <OMITTED> | (peaklets, lone_hits) | Enable runtime checks for sorting and disjointness |
| event_rate | 1000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Average number of events per second |
| fax_config | fax_config_nt_design.json | fax_config_nt_design.json | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| fax_config_override | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary with configuration option overrides |
| fax_config_override_from_cmt | None | {'drift_time_gate': ('cmt_run_id', '0', 'electron_drift_time_gate', 'ONLINE', True), 'drift_velocity_liquid': ('cmt_run_id', '0', 'electron_drift_velocity', 'ONLINE', True), 'electron_lifetime_liquid': ('cmt_run_id', '0', 'elife', 'ONLINE', True)} | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary of fax parameter names (key) mapped to CMT config names (value)where the fax parameter values will be replaced by CMT |
| fax_file | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Directory with fax instructions |
| gain_model | <OMITTED> | cmt://to_pe_model?run_id=0&version=ONLINE | (peaklets, lone_hits) | PMT gain model. Specify as URL or explicit value |
| gain_model | <OMITTED> | cmt://to_pe_model?run_id=0&version=ONLINE | (merged_s2s,) | PMT gain model. Specify as (str(model_config), str(version), nT-->boolean |
| gain_model_mc | cmt://to_p...gin.run_id | cmt://to_pe_model?run_id=0&version=ONLINE | (raw_records, raw_records_he, raw_records_aqmon, truth) | PMT gain model. Specify as (model_type, model_config). |
| hev_gain_model | None | <OMITTED> | (records, veto_regions, pulse_counts) | PMT gain model used in the software high-energy veto. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (records, veto_regions, pulse_counts) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (peaklets, lone_hits) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| keep_peak_fields | (area, range_50p_area, area_fraction_top, rise_time, tight_coincidence) | <OMITTED> | (match_acceptance,) | Add the reconstructed value of these variables |
| max_veto_value | None | <OMITTED> | (records, veto_regions, pulse_counts) | Optionally pass a HE peak that exceeds this absolute area. (if performing a hard veto, can keep a few statistics.) |
| merge_without_s1 | True | <OMITTED> | (merged_s2s,) | If true, S1s will be igored during the merging. It's now possible for a S1 to be inside a S2 post merging |
| merge_without_s1 | True | <OMITTED> | (peaks,) | If true, S1s will be igored during the merging. It's now possible for a S1 to be inside a S2 post merging |
| merged_s2s_get_window_size_factor | 5 | <OMITTED> | (merged_s2s,) | Factor of the window size for the merged_s2s plugin |
| min_s2_bias_rec | 0.85 | <OMITTED> | (match_acceptance,) | If the S2 fraction is greater or equal than this, consider a peak successfully found even if it is split or chopped. |
| n_chunk | 10 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of chunks to simulate |
| n_top_pmts | <OMITTED> | 253 | (peaklets, lone_hits) | Number of top TPC array PMTs |
| n_top_pmts | <OMITTED> | 253 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in top array. Provided by context |
| n_top_pmts | 253 | 253 | (peak_basics,) | Number of top PMTs |
| n_top_pmts | 253 | 253 | (peaklet_classification,) | Number of top PMTs |
| n_top_pmts | <OMITTED> | 253 | (merged_s2s,) | Number of top TPC array PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in tpc. Provided by context |
| n_tpc_pmts | <OMITTED> | 494 | (peaklets, lone_hits) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (records, veto_regions, pulse_counts) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (merged_s2s,) | Number of TPC PMTs |
| peak_left_extension | 30 | <OMITTED> | (peaklets, lone_hits) | Include this many ns left of hits in peaks |
| peak_min_pmts | 2 | <OMITTED> | (peaklets, lone_hits) | Minimum number of contributing PMTs needed to define a peak |
| peak_right_extension | 200 | <OMITTED> | (peaklets, lone_hits) | Include this many ns right of hits in peaks |
| peak_split_filter_wing_width | 70 | <OMITTED> | (peaklets, lone_hits) | Wing width of moving average filter for low-split natural breaks |
| peak_split_gof_threshold | (None, ((0.5, 1.0), (6.0, 0.4)), ((2.5, 1.0), (5.625, 0.4))) | <OMITTED> | (peaklets, lone_hits) | Natural breaks goodness of fit/split threshold to split a peak. Specify as tuples of (log10(area), threshold). |
| peak_split_iterations | 20 | <OMITTED> | (peaklets, lone_hits) | Maximum number of recursive peak splits to do. |
| peak_split_min_area | 40.0 | <OMITTED> | (peaklets, lone_hits) | Minimum area to evaluate natural breaks criterion. Smaller peaks are not split. |
| peaklet_gap_threshold | 700 | <OMITTED> | (peaklets, lone_hits) | No hits for this many ns triggers a new peak |
| peaklet_max_duration | 10000000 | <OMITTED> | (peaklets, lone_hits) | Maximum duration [ns] of a peaklet |
| penalty_s2_by | ((misid_as_s1, -1.0), (split_and_misid, -1.0)) | <OMITTED> | (match_acceptance,) | Add a penalty to the acceptance fraction if the peak has the outcome. Should be tuple of tuples where each tuple should have the format of (outcome, penalty_factor) |
| per_pmt_truth | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Store the info per channel in the truth file |
| pmt_pulse_filter | None | <OMITTED> | (records, veto_regions, pulse_counts) | Linear filter to apply to pulses, will be normalized. |
| right_raw_extension | 100000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| s1_flatten_threshold_aft | (0.6, 100) | <OMITTED> | (peaklet_classification,) | Threshold for AFT, above which we use a flatted boundary for rise timeSpecified values: (AFT boundary, constant rise time). |
| s1_max_rise_time_post100 | 200 | <OMITTED> | (peaklet_classification,) | Maximum S1 rise time for > 100 PE [ns] |
| s1_min_coincidence | 2 | <OMITTED> | (peaklet_classification,) | Minimum tight coincidence necessary to make an S1 |
| s1_risetime_aft_parameters | (-1, 2.6) | <OMITTED> | (peaklet_classification,) | Slope and offset in exponential of emperical boundary in the rise time-AFT plot. Specified as (slope, offset) |
| s1_risetime_area_parameters | (50, 80, 12) | <OMITTED> | (peaklet_classification,) | norm, const, tau in the empirical boundary in the risetime-area plot |
| s2_merge_gap_thresholds | ((1.7, 26500.0), (4.0, 2600.0), (5.0, 0.0)) | <OMITTED> | (merged_s2s,) | Points to define maximum separation between peaklets to allow merging [ns] depending on log10 area of the merged peak\nwhere the gap size of the first point is the maximum gap to allow mergingand the area of the last point is the maximum area to allow merging. The format is ((log10(area), max_gap), (..., ...), (..., ...)) |
| s2_merge_max_duration | 50000 | <OMITTED> | (merged_s2s,) | Do not merge peaklets at all if the result would be a peak longer than this [ns] |
| s2_min_pmts | 4 | <OMITTED> | (peaklet_classification,) | Minimum number of PMTs contributing to an S2 |
| saturation_correction_on | True | <OMITTED> | (peaklets, lone_hits) | On off switch for saturation correction |
| saturation_min_reference_length | 20 | <OMITTED> | (peaklets, lone_hits) | Minimum number of reference sample used to correct saturated samples |
| saturation_reference_length | 100 | <OMITTED> | (peaklets, lone_hits) | Maximum number of reference sample used to correct saturated samples |
| save_outside_hits | (3, 20) | <OMITTED> | (records, veto_regions, pulse_counts) | Save (left, right) samples besides hits; cut the rest |
| seed | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Option for setting the seed of the random number generator used forgeneration of the instructions |
| sum_waveform_top_array | True | <OMITTED> | (merged_s2s,) | Digitize the sum waveform of the top array separately |
| sum_waveform_top_array | True | <OMITTED> | (peaklets, lone_hits) | Digitize the sum waveform of the top array separately |
| tail_veto_duration | 3000000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time in ns to veto after large peaks |
| tail_veto_pass_extend | 3 | <OMITTED> | (records, veto_regions, pulse_counts) | Extend pass veto by this many samples (tail_veto_resolution!) |
| tail_veto_pass_fraction | 0.05 | <OMITTED> | (records, veto_regions, pulse_counts) | Pass veto if maximum amplitude above max * fraction |
| tail_veto_resolution | 1000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time resolution in ns for pass-veto waveform summation |
| tail_veto_threshold | 0 | <OMITTED> | (records, veto_regions, pulse_counts) | Minimum peakarea in PE to trigger tail veto.Set to None, 0 or False to disable veto. |
| tight_coincidence_window_left | 50 | <OMITTED> | (peaklets, lone_hits) | Time range left of peak center to call a hit a tight coincidence (ns) |
| tight_coincidence_window_right | 50 | <OMITTED> | (peaklets, lone_hits) | Time range right of peak center to call a hit a tight coincidence (ns) |
| truth_lookup_window | 1000000000 | <OMITTED> | (truth_matched,) | Look back and forth this many ns in the truth info |
truth_events
Description
Provided by plugin: MatchEvents
Data kind: truth_events
- Match WFSim truth to the outcome peaks. To this end use the
matching algorithm of pema. Assign a peak-id to both the truth and the reconstructed peaks to be able to match the two. Also define the outcome of the matching (see pema.matching for possible outcomes).
Columns provided
| Field name | Data type | Comment |
|---|---|---|
| time | int64 | Start time since unix epoch [ns] |
| endtime | int64 | Exclusive end time since unix epoch [ns] |
| start_match | int64 | First event number in event datatype within the truth event |
| end_match | int64 | Last (inclusive!) event number in event datatype within the truth event |
| outcome | <U32 | Outcome of matching to events |
| truth_number | int64 | Truth event number |
Dependencies
Configuration options
These are all options that affect this data type. This also includes options taken by dependencies of this datatype, because changing any of those options affect this data indirectly.
| option | default | current | applies_to | help |
|---|---|---|---|---|
| allow_sloppy_chunking | False | <OMITTED> | (records, veto_regions, pulse_counts) | Use a default baseline for incorrectly chunked fragments. This is a kludge for improperly converted XENON1T data. |
| baseline_samples | 40 | <OMITTED> | (records, veto_regions, pulse_counts) | Number of samples to use at the start of the pulse to determine the baseline |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (raw_records, raw_records_he, raw_records_aqmon, truth) | immutabledict mapping subdetector to (min, max) channel number. Provided by context |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (peaklets, lone_hits) | immutabledict mapping subdetector to (min, max) channel number. |
| check_event_endtime | True | <OMITTED> | (truth_events,) | Check that all events have a non-zero duration. |
| check_peak_sum_area_rtol | None | <OMITTED> | (peak_basics,) | Check if the sum area and the sum of area per channel are the same. If None, don't do the check. To perform the check, set to the desired rtol value used e.g. '1e-4' (see np.isclose). |
| check_raw_record_overlaps | True | False | (records, veto_regions, pulse_counts) | Crash if any of the pulses in raw_records overlap with others in the same channel |
| chunk_size | 100 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Duration of each chunk in seconds |
| detector | XENONnT | XENONnT | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| diagnose_overlapping | True | <OMITTED> | (events,) | Enable runtime checks for disjointness |
| diagnose_sorting | False | <OMITTED> | (peaklets, lone_hits) | Enable runtime checks for sorting and disjointness |
| diagnose_sorting | False | <OMITTED> | (peaks,) | Enable runtime checks for sorting and disjointness |
| electron_drift_velocity | cmt://elec...gin.run_id | cmt://electron_drift_velocity?run_id=0&version=ONLINE | (events,) | Vertical electron drift velocity in cm/ns (1e4 m/ms) |
| event_rate | 1000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Average number of events per second |
| event_s1_min_coincidence | 2 | <OMITTED> | (events,) | Event level S1 min coincidence. Should be >= s1_min_coincidence in the peaklet classification |
| exclude_s1_as_triggering_peaks | True | <OMITTED> | (events,) | If true exclude S1s as triggering peaks. |
| fax_config | fax_config_nt_design.json | fax_config_nt_design.json | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| fax_config_override | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary with configuration option overrides |
| fax_config_override_from_cmt | None | {'drift_time_gate': ('cmt_run_id', '0', 'electron_drift_time_gate', 'ONLINE', True), 'drift_velocity_liquid': ('cmt_run_id', '0', 'electron_drift_velocity', 'ONLINE', True), 'electron_lifetime_liquid': ('cmt_run_id', '0', 'elife', 'ONLINE', True)} | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary of fax parameter names (key) mapped to CMT config names (value)where the fax parameter values will be replaced by CMT |
| fax_file | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Directory with fax instructions |
| gain_model | <OMITTED> | cmt://to_pe_model?run_id=0&version=ONLINE | (peaklets, lone_hits) | PMT gain model. Specify as URL or explicit value |
| gain_model | <OMITTED> | cmt://to_pe_model?run_id=0&version=ONLINE | (merged_s2s,) | PMT gain model. Specify as (str(model_config), str(version), nT-->boolean |
| gain_model_mc | cmt://to_p...gin.run_id | cmt://to_pe_model?run_id=0&version=ONLINE | (raw_records, raw_records_he, raw_records_aqmon, truth) | PMT gain model. Specify as (model_type, model_config). |
| hev_gain_model | None | <OMITTED> | (records, veto_regions, pulse_counts) | PMT gain model used in the software high-energy veto. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (records, veto_regions, pulse_counts) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (peaklets, lone_hits) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| left_event_extension | 250000 | <OMITTED> | (events,) | Extend events this many ns to the left from each triggering peak. This extension is added to the maximum drift time. |
| max_drift_length | 148.6515 | <OMITTED> | (events,) | Total length of the TPC from the bottom of gate to the top of cathode wires [cm] |
| max_veto_value | None | <OMITTED> | (records, veto_regions, pulse_counts) | Optionally pass a HE peak that exceeds this absolute area. (if performing a hard veto, can keep a few statistics.) |
| merge_without_s1 | True | <OMITTED> | (merged_s2s,) | If true, S1s will be igored during the merging. It's now possible for a S1 to be inside a S2 post merging |
| merge_without_s1 | True | <OMITTED> | (peaks,) | If true, S1s will be igored during the merging. It's now possible for a S1 to be inside a S2 post merging |
| merged_s2s_get_window_size_factor | 5 | <OMITTED> | (merged_s2s,) | Factor of the window size for the merged_s2s plugin |
| min_area_fraction | 0.5 | <OMITTED> | (peak_proximity,) | The area of competing peaks must be at least this fraction of that of the considered peak |
| n_chunk | 10 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of chunks to simulate |
| n_top_pmts | <OMITTED> | 253 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in top array. Provided by context |
| n_top_pmts | <OMITTED> | 253 | (merged_s2s,) | Number of top TPC array PMTs |
| n_top_pmts | <OMITTED> | 253 | (peaklets, lone_hits) | Number of top TPC array PMTs |
| n_top_pmts | 253 | 253 | (peaklet_classification,) | Number of top PMTs |
| n_top_pmts | 253 | 253 | (peak_basics,) | Number of top PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (records, veto_regions, pulse_counts) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (merged_s2s,) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in tpc. Provided by context |
| n_tpc_pmts | <OMITTED> | 494 | (peaklets, lone_hits) | Number of TPC PMTs |
| nearby_window | 10000000 | <OMITTED> | (peak_proximity,) | Peaks starting within this time window (on either side) in ns count as nearby. |
| peak_left_extension | 30 | <OMITTED> | (peaklets, lone_hits) | Include this many ns left of hits in peaks |
| peak_max_proximity_time | 100000000 | <OMITTED> | (peak_proximity,) | Maximum value for proximity values such as t_to_next_peak [ns] |
| peak_min_pmts | 2 | <OMITTED> | (peaklets, lone_hits) | Minimum number of contributing PMTs needed to define a peak |
| peak_right_extension | 200 | <OMITTED> | (peaklets, lone_hits) | Include this many ns right of hits in peaks |
| peak_split_filter_wing_width | 70 | <OMITTED> | (peaklets, lone_hits) | Wing width of moving average filter for low-split natural breaks |
| peak_split_gof_threshold | (None, ((0.5, 1.0), (6.0, 0.4)), ((2.5, 1.0), (5.625, 0.4))) | <OMITTED> | (peaklets, lone_hits) | Natural breaks goodness of fit/split threshold to split a peak. Specify as tuples of (log10(area), threshold). |
| peak_split_iterations | 20 | <OMITTED> | (peaklets, lone_hits) | Maximum number of recursive peak splits to do. |
| peak_split_min_area | 40.0 | <OMITTED> | (peaklets, lone_hits) | Minimum area to evaluate natural breaks criterion. Smaller peaks are not split. |
| peaklet_gap_threshold | 700 | <OMITTED> | (peaklets, lone_hits) | No hits for this many ns triggers a new peak |
| peaklet_max_duration | 10000000 | <OMITTED> | (peaklets, lone_hits) | Maximum duration [ns] of a peaklet |
| per_pmt_truth | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Store the info per channel in the truth file |
| pmt_pulse_filter | None | <OMITTED> | (records, veto_regions, pulse_counts) | Linear filter to apply to pulses, will be normalized. |
| right_event_extension | 250000 | <OMITTED> | (events,) | Extend events this many ns to the right from each triggering peak. |
| right_raw_extension | 100000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| s1_flatten_threshold_aft | (0.6, 100) | <OMITTED> | (peaklet_classification,) | Threshold for AFT, above which we use a flatted boundary for rise timeSpecified values: (AFT boundary, constant rise time). |
| s1_max_rise_time_post100 | 200 | <OMITTED> | (peaklet_classification,) | Maximum S1 rise time for > 100 PE [ns] |
| s1_min_coincidence | 2 | <OMITTED> | (peaklet_classification,) | Minimum tight coincidence necessary to make an S1 |
| s1_min_coincidence | 2 | <OMITTED> | (events,) | Minimum tight coincidence necessary to make an S1 |
| s1_risetime_aft_parameters | (-1, 2.6) | <OMITTED> | (peaklet_classification,) | Slope and offset in exponential of emperical boundary in the rise time-AFT plot. Specified as (slope, offset) |
| s1_risetime_area_parameters | (50, 80, 12) | <OMITTED> | (peaklet_classification,) | norm, const, tau in the empirical boundary in the risetime-area plot |
| s2_merge_gap_thresholds | ((1.7, 26500.0), (4.0, 2600.0), (5.0, 0.0)) | <OMITTED> | (merged_s2s,) | Points to define maximum separation between peaklets to allow merging [ns] depending on log10 area of the merged peak\nwhere the gap size of the first point is the maximum gap to allow mergingand the area of the last point is the maximum area to allow merging. The format is ((log10(area), max_gap), (..., ...), (..., ...)) |
| s2_merge_max_duration | 50000 | <OMITTED> | (merged_s2s,) | Do not merge peaklets at all if the result would be a peak longer than this [ns] |
| s2_min_pmts | 4 | <OMITTED> | (peaklet_classification,) | Minimum number of PMTs contributing to an S2 |
| saturation_correction_on | True | <OMITTED> | (peaklets, lone_hits) | On off switch for saturation correction |
| saturation_min_reference_length | 20 | <OMITTED> | (peaklets, lone_hits) | Minimum number of reference sample used to correct saturated samples |
| saturation_reference_length | 100 | <OMITTED> | (peaklets, lone_hits) | Maximum number of reference sample used to correct saturated samples |
| save_outside_hits | (3, 20) | <OMITTED> | (records, veto_regions, pulse_counts) | Save (left, right) samples besides hits; cut the rest |
| seed | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Option for setting the seed of the random number generator used forgeneration of the instructions |
| sim_id_field | event_number | <OMITTED> | (truth_events,) | Group the truth info by this field. Options: ["event_number", "g4id"] |
| sum_waveform_top_array | True | <OMITTED> | (merged_s2s,) | Digitize the sum waveform of the top array separately |
| sum_waveform_top_array | True | <OMITTED> | (peaklets, lone_hits) | Digitize the sum waveform of the top array separately |
| tail_veto_duration | 3000000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time in ns to veto after large peaks |
| tail_veto_pass_extend | 3 | <OMITTED> | (records, veto_regions, pulse_counts) | Extend pass veto by this many samples (tail_veto_resolution!) |
| tail_veto_pass_fraction | 0.05 | <OMITTED> | (records, veto_regions, pulse_counts) | Pass veto if maximum amplitude above max * fraction |
| tail_veto_resolution | 1000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time resolution in ns for pass-veto waveform summation |
| tail_veto_threshold | 0 | <OMITTED> | (records, veto_regions, pulse_counts) | Minimum peakarea in PE to trigger tail veto.Set to None, 0 or False to disable veto. |
| tight_coincidence_window_left | 50 | <OMITTED> | (peaklets, lone_hits) | Time range left of peak center to call a hit a tight coincidence (ns) |
| tight_coincidence_window_right | 50 | <OMITTED> | (peaklets, lone_hits) | Time range right of peak center to call a hit a tight coincidence (ns) |
| trigger_max_competing | 7 | <OMITTED> | (events,) | Peaks must have FEWER nearby larger or slightly smaller peaks to cause events |
| trigger_min_area | 100 | <OMITTED> | (events,) | Peaks must have more area (PE) than this to cause events |
| truth_lookup_window | 1000000000 | <OMITTED> | (truth_events,) | Look back and forth this many ns in the truth info |
truth_matched
Description
Provided by plugin: MatchPeaks
Data kind: truth
- Match WFSim truth to the outcome peaks. To this end use the
matching algorithm of pema. Assign a peak-id to both the truth and the reconstructed peaks to be able to match the two. Also define the outcome of the matching (see pema.matching for possible outcomes).
Columns provided
| Field name | Data type | Comment |
|---|---|---|
| time | int64 | Start time since unix epoch [ns] |
| endtime | int64 | Exclusive end time since unix epoch [ns] |
| id | int64 | Id of element in truth |
| outcome | <U32 | Outcome of matching to peaks |
| matched_to | int64 | Id of matching element in peaks |
Dependencies
Configuration options
These are all options that affect this data type. This also includes options taken by dependencies of this datatype, because changing any of those options affect this data indirectly.
| option | default | current | applies_to | help |
|---|---|---|---|---|
| allow_sloppy_chunking | False | <OMITTED> | (records, veto_regions, pulse_counts) | Use a default baseline for incorrectly chunked fragments. This is a kludge for improperly converted XENON1T data. |
| baseline_samples | 40 | <OMITTED> | (records, veto_regions, pulse_counts) | Number of samples to use at the start of the pulse to determine the baseline |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (raw_records, raw_records_he, raw_records_aqmon, truth) | immutabledict mapping subdetector to (min, max) channel number. Provided by context |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (peaklets, lone_hits) | immutabledict mapping subdetector to (min, max) channel number. |
| check_peak_sum_area_rtol | None | <OMITTED> | (peak_basics,) | Check if the sum area and the sum of area per channel are the same. If None, don't do the check. To perform the check, set to the desired rtol value used e.g. '1e-4' (see np.isclose). |
| check_raw_record_overlaps | True | False | (records, veto_regions, pulse_counts) | Crash if any of the pulses in raw_records overlap with others in the same channel |
| chunk_size | 100 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Duration of each chunk in seconds |
| detector | XENONnT | XENONnT | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| diagnose_sorting | False | <OMITTED> | (peaklets, lone_hits) | Enable runtime checks for sorting and disjointness |
| diagnose_sorting | False | <OMITTED> | (peaks,) | Enable runtime checks for sorting and disjointness |
| event_rate | 1000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Average number of events per second |
| fax_config | fax_config_nt_design.json | fax_config_nt_design.json | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| fax_config_override | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary with configuration option overrides |
| fax_config_override_from_cmt | None | {'drift_time_gate': ('cmt_run_id', '0', 'electron_drift_time_gate', 'ONLINE', True), 'drift_velocity_liquid': ('cmt_run_id', '0', 'electron_drift_velocity', 'ONLINE', True), 'electron_lifetime_liquid': ('cmt_run_id', '0', 'elife', 'ONLINE', True)} | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary of fax parameter names (key) mapped to CMT config names (value)where the fax parameter values will be replaced by CMT |
| fax_file | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Directory with fax instructions |
| gain_model | <OMITTED> | cmt://to_pe_model?run_id=0&version=ONLINE | (peaklets, lone_hits) | PMT gain model. Specify as URL or explicit value |
| gain_model | <OMITTED> | cmt://to_pe_model?run_id=0&version=ONLINE | (merged_s2s,) | PMT gain model. Specify as (str(model_config), str(version), nT-->boolean |
| gain_model_mc | cmt://to_p...gin.run_id | cmt://to_pe_model?run_id=0&version=ONLINE | (raw_records, raw_records_he, raw_records_aqmon, truth) | PMT gain model. Specify as (model_type, model_config). |
| hev_gain_model | None | <OMITTED> | (records, veto_regions, pulse_counts) | PMT gain model used in the software high-energy veto. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (peaklets, lone_hits) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (records, veto_regions, pulse_counts) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| max_veto_value | None | <OMITTED> | (records, veto_regions, pulse_counts) | Optionally pass a HE peak that exceeds this absolute area. (if performing a hard veto, can keep a few statistics.) |
| merge_without_s1 | True | <OMITTED> | (merged_s2s,) | If true, S1s will be igored during the merging. It's now possible for a S1 to be inside a S2 post merging |
| merge_without_s1 | True | <OMITTED> | (peaks,) | If true, S1s will be igored during the merging. It's now possible for a S1 to be inside a S2 post merging |
| merged_s2s_get_window_size_factor | 5 | <OMITTED> | (merged_s2s,) | Factor of the window size for the merged_s2s plugin |
| n_chunk | 10 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of chunks to simulate |
| n_top_pmts | <OMITTED> | 253 | (peaklets, lone_hits) | Number of top TPC array PMTs |
| n_top_pmts | 253 | 253 | (peak_basics,) | Number of top PMTs |
| n_top_pmts | <OMITTED> | 253 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in top array. Provided by context |
| n_top_pmts | 253 | 253 | (peaklet_classification,) | Number of top PMTs |
| n_top_pmts | <OMITTED> | 253 | (merged_s2s,) | Number of top TPC array PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in tpc. Provided by context |
| n_tpc_pmts | <OMITTED> | 494 | (peaklets, lone_hits) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (records, veto_regions, pulse_counts) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (merged_s2s,) | Number of TPC PMTs |
| peak_left_extension | 30 | <OMITTED> | (peaklets, lone_hits) | Include this many ns left of hits in peaks |
| peak_min_pmts | 2 | <OMITTED> | (peaklets, lone_hits) | Minimum number of contributing PMTs needed to define a peak |
| peak_right_extension | 200 | <OMITTED> | (peaklets, lone_hits) | Include this many ns right of hits in peaks |
| peak_split_filter_wing_width | 70 | <OMITTED> | (peaklets, lone_hits) | Wing width of moving average filter for low-split natural breaks |
| peak_split_gof_threshold | (None, ((0.5, 1.0), (6.0, 0.4)), ((2.5, 1.0), (5.625, 0.4))) | <OMITTED> | (peaklets, lone_hits) | Natural breaks goodness of fit/split threshold to split a peak. Specify as tuples of (log10(area), threshold). |
| peak_split_iterations | 20 | <OMITTED> | (peaklets, lone_hits) | Maximum number of recursive peak splits to do. |
| peak_split_min_area | 40.0 | <OMITTED> | (peaklets, lone_hits) | Minimum area to evaluate natural breaks criterion. Smaller peaks are not split. |
| peaklet_gap_threshold | 700 | <OMITTED> | (peaklets, lone_hits) | No hits for this many ns triggers a new peak |
| peaklet_max_duration | 10000000 | <OMITTED> | (peaklets, lone_hits) | Maximum duration [ns] of a peaklet |
| per_pmt_truth | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Store the info per channel in the truth file |
| pmt_pulse_filter | None | <OMITTED> | (records, veto_regions, pulse_counts) | Linear filter to apply to pulses, will be normalized. |
| right_raw_extension | 100000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| s1_flatten_threshold_aft | (0.6, 100) | <OMITTED> | (peaklet_classification,) | Threshold for AFT, above which we use a flatted boundary for rise timeSpecified values: (AFT boundary, constant rise time). |
| s1_max_rise_time_post100 | 200 | <OMITTED> | (peaklet_classification,) | Maximum S1 rise time for > 100 PE [ns] |
| s1_min_coincidence | 2 | <OMITTED> | (peaklet_classification,) | Minimum tight coincidence necessary to make an S1 |
| s1_risetime_aft_parameters | (-1, 2.6) | <OMITTED> | (peaklet_classification,) | Slope and offset in exponential of emperical boundary in the rise time-AFT plot. Specified as (slope, offset) |
| s1_risetime_area_parameters | (50, 80, 12) | <OMITTED> | (peaklet_classification,) | norm, const, tau in the empirical boundary in the risetime-area plot |
| s2_merge_gap_thresholds | ((1.7, 26500.0), (4.0, 2600.0), (5.0, 0.0)) | <OMITTED> | (merged_s2s,) | Points to define maximum separation between peaklets to allow merging [ns] depending on log10 area of the merged peak\nwhere the gap size of the first point is the maximum gap to allow mergingand the area of the last point is the maximum area to allow merging. The format is ((log10(area), max_gap), (..., ...), (..., ...)) |
| s2_merge_max_duration | 50000 | <OMITTED> | (merged_s2s,) | Do not merge peaklets at all if the result would be a peak longer than this [ns] |
| s2_min_pmts | 4 | <OMITTED> | (peaklet_classification,) | Minimum number of PMTs contributing to an S2 |
| saturation_correction_on | True | <OMITTED> | (peaklets, lone_hits) | On off switch for saturation correction |
| saturation_min_reference_length | 20 | <OMITTED> | (peaklets, lone_hits) | Minimum number of reference sample used to correct saturated samples |
| saturation_reference_length | 100 | <OMITTED> | (peaklets, lone_hits) | Maximum number of reference sample used to correct saturated samples |
| save_outside_hits | (3, 20) | <OMITTED> | (records, veto_regions, pulse_counts) | Save (left, right) samples besides hits; cut the rest |
| seed | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Option for setting the seed of the random number generator used forgeneration of the instructions |
| sum_waveform_top_array | True | <OMITTED> | (peaklets, lone_hits) | Digitize the sum waveform of the top array separately |
| sum_waveform_top_array | True | <OMITTED> | (merged_s2s,) | Digitize the sum waveform of the top array separately |
| tail_veto_duration | 3000000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time in ns to veto after large peaks |
| tail_veto_pass_extend | 3 | <OMITTED> | (records, veto_regions, pulse_counts) | Extend pass veto by this many samples (tail_veto_resolution!) |
| tail_veto_pass_fraction | 0.05 | <OMITTED> | (records, veto_regions, pulse_counts) | Pass veto if maximum amplitude above max * fraction |
| tail_veto_resolution | 1000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time resolution in ns for pass-veto waveform summation |
| tail_veto_threshold | 0 | <OMITTED> | (records, veto_regions, pulse_counts) | Minimum peakarea in PE to trigger tail veto.Set to None, 0 or False to disable veto. |
| tight_coincidence_window_left | 50 | <OMITTED> | (peaklets, lone_hits) | Time range left of peak center to call a hit a tight coincidence (ns) |
| tight_coincidence_window_right | 50 | <OMITTED> | (peaklets, lone_hits) | Time range right of peak center to call a hit a tight coincidence (ns) |
| truth_lookup_window | 1000000000 | <OMITTED> | (truth_matched,) | Look back and forth this many ns in the truth info |
events
Description
Provided by plugin: Events
Data kind: events
Plugin which defines an “event” in our TPC.
An event is defined by peak(s) in fixed range of time around a peak which satisfies certain conditions:
The triggering peak must have a certain area.
The triggering peak must have less than “trigger_max_competing” peaks. (A competing peak must have a certain area fraction of the triggering peak and must be in a window close to the main peak)
- Note:
The time range which defines an event gets chopped at the chunk boundaries. This happens at invalid boundaries of the
Columns provided
| Field name | Data type | Comment |
|---|---|---|
| event_number | int64 | Event number in this dataset |
| time | int64 | Event start time in ns since the unix epoch |
| endtime | int64 | Event end time in ns since the unix epoch |
Dependencies
Configuration options
These are all options that affect this data type. This also includes options taken by dependencies of this datatype, because changing any of those options affect this data indirectly.
| option | default | current | applies_to | help |
|---|---|---|---|---|
| allow_sloppy_chunking | False | <OMITTED> | (records, veto_regions, pulse_counts) | Use a default baseline for incorrectly chunked fragments. This is a kludge for improperly converted XENON1T data. |
| baseline_samples | 40 | <OMITTED> | (records, veto_regions, pulse_counts) | Number of samples to use at the start of the pulse to determine the baseline |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (peaklets, lone_hits) | immutabledict mapping subdetector to (min, max) channel number. |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (raw_records, raw_records_he, raw_records_aqmon, truth) | immutabledict mapping subdetector to (min, max) channel number. Provided by context |
| check_peak_sum_area_rtol | None | <OMITTED> | (peak_basics,) | Check if the sum area and the sum of area per channel are the same. If None, don't do the check. To perform the check, set to the desired rtol value used e.g. '1e-4' (see np.isclose). |
| check_raw_record_overlaps | True | False | (records, veto_regions, pulse_counts) | Crash if any of the pulses in raw_records overlap with others in the same channel |
| chunk_size | 100 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Duration of each chunk in seconds |
| detector | XENONnT | XENONnT | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| diagnose_overlapping | True | <OMITTED> | (events,) | Enable runtime checks for disjointness |
| diagnose_sorting | False | <OMITTED> | (peaklets, lone_hits) | Enable runtime checks for sorting and disjointness |
| diagnose_sorting | False | <OMITTED> | (peaks,) | Enable runtime checks for sorting and disjointness |
| electron_drift_velocity | cmt://elec...gin.run_id | cmt://electron_drift_velocity?run_id=0&version=ONLINE | (events,) | Vertical electron drift velocity in cm/ns (1e4 m/ms) |
| event_rate | 1000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Average number of events per second |
| event_s1_min_coincidence | 2 | <OMITTED> | (events,) | Event level S1 min coincidence. Should be >= s1_min_coincidence in the peaklet classification |
| exclude_s1_as_triggering_peaks | True | <OMITTED> | (events,) | If true exclude S1s as triggering peaks. |
| fax_config | fax_config_nt_design.json | fax_config_nt_design.json | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| fax_config_override | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary with configuration option overrides |
| fax_config_override_from_cmt | None | {'drift_time_gate': ('cmt_run_id', '0', 'electron_drift_time_gate', 'ONLINE', True), 'drift_velocity_liquid': ('cmt_run_id', '0', 'electron_drift_velocity', 'ONLINE', True), 'electron_lifetime_liquid': ('cmt_run_id', '0', 'elife', 'ONLINE', True)} | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary of fax parameter names (key) mapped to CMT config names (value)where the fax parameter values will be replaced by CMT |
| fax_file | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Directory with fax instructions |
| gain_model | <OMITTED> | cmt://to_pe_model?run_id=0&version=ONLINE | (merged_s2s,) | PMT gain model. Specify as (str(model_config), str(version), nT-->boolean |
| gain_model | <OMITTED> | cmt://to_pe_model?run_id=0&version=ONLINE | (peaklets, lone_hits) | PMT gain model. Specify as URL or explicit value |
| gain_model_mc | cmt://to_p...gin.run_id | cmt://to_pe_model?run_id=0&version=ONLINE | (raw_records, raw_records_he, raw_records_aqmon, truth) | PMT gain model. Specify as (model_type, model_config). |
| hev_gain_model | None | <OMITTED> | (records, veto_regions, pulse_counts) | PMT gain model used in the software high-energy veto. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (records, veto_regions, pulse_counts) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (peaklets, lone_hits) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| left_event_extension | 250000 | <OMITTED> | (events,) | Extend events this many ns to the left from each triggering peak. This extension is added to the maximum drift time. |
| max_drift_length | 148.6515 | <OMITTED> | (events,) | Total length of the TPC from the bottom of gate to the top of cathode wires [cm] |
| max_veto_value | None | <OMITTED> | (records, veto_regions, pulse_counts) | Optionally pass a HE peak that exceeds this absolute area. (if performing a hard veto, can keep a few statistics.) |
| merge_without_s1 | True | <OMITTED> | (peaks,) | If true, S1s will be igored during the merging. It's now possible for a S1 to be inside a S2 post merging |
| merge_without_s1 | True | <OMITTED> | (merged_s2s,) | If true, S1s will be igored during the merging. It's now possible for a S1 to be inside a S2 post merging |
| merged_s2s_get_window_size_factor | 5 | <OMITTED> | (merged_s2s,) | Factor of the window size for the merged_s2s plugin |
| min_area_fraction | 0.5 | <OMITTED> | (peak_proximity,) | The area of competing peaks must be at least this fraction of that of the considered peak |
| n_chunk | 10 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of chunks to simulate |
| n_top_pmts | 253 | 253 | (peaklet_classification,) | Number of top PMTs |
| n_top_pmts | <OMITTED> | 253 | (merged_s2s,) | Number of top TPC array PMTs |
| n_top_pmts | <OMITTED> | 253 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in top array. Provided by context |
| n_top_pmts | <OMITTED> | 253 | (peaklets, lone_hits) | Number of top TPC array PMTs |
| n_top_pmts | 253 | 253 | (peak_basics,) | Number of top PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in tpc. Provided by context |
| n_tpc_pmts | <OMITTED> | 494 | (records, veto_regions, pulse_counts) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (peaklets, lone_hits) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (merged_s2s,) | Number of TPC PMTs |
| nearby_window | 10000000 | <OMITTED> | (peak_proximity,) | Peaks starting within this time window (on either side) in ns count as nearby. |
| peak_left_extension | 30 | <OMITTED> | (peaklets, lone_hits) | Include this many ns left of hits in peaks |
| peak_max_proximity_time | 100000000 | <OMITTED> | (peak_proximity,) | Maximum value for proximity values such as t_to_next_peak [ns] |
| peak_min_pmts | 2 | <OMITTED> | (peaklets, lone_hits) | Minimum number of contributing PMTs needed to define a peak |
| peak_right_extension | 200 | <OMITTED> | (peaklets, lone_hits) | Include this many ns right of hits in peaks |
| peak_split_filter_wing_width | 70 | <OMITTED> | (peaklets, lone_hits) | Wing width of moving average filter for low-split natural breaks |
| peak_split_gof_threshold | (None, ((0.5, 1.0), (6.0, 0.4)), ((2.5, 1.0), (5.625, 0.4))) | <OMITTED> | (peaklets, lone_hits) | Natural breaks goodness of fit/split threshold to split a peak. Specify as tuples of (log10(area), threshold). |
| peak_split_iterations | 20 | <OMITTED> | (peaklets, lone_hits) | Maximum number of recursive peak splits to do. |
| peak_split_min_area | 40.0 | <OMITTED> | (peaklets, lone_hits) | Minimum area to evaluate natural breaks criterion. Smaller peaks are not split. |
| peaklet_gap_threshold | 700 | <OMITTED> | (peaklets, lone_hits) | No hits for this many ns triggers a new peak |
| peaklet_max_duration | 10000000 | <OMITTED> | (peaklets, lone_hits) | Maximum duration [ns] of a peaklet |
| per_pmt_truth | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Store the info per channel in the truth file |
| pmt_pulse_filter | None | <OMITTED> | (records, veto_regions, pulse_counts) | Linear filter to apply to pulses, will be normalized. |
| right_event_extension | 250000 | <OMITTED> | (events,) | Extend events this many ns to the right from each triggering peak. |
| right_raw_extension | 100000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| s1_flatten_threshold_aft | (0.6, 100) | <OMITTED> | (peaklet_classification,) | Threshold for AFT, above which we use a flatted boundary for rise timeSpecified values: (AFT boundary, constant rise time). |
| s1_max_rise_time_post100 | 200 | <OMITTED> | (peaklet_classification,) | Maximum S1 rise time for > 100 PE [ns] |
| s1_min_coincidence | 2 | <OMITTED> | (events,) | Minimum tight coincidence necessary to make an S1 |
| s1_min_coincidence | 2 | <OMITTED> | (peaklet_classification,) | Minimum tight coincidence necessary to make an S1 |
| s1_risetime_aft_parameters | (-1, 2.6) | <OMITTED> | (peaklet_classification,) | Slope and offset in exponential of emperical boundary in the rise time-AFT plot. Specified as (slope, offset) |
| s1_risetime_area_parameters | (50, 80, 12) | <OMITTED> | (peaklet_classification,) | norm, const, tau in the empirical boundary in the risetime-area plot |
| s2_merge_gap_thresholds | ((1.7, 26500.0), (4.0, 2600.0), (5.0, 0.0)) | <OMITTED> | (merged_s2s,) | Points to define maximum separation between peaklets to allow merging [ns] depending on log10 area of the merged peak\nwhere the gap size of the first point is the maximum gap to allow mergingand the area of the last point is the maximum area to allow merging. The format is ((log10(area), max_gap), (..., ...), (..., ...)) |
| s2_merge_max_duration | 50000 | <OMITTED> | (merged_s2s,) | Do not merge peaklets at all if the result would be a peak longer than this [ns] |
| s2_min_pmts | 4 | <OMITTED> | (peaklet_classification,) | Minimum number of PMTs contributing to an S2 |
| saturation_correction_on | True | <OMITTED> | (peaklets, lone_hits) | On off switch for saturation correction |
| saturation_min_reference_length | 20 | <OMITTED> | (peaklets, lone_hits) | Minimum number of reference sample used to correct saturated samples |
| saturation_reference_length | 100 | <OMITTED> | (peaklets, lone_hits) | Maximum number of reference sample used to correct saturated samples |
| save_outside_hits | (3, 20) | <OMITTED> | (records, veto_regions, pulse_counts) | Save (left, right) samples besides hits; cut the rest |
| seed | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Option for setting the seed of the random number generator used forgeneration of the instructions |
| sum_waveform_top_array | True | <OMITTED> | (peaklets, lone_hits) | Digitize the sum waveform of the top array separately |
| sum_waveform_top_array | True | <OMITTED> | (merged_s2s,) | Digitize the sum waveform of the top array separately |
| tail_veto_duration | 3000000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time in ns to veto after large peaks |
| tail_veto_pass_extend | 3 | <OMITTED> | (records, veto_regions, pulse_counts) | Extend pass veto by this many samples (tail_veto_resolution!) |
| tail_veto_pass_fraction | 0.05 | <OMITTED> | (records, veto_regions, pulse_counts) | Pass veto if maximum amplitude above max * fraction |
| tail_veto_resolution | 1000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time resolution in ns for pass-veto waveform summation |
| tail_veto_threshold | 0 | <OMITTED> | (records, veto_regions, pulse_counts) | Minimum peakarea in PE to trigger tail veto.Set to None, 0 or False to disable veto. |
| tight_coincidence_window_left | 50 | <OMITTED> | (peaklets, lone_hits) | Time range left of peak center to call a hit a tight coincidence (ns) |
| tight_coincidence_window_right | 50 | <OMITTED> | (peaklets, lone_hits) | Time range right of peak center to call a hit a tight coincidence (ns) |
| trigger_max_competing | 7 | <OMITTED> | (events,) | Peaks must have FEWER nearby larger or slightly smaller peaks to cause events |
| trigger_min_area | 100 | <OMITTED> | (events,) | Peaks must have more area (PE) than this to cause events |
peak_proximity
Description
Provided by plugin: PeakProximity
Data kind: peaks
- Look for peaks around a peak to determine how many peaks are in proximity (in time) of a
peak.
Columns provided
| Field name | Data type | Comment |
|---|---|---|
| n_competing | int32 | Number of nearby larger or slightly smaller peaks |
| n_competing_left | int32 | Number of larger or slightly smaller peaks left of the main peak |
| t_to_prev_peak | int64 | Time between end of previous peak and start of this peak [ns] |
| t_to_next_peak | int64 | Time between end of this peak and start of next peak [ns] |
| t_to_nearest_peak | int64 | Smaller of t_to_prev_peak and t_to_next_peak [ns] |
| time | int64 | Start time since unix epoch [ns] |
| endtime | int64 | Exclusive end time since unix epoch [ns] |
Dependencies
Configuration options
These are all options that affect this data type. This also includes options taken by dependencies of this datatype, because changing any of those options affect this data indirectly.
| option | default | current | applies_to | help |
|---|---|---|---|---|
| allow_sloppy_chunking | False | <OMITTED> | (records, veto_regions, pulse_counts) | Use a default baseline for incorrectly chunked fragments. This is a kludge for improperly converted XENON1T data. |
| baseline_samples | 40 | <OMITTED> | (records, veto_regions, pulse_counts) | Number of samples to use at the start of the pulse to determine the baseline |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (peaklets, lone_hits) | immutabledict mapping subdetector to (min, max) channel number. |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (raw_records, raw_records_he, raw_records_aqmon, truth) | immutabledict mapping subdetector to (min, max) channel number. Provided by context |
| check_peak_sum_area_rtol | None | <OMITTED> | (peak_basics,) | Check if the sum area and the sum of area per channel are the same. If None, don't do the check. To perform the check, set to the desired rtol value used e.g. '1e-4' (see np.isclose). |
| check_raw_record_overlaps | True | False | (records, veto_regions, pulse_counts) | Crash if any of the pulses in raw_records overlap with others in the same channel |
| chunk_size | 100 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Duration of each chunk in seconds |
| detector | XENONnT | XENONnT | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| diagnose_sorting | False | <OMITTED> | (peaklets, lone_hits) | Enable runtime checks for sorting and disjointness |
| diagnose_sorting | False | <OMITTED> | (peaks,) | Enable runtime checks for sorting and disjointness |
| event_rate | 1000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Average number of events per second |
| fax_config | fax_config_nt_design.json | fax_config_nt_design.json | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| fax_config_override | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary with configuration option overrides |
| fax_config_override_from_cmt | None | {'drift_time_gate': ('cmt_run_id', '0', 'electron_drift_time_gate', 'ONLINE', True), 'drift_velocity_liquid': ('cmt_run_id', '0', 'electron_drift_velocity', 'ONLINE', True), 'electron_lifetime_liquid': ('cmt_run_id', '0', 'elife', 'ONLINE', True)} | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary of fax parameter names (key) mapped to CMT config names (value)where the fax parameter values will be replaced by CMT |
| fax_file | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Directory with fax instructions |
| gain_model | <OMITTED> | cmt://to_pe_model?run_id=0&version=ONLINE | (peaklets, lone_hits) | PMT gain model. Specify as URL or explicit value |
| gain_model | <OMITTED> | cmt://to_pe_model?run_id=0&version=ONLINE | (merged_s2s,) | PMT gain model. Specify as (str(model_config), str(version), nT-->boolean |
| gain_model_mc | cmt://to_p...gin.run_id | cmt://to_pe_model?run_id=0&version=ONLINE | (raw_records, raw_records_he, raw_records_aqmon, truth) | PMT gain model. Specify as (model_type, model_config). |
| hev_gain_model | None | <OMITTED> | (records, veto_regions, pulse_counts) | PMT gain model used in the software high-energy veto. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (peaklets, lone_hits) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (records, veto_regions, pulse_counts) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| max_veto_value | None | <OMITTED> | (records, veto_regions, pulse_counts) | Optionally pass a HE peak that exceeds this absolute area. (if performing a hard veto, can keep a few statistics.) |
| merge_without_s1 | True | <OMITTED> | (peaks,) | If true, S1s will be igored during the merging. It's now possible for a S1 to be inside a S2 post merging |
| merge_without_s1 | True | <OMITTED> | (merged_s2s,) | If true, S1s will be igored during the merging. It's now possible for a S1 to be inside a S2 post merging |
| merged_s2s_get_window_size_factor | 5 | <OMITTED> | (merged_s2s,) | Factor of the window size for the merged_s2s plugin |
| min_area_fraction | 0.5 | <OMITTED> | (peak_proximity,) | The area of competing peaks must be at least this fraction of that of the considered peak |
| n_chunk | 10 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of chunks to simulate |
| n_top_pmts | <OMITTED> | 253 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in top array. Provided by context |
| n_top_pmts | <OMITTED> | 253 | (peaklets, lone_hits) | Number of top TPC array PMTs |
| n_top_pmts | 253 | 253 | (peak_basics,) | Number of top PMTs |
| n_top_pmts | <OMITTED> | 253 | (merged_s2s,) | Number of top TPC array PMTs |
| n_top_pmts | 253 | 253 | (peaklet_classification,) | Number of top PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in tpc. Provided by context |
| n_tpc_pmts | <OMITTED> | 494 | (peaklets, lone_hits) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (merged_s2s,) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (records, veto_regions, pulse_counts) | Number of TPC PMTs |
| nearby_window | 10000000 | <OMITTED> | (peak_proximity,) | Peaks starting within this time window (on either side) in ns count as nearby. |
| peak_left_extension | 30 | <OMITTED> | (peaklets, lone_hits) | Include this many ns left of hits in peaks |
| peak_max_proximity_time | 100000000 | <OMITTED> | (peak_proximity,) | Maximum value for proximity values such as t_to_next_peak [ns] |
| peak_min_pmts | 2 | <OMITTED> | (peaklets, lone_hits) | Minimum number of contributing PMTs needed to define a peak |
| peak_right_extension | 200 | <OMITTED> | (peaklets, lone_hits) | Include this many ns right of hits in peaks |
| peak_split_filter_wing_width | 70 | <OMITTED> | (peaklets, lone_hits) | Wing width of moving average filter for low-split natural breaks |
| peak_split_gof_threshold | (None, ((0.5, 1.0), (6.0, 0.4)), ((2.5, 1.0), (5.625, 0.4))) | <OMITTED> | (peaklets, lone_hits) | Natural breaks goodness of fit/split threshold to split a peak. Specify as tuples of (log10(area), threshold). |
| peak_split_iterations | 20 | <OMITTED> | (peaklets, lone_hits) | Maximum number of recursive peak splits to do. |
| peak_split_min_area | 40.0 | <OMITTED> | (peaklets, lone_hits) | Minimum area to evaluate natural breaks criterion. Smaller peaks are not split. |
| peaklet_gap_threshold | 700 | <OMITTED> | (peaklets, lone_hits) | No hits for this many ns triggers a new peak |
| peaklet_max_duration | 10000000 | <OMITTED> | (peaklets, lone_hits) | Maximum duration [ns] of a peaklet |
| per_pmt_truth | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Store the info per channel in the truth file |
| pmt_pulse_filter | None | <OMITTED> | (records, veto_regions, pulse_counts) | Linear filter to apply to pulses, will be normalized. |
| right_raw_extension | 100000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| s1_flatten_threshold_aft | (0.6, 100) | <OMITTED> | (peaklet_classification,) | Threshold for AFT, above which we use a flatted boundary for rise timeSpecified values: (AFT boundary, constant rise time). |
| s1_max_rise_time_post100 | 200 | <OMITTED> | (peaklet_classification,) | Maximum S1 rise time for > 100 PE [ns] |
| s1_min_coincidence | 2 | <OMITTED> | (peaklet_classification,) | Minimum tight coincidence necessary to make an S1 |
| s1_risetime_aft_parameters | (-1, 2.6) | <OMITTED> | (peaklet_classification,) | Slope and offset in exponential of emperical boundary in the rise time-AFT plot. Specified as (slope, offset) |
| s1_risetime_area_parameters | (50, 80, 12) | <OMITTED> | (peaklet_classification,) | norm, const, tau in the empirical boundary in the risetime-area plot |
| s2_merge_gap_thresholds | ((1.7, 26500.0), (4.0, 2600.0), (5.0, 0.0)) | <OMITTED> | (merged_s2s,) | Points to define maximum separation between peaklets to allow merging [ns] depending on log10 area of the merged peak\nwhere the gap size of the first point is the maximum gap to allow mergingand the area of the last point is the maximum area to allow merging. The format is ((log10(area), max_gap), (..., ...), (..., ...)) |
| s2_merge_max_duration | 50000 | <OMITTED> | (merged_s2s,) | Do not merge peaklets at all if the result would be a peak longer than this [ns] |
| s2_min_pmts | 4 | <OMITTED> | (peaklet_classification,) | Minimum number of PMTs contributing to an S2 |
| saturation_correction_on | True | <OMITTED> | (peaklets, lone_hits) | On off switch for saturation correction |
| saturation_min_reference_length | 20 | <OMITTED> | (peaklets, lone_hits) | Minimum number of reference sample used to correct saturated samples |
| saturation_reference_length | 100 | <OMITTED> | (peaklets, lone_hits) | Maximum number of reference sample used to correct saturated samples |
| save_outside_hits | (3, 20) | <OMITTED> | (records, veto_regions, pulse_counts) | Save (left, right) samples besides hits; cut the rest |
| seed | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Option for setting the seed of the random number generator used forgeneration of the instructions |
| sum_waveform_top_array | True | <OMITTED> | (peaklets, lone_hits) | Digitize the sum waveform of the top array separately |
| sum_waveform_top_array | True | <OMITTED> | (merged_s2s,) | Digitize the sum waveform of the top array separately |
| tail_veto_duration | 3000000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time in ns to veto after large peaks |
| tail_veto_pass_extend | 3 | <OMITTED> | (records, veto_regions, pulse_counts) | Extend pass veto by this many samples (tail_veto_resolution!) |
| tail_veto_pass_fraction | 0.05 | <OMITTED> | (records, veto_regions, pulse_counts) | Pass veto if maximum amplitude above max * fraction |
| tail_veto_resolution | 1000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time resolution in ns for pass-veto waveform summation |
| tail_veto_threshold | 0 | <OMITTED> | (records, veto_regions, pulse_counts) | Minimum peakarea in PE to trigger tail veto.Set to None, 0 or False to disable veto. |
| tight_coincidence_window_left | 50 | <OMITTED> | (peaklets, lone_hits) | Time range left of peak center to call a hit a tight coincidence (ns) |
| tight_coincidence_window_right | 50 | <OMITTED> | (peaklets, lone_hits) | Time range right of peak center to call a hit a tight coincidence (ns) |
peak_id
Description
Provided by plugin: PeakId
Data kind: peaks
Add id field to datakind
Columns provided
| Field name | Data type | Comment |
|---|---|---|
| time | int64 | Start time since unix epoch [ns] |
| endtime | int64 | Exclusive end time since unix epoch [ns] |
| id | int64 | Id of element in peaks |
Dependencies
Configuration options
These are all options that affect this data type. This also includes options taken by dependencies of this datatype, because changing any of those options affect this data indirectly.
| option | default | current | applies_to | help |
|---|---|---|---|---|
| allow_sloppy_chunking | False | <OMITTED> | (records, veto_regions, pulse_counts) | Use a default baseline for incorrectly chunked fragments. This is a kludge for improperly converted XENON1T data. |
| baseline_samples | 40 | <OMITTED> | (records, veto_regions, pulse_counts) | Number of samples to use at the start of the pulse to determine the baseline |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (raw_records, raw_records_he, raw_records_aqmon, truth) | immutabledict mapping subdetector to (min, max) channel number. Provided by context |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (peaklets, lone_hits) | immutabledict mapping subdetector to (min, max) channel number. |
| check_peak_sum_area_rtol | None | <OMITTED> | (peak_basics,) | Check if the sum area and the sum of area per channel are the same. If None, don't do the check. To perform the check, set to the desired rtol value used e.g. '1e-4' (see np.isclose). |
| check_raw_record_overlaps | True | False | (records, veto_regions, pulse_counts) | Crash if any of the pulses in raw_records overlap with others in the same channel |
| chunk_size | 100 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Duration of each chunk in seconds |
| detector | XENONnT | XENONnT | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| diagnose_sorting | False | <OMITTED> | (peaklets, lone_hits) | Enable runtime checks for sorting and disjointness |
| diagnose_sorting | False | <OMITTED> | (peaks,) | Enable runtime checks for sorting and disjointness |
| event_rate | 1000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Average number of events per second |
| fax_config | fax_config_nt_design.json | fax_config_nt_design.json | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| fax_config_override | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary with configuration option overrides |
| fax_config_override_from_cmt | None | {'drift_time_gate': ('cmt_run_id', '0', 'electron_drift_time_gate', 'ONLINE', True), 'drift_velocity_liquid': ('cmt_run_id', '0', 'electron_drift_velocity', 'ONLINE', True), 'electron_lifetime_liquid': ('cmt_run_id', '0', 'elife', 'ONLINE', True)} | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary of fax parameter names (key) mapped to CMT config names (value)where the fax parameter values will be replaced by CMT |
| fax_file | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Directory with fax instructions |
| gain_model | <OMITTED> | cmt://to_pe_model?run_id=0&version=ONLINE | (merged_s2s,) | PMT gain model. Specify as (str(model_config), str(version), nT-->boolean |
| gain_model | <OMITTED> | cmt://to_pe_model?run_id=0&version=ONLINE | (peaklets, lone_hits) | PMT gain model. Specify as URL or explicit value |
| gain_model_mc | cmt://to_p...gin.run_id | cmt://to_pe_model?run_id=0&version=ONLINE | (raw_records, raw_records_he, raw_records_aqmon, truth) | PMT gain model. Specify as (model_type, model_config). |
| hev_gain_model | None | <OMITTED> | (records, veto_regions, pulse_counts) | PMT gain model used in the software high-energy veto. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (peaklets, lone_hits) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (records, veto_regions, pulse_counts) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| max_veto_value | None | <OMITTED> | (records, veto_regions, pulse_counts) | Optionally pass a HE peak that exceeds this absolute area. (if performing a hard veto, can keep a few statistics.) |
| merge_without_s1 | True | <OMITTED> | (peaks,) | If true, S1s will be igored during the merging. It's now possible for a S1 to be inside a S2 post merging |
| merge_without_s1 | True | <OMITTED> | (merged_s2s,) | If true, S1s will be igored during the merging. It's now possible for a S1 to be inside a S2 post merging |
| merged_s2s_get_window_size_factor | 5 | <OMITTED> | (merged_s2s,) | Factor of the window size for the merged_s2s plugin |
| n_chunk | 10 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of chunks to simulate |
| n_top_pmts | 253 | 253 | (peaklet_classification,) | Number of top PMTs |
| n_top_pmts | <OMITTED> | 253 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in top array. Provided by context |
| n_top_pmts | <OMITTED> | 253 | (peaklets, lone_hits) | Number of top TPC array PMTs |
| n_top_pmts | <OMITTED> | 253 | (merged_s2s,) | Number of top TPC array PMTs |
| n_top_pmts | 253 | 253 | (peak_basics,) | Number of top PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (peaklets, lone_hits) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (merged_s2s,) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in tpc. Provided by context |
| n_tpc_pmts | <OMITTED> | 494 | (records, veto_regions, pulse_counts) | Number of TPC PMTs |
| peak_left_extension | 30 | <OMITTED> | (peaklets, lone_hits) | Include this many ns left of hits in peaks |
| peak_min_pmts | 2 | <OMITTED> | (peaklets, lone_hits) | Minimum number of contributing PMTs needed to define a peak |
| peak_right_extension | 200 | <OMITTED> | (peaklets, lone_hits) | Include this many ns right of hits in peaks |
| peak_split_filter_wing_width | 70 | <OMITTED> | (peaklets, lone_hits) | Wing width of moving average filter for low-split natural breaks |
| peak_split_gof_threshold | (None, ((0.5, 1.0), (6.0, 0.4)), ((2.5, 1.0), (5.625, 0.4))) | <OMITTED> | (peaklets, lone_hits) | Natural breaks goodness of fit/split threshold to split a peak. Specify as tuples of (log10(area), threshold). |
| peak_split_iterations | 20 | <OMITTED> | (peaklets, lone_hits) | Maximum number of recursive peak splits to do. |
| peak_split_min_area | 40.0 | <OMITTED> | (peaklets, lone_hits) | Minimum area to evaluate natural breaks criterion. Smaller peaks are not split. |
| peaklet_gap_threshold | 700 | <OMITTED> | (peaklets, lone_hits) | No hits for this many ns triggers a new peak |
| peaklet_max_duration | 10000000 | <OMITTED> | (peaklets, lone_hits) | Maximum duration [ns] of a peaklet |
| per_pmt_truth | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Store the info per channel in the truth file |
| pmt_pulse_filter | None | <OMITTED> | (records, veto_regions, pulse_counts) | Linear filter to apply to pulses, will be normalized. |
| right_raw_extension | 100000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| s1_flatten_threshold_aft | (0.6, 100) | <OMITTED> | (peaklet_classification,) | Threshold for AFT, above which we use a flatted boundary for rise timeSpecified values: (AFT boundary, constant rise time). |
| s1_max_rise_time_post100 | 200 | <OMITTED> | (peaklet_classification,) | Maximum S1 rise time for > 100 PE [ns] |
| s1_min_coincidence | 2 | <OMITTED> | (peaklet_classification,) | Minimum tight coincidence necessary to make an S1 |
| s1_risetime_aft_parameters | (-1, 2.6) | <OMITTED> | (peaklet_classification,) | Slope and offset in exponential of emperical boundary in the rise time-AFT plot. Specified as (slope, offset) |
| s1_risetime_area_parameters | (50, 80, 12) | <OMITTED> | (peaklet_classification,) | norm, const, tau in the empirical boundary in the risetime-area plot |
| s2_merge_gap_thresholds | ((1.7, 26500.0), (4.0, 2600.0), (5.0, 0.0)) | <OMITTED> | (merged_s2s,) | Points to define maximum separation between peaklets to allow merging [ns] depending on log10 area of the merged peak\nwhere the gap size of the first point is the maximum gap to allow mergingand the area of the last point is the maximum area to allow merging. The format is ((log10(area), max_gap), (..., ...), (..., ...)) |
| s2_merge_max_duration | 50000 | <OMITTED> | (merged_s2s,) | Do not merge peaklets at all if the result would be a peak longer than this [ns] |
| s2_min_pmts | 4 | <OMITTED> | (peaklet_classification,) | Minimum number of PMTs contributing to an S2 |
| saturation_correction_on | True | <OMITTED> | (peaklets, lone_hits) | On off switch for saturation correction |
| saturation_min_reference_length | 20 | <OMITTED> | (peaklets, lone_hits) | Minimum number of reference sample used to correct saturated samples |
| saturation_reference_length | 100 | <OMITTED> | (peaklets, lone_hits) | Maximum number of reference sample used to correct saturated samples |
| save_outside_hits | (3, 20) | <OMITTED> | (records, veto_regions, pulse_counts) | Save (left, right) samples besides hits; cut the rest |
| seed | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Option for setting the seed of the random number generator used forgeneration of the instructions |
| sum_waveform_top_array | True | <OMITTED> | (peaklets, lone_hits) | Digitize the sum waveform of the top array separately |
| sum_waveform_top_array | True | <OMITTED> | (merged_s2s,) | Digitize the sum waveform of the top array separately |
| tail_veto_duration | 3000000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time in ns to veto after large peaks |
| tail_veto_pass_extend | 3 | <OMITTED> | (records, veto_regions, pulse_counts) | Extend pass veto by this many samples (tail_veto_resolution!) |
| tail_veto_pass_fraction | 0.05 | <OMITTED> | (records, veto_regions, pulse_counts) | Pass veto if maximum amplitude above max * fraction |
| tail_veto_resolution | 1000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time resolution in ns for pass-veto waveform summation |
| tail_veto_threshold | 0 | <OMITTED> | (records, veto_regions, pulse_counts) | Minimum peakarea in PE to trigger tail veto.Set to None, 0 or False to disable veto. |
| tight_coincidence_window_left | 50 | <OMITTED> | (peaklets, lone_hits) | Time range left of peak center to call a hit a tight coincidence (ns) |
| tight_coincidence_window_right | 50 | <OMITTED> | (peaklets, lone_hits) | Time range right of peak center to call a hit a tight coincidence (ns) |
peak_basics
Description
Provided by plugin: PeakBasics
Data kind: peaks
Compute the basic peak-properties, thereby dropping structured arrays.
NB: This plugin can therefore be loaded as a pandas DataFrame.
Columns provided
| Field name | Data type | Comment |
|---|---|---|
| time | int64 | Start time of the peak (ns since unix epoch) |
| endtime | int64 | End time of the peak (ns since unix epoch) |
| center_time | int64 | Weighted center time of the peak (ns since unix epoch) |
| area | float32 | Peak integral in PE |
| n_hits | int32 | Number of hits contributing at least one sample to the peak |
| n_channels | int16 | Number of PMTs contributing to the peak |
| max_pmt | int16 | PMT number which contributes the most PE |
| max_pmt_area | float32 | Area of signal in the largest-contributing PMT (PE) |
| n_saturated_channels | int16 | Total number of saturated channels |
| range_50p_area | float32 | Width (in ns) of the central 50% area of the peak |
| range_90p_area | float32 | Width (in ns) of the central 90% area of the peak |
| area_fraction_top | float32 | Fraction of area seen by the top array (NaN for peaks with non-positive area) |
| length | int32 | Length of the peak waveform in samples |
| dt | int16 | Time resolution of the peak waveform in ns |
| rise_time | float32 | Time between 10% and 50% area quantiles [ns] |
| tight_coincidence | int16 | Number of PMTs with hits within tight range of mean |
| type | int8 | Classification of the peak(let) |
| max_diff | int32 | Largest time difference between apexes of hits inside peak [ns] |
| min_diff | int32 | Smallest time difference between apexes of hits inside peak [ns] |
Dependencies
Configuration options
These are all options that affect this data type. This also includes options taken by dependencies of this datatype, because changing any of those options affect this data indirectly.
| option | default | current | applies_to | help |
|---|---|---|---|---|
| allow_sloppy_chunking | False | <OMITTED> | (records, veto_regions, pulse_counts) | Use a default baseline for incorrectly chunked fragments. This is a kludge for improperly converted XENON1T data. |
| baseline_samples | 40 | <OMITTED> | (records, veto_regions, pulse_counts) | Number of samples to use at the start of the pulse to determine the baseline |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (raw_records, raw_records_he, raw_records_aqmon, truth) | immutabledict mapping subdetector to (min, max) channel number. Provided by context |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (peaklets, lone_hits) | immutabledict mapping subdetector to (min, max) channel number. |
| check_peak_sum_area_rtol | None | <OMITTED> | (peak_basics,) | Check if the sum area and the sum of area per channel are the same. If None, don't do the check. To perform the check, set to the desired rtol value used e.g. '1e-4' (see np.isclose). |
| check_raw_record_overlaps | True | False | (records, veto_regions, pulse_counts) | Crash if any of the pulses in raw_records overlap with others in the same channel |
| chunk_size | 100 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Duration of each chunk in seconds |
| detector | XENONnT | XENONnT | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| diagnose_sorting | False | <OMITTED> | (peaklets, lone_hits) | Enable runtime checks for sorting and disjointness |
| diagnose_sorting | False | <OMITTED> | (peaks,) | Enable runtime checks for sorting and disjointness |
| event_rate | 1000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Average number of events per second |
| fax_config | fax_config_nt_design.json | fax_config_nt_design.json | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| fax_config_override | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary with configuration option overrides |
| fax_config_override_from_cmt | None | {'drift_time_gate': ('cmt_run_id', '0', 'electron_drift_time_gate', 'ONLINE', True), 'drift_velocity_liquid': ('cmt_run_id', '0', 'electron_drift_velocity', 'ONLINE', True), 'electron_lifetime_liquid': ('cmt_run_id', '0', 'elife', 'ONLINE', True)} | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary of fax parameter names (key) mapped to CMT config names (value)where the fax parameter values will be replaced by CMT |
| fax_file | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Directory with fax instructions |
| gain_model | <OMITTED> | cmt://to_pe_model?run_id=0&version=ONLINE | (merged_s2s,) | PMT gain model. Specify as (str(model_config), str(version), nT-->boolean |
| gain_model | <OMITTED> | cmt://to_pe_model?run_id=0&version=ONLINE | (peaklets, lone_hits) | PMT gain model. Specify as URL or explicit value |
| gain_model_mc | cmt://to_p...gin.run_id | cmt://to_pe_model?run_id=0&version=ONLINE | (raw_records, raw_records_he, raw_records_aqmon, truth) | PMT gain model. Specify as (model_type, model_config). |
| hev_gain_model | None | <OMITTED> | (records, veto_regions, pulse_counts) | PMT gain model used in the software high-energy veto. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (peaklets, lone_hits) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (records, veto_regions, pulse_counts) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| max_veto_value | None | <OMITTED> | (records, veto_regions, pulse_counts) | Optionally pass a HE peak that exceeds this absolute area. (if performing a hard veto, can keep a few statistics.) |
| merge_without_s1 | True | <OMITTED> | (peaks,) | If true, S1s will be igored during the merging. It's now possible for a S1 to be inside a S2 post merging |
| merge_without_s1 | True | <OMITTED> | (merged_s2s,) | If true, S1s will be igored during the merging. It's now possible for a S1 to be inside a S2 post merging |
| merged_s2s_get_window_size_factor | 5 | <OMITTED> | (merged_s2s,) | Factor of the window size for the merged_s2s plugin |
| n_chunk | 10 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of chunks to simulate |
| n_top_pmts | 253 | 253 | (peaklet_classification,) | Number of top PMTs |
| n_top_pmts | <OMITTED> | 253 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in top array. Provided by context |
| n_top_pmts | <OMITTED> | 253 | (peaklets, lone_hits) | Number of top TPC array PMTs |
| n_top_pmts | <OMITTED> | 253 | (merged_s2s,) | Number of top TPC array PMTs |
| n_top_pmts | 253 | 253 | (peak_basics,) | Number of top PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (peaklets, lone_hits) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (merged_s2s,) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in tpc. Provided by context |
| n_tpc_pmts | <OMITTED> | 494 | (records, veto_regions, pulse_counts) | Number of TPC PMTs |
| peak_left_extension | 30 | <OMITTED> | (peaklets, lone_hits) | Include this many ns left of hits in peaks |
| peak_min_pmts | 2 | <OMITTED> | (peaklets, lone_hits) | Minimum number of contributing PMTs needed to define a peak |
| peak_right_extension | 200 | <OMITTED> | (peaklets, lone_hits) | Include this many ns right of hits in peaks |
| peak_split_filter_wing_width | 70 | <OMITTED> | (peaklets, lone_hits) | Wing width of moving average filter for low-split natural breaks |
| peak_split_gof_threshold | (None, ((0.5, 1.0), (6.0, 0.4)), ((2.5, 1.0), (5.625, 0.4))) | <OMITTED> | (peaklets, lone_hits) | Natural breaks goodness of fit/split threshold to split a peak. Specify as tuples of (log10(area), threshold). |
| peak_split_iterations | 20 | <OMITTED> | (peaklets, lone_hits) | Maximum number of recursive peak splits to do. |
| peak_split_min_area | 40.0 | <OMITTED> | (peaklets, lone_hits) | Minimum area to evaluate natural breaks criterion. Smaller peaks are not split. |
| peaklet_gap_threshold | 700 | <OMITTED> | (peaklets, lone_hits) | No hits for this many ns triggers a new peak |
| peaklet_max_duration | 10000000 | <OMITTED> | (peaklets, lone_hits) | Maximum duration [ns] of a peaklet |
| per_pmt_truth | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Store the info per channel in the truth file |
| pmt_pulse_filter | None | <OMITTED> | (records, veto_regions, pulse_counts) | Linear filter to apply to pulses, will be normalized. |
| right_raw_extension | 100000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| s1_flatten_threshold_aft | (0.6, 100) | <OMITTED> | (peaklet_classification,) | Threshold for AFT, above which we use a flatted boundary for rise timeSpecified values: (AFT boundary, constant rise time). |
| s1_max_rise_time_post100 | 200 | <OMITTED> | (peaklet_classification,) | Maximum S1 rise time for > 100 PE [ns] |
| s1_min_coincidence | 2 | <OMITTED> | (peaklet_classification,) | Minimum tight coincidence necessary to make an S1 |
| s1_risetime_aft_parameters | (-1, 2.6) | <OMITTED> | (peaklet_classification,) | Slope and offset in exponential of emperical boundary in the rise time-AFT plot. Specified as (slope, offset) |
| s1_risetime_area_parameters | (50, 80, 12) | <OMITTED> | (peaklet_classification,) | norm, const, tau in the empirical boundary in the risetime-area plot |
| s2_merge_gap_thresholds | ((1.7, 26500.0), (4.0, 2600.0), (5.0, 0.0)) | <OMITTED> | (merged_s2s,) | Points to define maximum separation between peaklets to allow merging [ns] depending on log10 area of the merged peak\nwhere the gap size of the first point is the maximum gap to allow mergingand the area of the last point is the maximum area to allow merging. The format is ((log10(area), max_gap), (..., ...), (..., ...)) |
| s2_merge_max_duration | 50000 | <OMITTED> | (merged_s2s,) | Do not merge peaklets at all if the result would be a peak longer than this [ns] |
| s2_min_pmts | 4 | <OMITTED> | (peaklet_classification,) | Minimum number of PMTs contributing to an S2 |
| saturation_correction_on | True | <OMITTED> | (peaklets, lone_hits) | On off switch for saturation correction |
| saturation_min_reference_length | 20 | <OMITTED> | (peaklets, lone_hits) | Minimum number of reference sample used to correct saturated samples |
| saturation_reference_length | 100 | <OMITTED> | (peaklets, lone_hits) | Maximum number of reference sample used to correct saturated samples |
| save_outside_hits | (3, 20) | <OMITTED> | (records, veto_regions, pulse_counts) | Save (left, right) samples besides hits; cut the rest |
| seed | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Option for setting the seed of the random number generator used forgeneration of the instructions |
| sum_waveform_top_array | True | <OMITTED> | (peaklets, lone_hits) | Digitize the sum waveform of the top array separately |
| sum_waveform_top_array | True | <OMITTED> | (merged_s2s,) | Digitize the sum waveform of the top array separately |
| tail_veto_duration | 3000000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time in ns to veto after large peaks |
| tail_veto_pass_extend | 3 | <OMITTED> | (records, veto_regions, pulse_counts) | Extend pass veto by this many samples (tail_veto_resolution!) |
| tail_veto_pass_fraction | 0.05 | <OMITTED> | (records, veto_regions, pulse_counts) | Pass veto if maximum amplitude above max * fraction |
| tail_veto_resolution | 1000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time resolution in ns for pass-veto waveform summation |
| tail_veto_threshold | 0 | <OMITTED> | (records, veto_regions, pulse_counts) | Minimum peakarea in PE to trigger tail veto.Set to None, 0 or False to disable veto. |
| tight_coincidence_window_left | 50 | <OMITTED> | (peaklets, lone_hits) | Time range left of peak center to call a hit a tight coincidence (ns) |
| tight_coincidence_window_right | 50 | <OMITTED> | (peaklets, lone_hits) | Time range right of peak center to call a hit a tight coincidence (ns) |
peaks
Description
Provided by plugin: Peaks
Data kind: peaks
- Merge peaklets and merged S2s such that we obtain our peaks (replacing all peaklets that were
later re-merged as S2s).
As this step is computationally trivial, never save this plugin.
Columns provided
| Field name | Data type | Comment |
|---|---|---|
| time | int64 | Start time since unix epoch [ns] |
| length | int32 | Length of the interval in samples |
| dt | int32 | Width of one sample [ns] |
| channel | int16 | Channel/PMT number |
| type | int8 | Classification of the peak(let) |
| area | float32 | Integral across channels [PE] |
| area_per_channel | ('<f4', (494,)) | Integral per channel [PE] |
| n_hits | int32 | Number of hits contributing at least one sample to the peak |
| data | ('<f4', (200,)) | Waveform data in PE/sample (not PE/ns!) |
| data_top | ('<f4', (200,)) | Waveform data in PE/sample (not PE/ns!), top array |
| width | ('<f4', (11,)) | Peak widths in range of central area fraction [ns] |
| area_decile_from_midpoint | ('<f4', (11,)) | Peak widths: time between nth and 5th area decile [ns] |
| saturated_channel | ('i1', (494,)) | Does the channel reach ADC saturation? |
| n_saturated_channels | int16 | Total number of saturated channels |
| tight_coincidence | int16 | Channel within tight range of mean |
| max_gap | int32 | Largest gap between hits inside peak [ns] |
| max_goodness_of_split | float32 | Maximum interior goodness of split |
| max_diff | int32 | Largest time difference between apexes of hits inside peak [ns] |
| min_diff | int32 | Smallest time difference between apexes of hits inside peak [ns] |
Dependencies
Configuration options
These are all options that affect this data type. This also includes options taken by dependencies of this datatype, because changing any of those options affect this data indirectly.
| option | default | current | applies_to | help |
|---|---|---|---|---|
| allow_sloppy_chunking | False | <OMITTED> | (records, veto_regions, pulse_counts) | Use a default baseline for incorrectly chunked fragments. This is a kludge for improperly converted XENON1T data. |
| baseline_samples | 40 | <OMITTED> | (records, veto_regions, pulse_counts) | Number of samples to use at the start of the pulse to determine the baseline |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (peaklets, lone_hits) | immutabledict mapping subdetector to (min, max) channel number. |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (raw_records, raw_records_he, raw_records_aqmon, truth) | immutabledict mapping subdetector to (min, max) channel number. Provided by context |
| check_raw_record_overlaps | True | False | (records, veto_regions, pulse_counts) | Crash if any of the pulses in raw_records overlap with others in the same channel |
| chunk_size | 100 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Duration of each chunk in seconds |
| detector | XENONnT | XENONnT | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| diagnose_sorting | False | <OMITTED> | (peaks,) | Enable runtime checks for sorting and disjointness |
| diagnose_sorting | False | <OMITTED> | (peaklets, lone_hits) | Enable runtime checks for sorting and disjointness |
| event_rate | 1000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Average number of events per second |
| fax_config | fax_config_nt_design.json | fax_config_nt_design.json | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| fax_config_override | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary with configuration option overrides |
| fax_config_override_from_cmt | None | {'drift_time_gate': ('cmt_run_id', '0', 'electron_drift_time_gate', 'ONLINE', True), 'drift_velocity_liquid': ('cmt_run_id', '0', 'electron_drift_velocity', 'ONLINE', True), 'electron_lifetime_liquid': ('cmt_run_id', '0', 'elife', 'ONLINE', True)} | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary of fax parameter names (key) mapped to CMT config names (value)where the fax parameter values will be replaced by CMT |
| fax_file | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Directory with fax instructions |
| gain_model | <OMITTED> | cmt://to_pe_model?run_id=0&version=ONLINE | (merged_s2s,) | PMT gain model. Specify as (str(model_config), str(version), nT-->boolean |
| gain_model | <OMITTED> | cmt://to_pe_model?run_id=0&version=ONLINE | (peaklets, lone_hits) | PMT gain model. Specify as URL or explicit value |
| gain_model_mc | cmt://to_p...gin.run_id | cmt://to_pe_model?run_id=0&version=ONLINE | (raw_records, raw_records_he, raw_records_aqmon, truth) | PMT gain model. Specify as (model_type, model_config). |
| hev_gain_model | None | <OMITTED> | (records, veto_regions, pulse_counts) | PMT gain model used in the software high-energy veto. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (records, veto_regions, pulse_counts) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (peaklets, lone_hits) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| max_veto_value | None | <OMITTED> | (records, veto_regions, pulse_counts) | Optionally pass a HE peak that exceeds this absolute area. (if performing a hard veto, can keep a few statistics.) |
| merge_without_s1 | True | <OMITTED> | (merged_s2s,) | If true, S1s will be igored during the merging. It's now possible for a S1 to be inside a S2 post merging |
| merge_without_s1 | True | <OMITTED> | (peaks,) | If true, S1s will be igored during the merging. It's now possible for a S1 to be inside a S2 post merging |
| merged_s2s_get_window_size_factor | 5 | <OMITTED> | (merged_s2s,) | Factor of the window size for the merged_s2s plugin |
| n_chunk | 10 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of chunks to simulate |
| n_top_pmts | <OMITTED> | 253 | (peaklets, lone_hits) | Number of top TPC array PMTs |
| n_top_pmts | <OMITTED> | 253 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in top array. Provided by context |
| n_top_pmts | <OMITTED> | 253 | (merged_s2s,) | Number of top TPC array PMTs |
| n_top_pmts | 253 | 253 | (peaklet_classification,) | Number of top PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in tpc. Provided by context |
| n_tpc_pmts | <OMITTED> | 494 | (peaklets, lone_hits) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (records, veto_regions, pulse_counts) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (merged_s2s,) | Number of TPC PMTs |
| peak_left_extension | 30 | <OMITTED> | (peaklets, lone_hits) | Include this many ns left of hits in peaks |
| peak_min_pmts | 2 | <OMITTED> | (peaklets, lone_hits) | Minimum number of contributing PMTs needed to define a peak |
| peak_right_extension | 200 | <OMITTED> | (peaklets, lone_hits) | Include this many ns right of hits in peaks |
| peak_split_filter_wing_width | 70 | <OMITTED> | (peaklets, lone_hits) | Wing width of moving average filter for low-split natural breaks |
| peak_split_gof_threshold | (None, ((0.5, 1.0), (6.0, 0.4)), ((2.5, 1.0), (5.625, 0.4))) | <OMITTED> | (peaklets, lone_hits) | Natural breaks goodness of fit/split threshold to split a peak. Specify as tuples of (log10(area), threshold). |
| peak_split_iterations | 20 | <OMITTED> | (peaklets, lone_hits) | Maximum number of recursive peak splits to do. |
| peak_split_min_area | 40.0 | <OMITTED> | (peaklets, lone_hits) | Minimum area to evaluate natural breaks criterion. Smaller peaks are not split. |
| peaklet_gap_threshold | 700 | <OMITTED> | (peaklets, lone_hits) | No hits for this many ns triggers a new peak |
| peaklet_max_duration | 10000000 | <OMITTED> | (peaklets, lone_hits) | Maximum duration [ns] of a peaklet |
| per_pmt_truth | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Store the info per channel in the truth file |
| pmt_pulse_filter | None | <OMITTED> | (records, veto_regions, pulse_counts) | Linear filter to apply to pulses, will be normalized. |
| right_raw_extension | 100000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| s1_flatten_threshold_aft | (0.6, 100) | <OMITTED> | (peaklet_classification,) | Threshold for AFT, above which we use a flatted boundary for rise timeSpecified values: (AFT boundary, constant rise time). |
| s1_max_rise_time_post100 | 200 | <OMITTED> | (peaklet_classification,) | Maximum S1 rise time for > 100 PE [ns] |
| s1_min_coincidence | 2 | <OMITTED> | (peaklet_classification,) | Minimum tight coincidence necessary to make an S1 |
| s1_risetime_aft_parameters | (-1, 2.6) | <OMITTED> | (peaklet_classification,) | Slope and offset in exponential of emperical boundary in the rise time-AFT plot. Specified as (slope, offset) |
| s1_risetime_area_parameters | (50, 80, 12) | <OMITTED> | (peaklet_classification,) | norm, const, tau in the empirical boundary in the risetime-area plot |
| s2_merge_gap_thresholds | ((1.7, 26500.0), (4.0, 2600.0), (5.0, 0.0)) | <OMITTED> | (merged_s2s,) | Points to define maximum separation between peaklets to allow merging [ns] depending on log10 area of the merged peak\nwhere the gap size of the first point is the maximum gap to allow mergingand the area of the last point is the maximum area to allow merging. The format is ((log10(area), max_gap), (..., ...), (..., ...)) |
| s2_merge_max_duration | 50000 | <OMITTED> | (merged_s2s,) | Do not merge peaklets at all if the result would be a peak longer than this [ns] |
| s2_min_pmts | 4 | <OMITTED> | (peaklet_classification,) | Minimum number of PMTs contributing to an S2 |
| saturation_correction_on | True | <OMITTED> | (peaklets, lone_hits) | On off switch for saturation correction |
| saturation_min_reference_length | 20 | <OMITTED> | (peaklets, lone_hits) | Minimum number of reference sample used to correct saturated samples |
| saturation_reference_length | 100 | <OMITTED> | (peaklets, lone_hits) | Maximum number of reference sample used to correct saturated samples |
| save_outside_hits | (3, 20) | <OMITTED> | (records, veto_regions, pulse_counts) | Save (left, right) samples besides hits; cut the rest |
| seed | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Option for setting the seed of the random number generator used forgeneration of the instructions |
| sum_waveform_top_array | True | <OMITTED> | (peaklets, lone_hits) | Digitize the sum waveform of the top array separately |
| sum_waveform_top_array | True | <OMITTED> | (merged_s2s,) | Digitize the sum waveform of the top array separately |
| tail_veto_duration | 3000000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time in ns to veto after large peaks |
| tail_veto_pass_extend | 3 | <OMITTED> | (records, veto_regions, pulse_counts) | Extend pass veto by this many samples (tail_veto_resolution!) |
| tail_veto_pass_fraction | 0.05 | <OMITTED> | (records, veto_regions, pulse_counts) | Pass veto if maximum amplitude above max * fraction |
| tail_veto_resolution | 1000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time resolution in ns for pass-veto waveform summation |
| tail_veto_threshold | 0 | <OMITTED> | (records, veto_regions, pulse_counts) | Minimum peakarea in PE to trigger tail veto.Set to None, 0 or False to disable veto. |
| tight_coincidence_window_left | 50 | <OMITTED> | (peaklets, lone_hits) | Time range left of peak center to call a hit a tight coincidence (ns) |
| tight_coincidence_window_right | 50 | <OMITTED> | (peaklets, lone_hits) | Time range right of peak center to call a hit a tight coincidence (ns) |
merged_s2s
Description
Provided by plugin: MergedS2s
Data kind: merged_s2s
- Merge together peaklets if peak finding favours that they would form a single peak
instead.
Columns provided
| Field name | Data type | Comment |
|---|---|---|
| time | int64 | Start time since unix epoch [ns] |
| length | int32 | Length of the interval in samples |
| dt | int32 | Width of one sample [ns] |
| channel | int16 | Channel/PMT number |
| type | int8 | Classification of the peak(let) |
| area | float32 | Integral across channels [PE] |
| area_per_channel | ('<f4', (494,)) | Integral per channel [PE] |
| n_hits | int32 | Number of hits contributing at least one sample to the peak |
| data | ('<f4', (200,)) | Waveform data in PE/sample (not PE/ns!) |
| data_top | ('<f4', (200,)) | Waveform data in PE/sample (not PE/ns!), top array |
| width | ('<f4', (11,)) | Peak widths in range of central area fraction [ns] |
| area_decile_from_midpoint | ('<f4', (11,)) | Peak widths: time between nth and 5th area decile [ns] |
| saturated_channel | ('i1', (494,)) | Does the channel reach ADC saturation? |
| n_saturated_channels | int16 | Total number of saturated channels |
| tight_coincidence | int16 | Channel within tight range of mean |
| max_gap | int32 | Largest gap between hits inside peak [ns] |
| max_goodness_of_split | float32 | Maximum interior goodness of split |
| max_diff | int32 | Largest time difference between apexes of hits inside peak [ns] |
| min_diff | int32 | Smallest time difference between apexes of hits inside peak [ns] |
Dependencies
Configuration options
These are all options that affect this data type. This also includes options taken by dependencies of this datatype, because changing any of those options affect this data indirectly.
| option | default | current | applies_to | help |
|---|---|---|---|---|
| allow_sloppy_chunking | False | <OMITTED> | (records, veto_regions, pulse_counts) | Use a default baseline for incorrectly chunked fragments. This is a kludge for improperly converted XENON1T data. |
| baseline_samples | 40 | <OMITTED> | (records, veto_regions, pulse_counts) | Number of samples to use at the start of the pulse to determine the baseline |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (peaklets, lone_hits) | immutabledict mapping subdetector to (min, max) channel number. |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (raw_records, raw_records_he, raw_records_aqmon, truth) | immutabledict mapping subdetector to (min, max) channel number. Provided by context |
| check_raw_record_overlaps | True | False | (records, veto_regions, pulse_counts) | Crash if any of the pulses in raw_records overlap with others in the same channel |
| chunk_size | 100 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Duration of each chunk in seconds |
| detector | XENONnT | XENONnT | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| diagnose_sorting | False | <OMITTED> | (peaklets, lone_hits) | Enable runtime checks for sorting and disjointness |
| event_rate | 1000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Average number of events per second |
| fax_config | fax_config_nt_design.json | fax_config_nt_design.json | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| fax_config_override | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary with configuration option overrides |
| fax_config_override_from_cmt | None | {'drift_time_gate': ('cmt_run_id', '0', 'electron_drift_time_gate', 'ONLINE', True), 'drift_velocity_liquid': ('cmt_run_id', '0', 'electron_drift_velocity', 'ONLINE', True), 'electron_lifetime_liquid': ('cmt_run_id', '0', 'elife', 'ONLINE', True)} | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary of fax parameter names (key) mapped to CMT config names (value)where the fax parameter values will be replaced by CMT |
| fax_file | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Directory with fax instructions |
| gain_model | <OMITTED> | cmt://to_pe_model?run_id=0&version=ONLINE | (merged_s2s,) | PMT gain model. Specify as (str(model_config), str(version), nT-->boolean |
| gain_model | <OMITTED> | cmt://to_pe_model?run_id=0&version=ONLINE | (peaklets, lone_hits) | PMT gain model. Specify as URL or explicit value |
| gain_model_mc | cmt://to_p...gin.run_id | cmt://to_pe_model?run_id=0&version=ONLINE | (raw_records, raw_records_he, raw_records_aqmon, truth) | PMT gain model. Specify as (model_type, model_config). |
| hev_gain_model | None | <OMITTED> | (records, veto_regions, pulse_counts) | PMT gain model used in the software high-energy veto. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (peaklets, lone_hits) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (records, veto_regions, pulse_counts) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| max_veto_value | None | <OMITTED> | (records, veto_regions, pulse_counts) | Optionally pass a HE peak that exceeds this absolute area. (if performing a hard veto, can keep a few statistics.) |
| merge_without_s1 | True | <OMITTED> | (merged_s2s,) | If true, S1s will be igored during the merging. It's now possible for a S1 to be inside a S2 post merging |
| merged_s2s_get_window_size_factor | 5 | <OMITTED> | (merged_s2s,) | Factor of the window size for the merged_s2s plugin |
| n_chunk | 10 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of chunks to simulate |
| n_top_pmts | 253 | 253 | (peaklet_classification,) | Number of top PMTs |
| n_top_pmts | <OMITTED> | 253 | (merged_s2s,) | Number of top TPC array PMTs |
| n_top_pmts | <OMITTED> | 253 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in top array. Provided by context |
| n_top_pmts | <OMITTED> | 253 | (peaklets, lone_hits) | Number of top TPC array PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (records, veto_regions, pulse_counts) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in tpc. Provided by context |
| n_tpc_pmts | <OMITTED> | 494 | (merged_s2s,) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (peaklets, lone_hits) | Number of TPC PMTs |
| peak_left_extension | 30 | <OMITTED> | (peaklets, lone_hits) | Include this many ns left of hits in peaks |
| peak_min_pmts | 2 | <OMITTED> | (peaklets, lone_hits) | Minimum number of contributing PMTs needed to define a peak |
| peak_right_extension | 200 | <OMITTED> | (peaklets, lone_hits) | Include this many ns right of hits in peaks |
| peak_split_filter_wing_width | 70 | <OMITTED> | (peaklets, lone_hits) | Wing width of moving average filter for low-split natural breaks |
| peak_split_gof_threshold | (None, ((0.5, 1.0), (6.0, 0.4)), ((2.5, 1.0), (5.625, 0.4))) | <OMITTED> | (peaklets, lone_hits) | Natural breaks goodness of fit/split threshold to split a peak. Specify as tuples of (log10(area), threshold). |
| peak_split_iterations | 20 | <OMITTED> | (peaklets, lone_hits) | Maximum number of recursive peak splits to do. |
| peak_split_min_area | 40.0 | <OMITTED> | (peaklets, lone_hits) | Minimum area to evaluate natural breaks criterion. Smaller peaks are not split. |
| peaklet_gap_threshold | 700 | <OMITTED> | (peaklets, lone_hits) | No hits for this many ns triggers a new peak |
| peaklet_max_duration | 10000000 | <OMITTED> | (peaklets, lone_hits) | Maximum duration [ns] of a peaklet |
| per_pmt_truth | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Store the info per channel in the truth file |
| pmt_pulse_filter | None | <OMITTED> | (records, veto_regions, pulse_counts) | Linear filter to apply to pulses, will be normalized. |
| right_raw_extension | 100000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| s1_flatten_threshold_aft | (0.6, 100) | <OMITTED> | (peaklet_classification,) | Threshold for AFT, above which we use a flatted boundary for rise timeSpecified values: (AFT boundary, constant rise time). |
| s1_max_rise_time_post100 | 200 | <OMITTED> | (peaklet_classification,) | Maximum S1 rise time for > 100 PE [ns] |
| s1_min_coincidence | 2 | <OMITTED> | (peaklet_classification,) | Minimum tight coincidence necessary to make an S1 |
| s1_risetime_aft_parameters | (-1, 2.6) | <OMITTED> | (peaklet_classification,) | Slope and offset in exponential of emperical boundary in the rise time-AFT plot. Specified as (slope, offset) |
| s1_risetime_area_parameters | (50, 80, 12) | <OMITTED> | (peaklet_classification,) | norm, const, tau in the empirical boundary in the risetime-area plot |
| s2_merge_gap_thresholds | ((1.7, 26500.0), (4.0, 2600.0), (5.0, 0.0)) | <OMITTED> | (merged_s2s,) | Points to define maximum separation between peaklets to allow merging [ns] depending on log10 area of the merged peak\nwhere the gap size of the first point is the maximum gap to allow mergingand the area of the last point is the maximum area to allow merging. The format is ((log10(area), max_gap), (..., ...), (..., ...)) |
| s2_merge_max_duration | 50000 | <OMITTED> | (merged_s2s,) | Do not merge peaklets at all if the result would be a peak longer than this [ns] |
| s2_min_pmts | 4 | <OMITTED> | (peaklet_classification,) | Minimum number of PMTs contributing to an S2 |
| saturation_correction_on | True | <OMITTED> | (peaklets, lone_hits) | On off switch for saturation correction |
| saturation_min_reference_length | 20 | <OMITTED> | (peaklets, lone_hits) | Minimum number of reference sample used to correct saturated samples |
| saturation_reference_length | 100 | <OMITTED> | (peaklets, lone_hits) | Maximum number of reference sample used to correct saturated samples |
| save_outside_hits | (3, 20) | <OMITTED> | (records, veto_regions, pulse_counts) | Save (left, right) samples besides hits; cut the rest |
| seed | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Option for setting the seed of the random number generator used forgeneration of the instructions |
| sum_waveform_top_array | True | <OMITTED> | (peaklets, lone_hits) | Digitize the sum waveform of the top array separately |
| sum_waveform_top_array | True | <OMITTED> | (merged_s2s,) | Digitize the sum waveform of the top array separately |
| tail_veto_duration | 3000000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time in ns to veto after large peaks |
| tail_veto_pass_extend | 3 | <OMITTED> | (records, veto_regions, pulse_counts) | Extend pass veto by this many samples (tail_veto_resolution!) |
| tail_veto_pass_fraction | 0.05 | <OMITTED> | (records, veto_regions, pulse_counts) | Pass veto if maximum amplitude above max * fraction |
| tail_veto_resolution | 1000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time resolution in ns for pass-veto waveform summation |
| tail_veto_threshold | 0 | <OMITTED> | (records, veto_regions, pulse_counts) | Minimum peakarea in PE to trigger tail veto.Set to None, 0 or False to disable veto. |
| tight_coincidence_window_left | 50 | <OMITTED> | (peaklets, lone_hits) | Time range left of peak center to call a hit a tight coincidence (ns) |
| tight_coincidence_window_right | 50 | <OMITTED> | (peaklets, lone_hits) | Time range right of peak center to call a hit a tight coincidence (ns) |
peaklet_classification
Description
Provided by plugin: PeakletClassification
Data kind: peaklets
Classify peaklets as unknown, S1, or S2.
Columns provided
| Field name | Data type | Comment |
|---|---|---|
| time | int64 | Start time since unix epoch [ns] |
| length | int32 | Length of the interval in samples |
| dt | int32 | Width of one sample [ns] |
| channel | int16 | Channel/PMT number |
| type | int8 | Classification of the peak(let) |
Dependencies
Configuration options
These are all options that affect this data type. This also includes options taken by dependencies of this datatype, because changing any of those options affect this data indirectly.
| option | default | current | applies_to | help |
|---|---|---|---|---|
| allow_sloppy_chunking | False | <OMITTED> | (records, veto_regions, pulse_counts) | Use a default baseline for incorrectly chunked fragments. This is a kludge for improperly converted XENON1T data. |
| baseline_samples | 40 | <OMITTED> | (records, veto_regions, pulse_counts) | Number of samples to use at the start of the pulse to determine the baseline |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (peaklets, lone_hits) | immutabledict mapping subdetector to (min, max) channel number. |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (raw_records, raw_records_he, raw_records_aqmon, truth) | immutabledict mapping subdetector to (min, max) channel number. Provided by context |
| check_raw_record_overlaps | True | False | (records, veto_regions, pulse_counts) | Crash if any of the pulses in raw_records overlap with others in the same channel |
| chunk_size | 100 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Duration of each chunk in seconds |
| detector | XENONnT | XENONnT | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| diagnose_sorting | False | <OMITTED> | (peaklets, lone_hits) | Enable runtime checks for sorting and disjointness |
| event_rate | 1000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Average number of events per second |
| fax_config | fax_config_nt_design.json | fax_config_nt_design.json | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| fax_config_override | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary with configuration option overrides |
| fax_config_override_from_cmt | None | {'drift_time_gate': ('cmt_run_id', '0', 'electron_drift_time_gate', 'ONLINE', True), 'drift_velocity_liquid': ('cmt_run_id', '0', 'electron_drift_velocity', 'ONLINE', True), 'electron_lifetime_liquid': ('cmt_run_id', '0', 'elife', 'ONLINE', True)} | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary of fax parameter names (key) mapped to CMT config names (value)where the fax parameter values will be replaced by CMT |
| fax_file | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Directory with fax instructions |
| gain_model | <OMITTED> | cmt://to_pe_model?run_id=0&version=ONLINE | (peaklets, lone_hits) | PMT gain model. Specify as URL or explicit value |
| gain_model_mc | cmt://to_p...gin.run_id | cmt://to_pe_model?run_id=0&version=ONLINE | (raw_records, raw_records_he, raw_records_aqmon, truth) | PMT gain model. Specify as (model_type, model_config). |
| hev_gain_model | None | <OMITTED> | (records, veto_regions, pulse_counts) | PMT gain model used in the software high-energy veto. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (peaklets, lone_hits) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (records, veto_regions, pulse_counts) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| max_veto_value | None | <OMITTED> | (records, veto_regions, pulse_counts) | Optionally pass a HE peak that exceeds this absolute area. (if performing a hard veto, can keep a few statistics.) |
| n_chunk | 10 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of chunks to simulate |
| n_top_pmts | <OMITTED> | 253 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in top array. Provided by context |
| n_top_pmts | 253 | 253 | (peaklet_classification,) | Number of top PMTs |
| n_top_pmts | <OMITTED> | 253 | (peaklets, lone_hits) | Number of top TPC array PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (records, veto_regions, pulse_counts) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (peaklets, lone_hits) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in tpc. Provided by context |
| peak_left_extension | 30 | <OMITTED> | (peaklets, lone_hits) | Include this many ns left of hits in peaks |
| peak_min_pmts | 2 | <OMITTED> | (peaklets, lone_hits) | Minimum number of contributing PMTs needed to define a peak |
| peak_right_extension | 200 | <OMITTED> | (peaklets, lone_hits) | Include this many ns right of hits in peaks |
| peak_split_filter_wing_width | 70 | <OMITTED> | (peaklets, lone_hits) | Wing width of moving average filter for low-split natural breaks |
| peak_split_gof_threshold | (None, ((0.5, 1.0), (6.0, 0.4)), ((2.5, 1.0), (5.625, 0.4))) | <OMITTED> | (peaklets, lone_hits) | Natural breaks goodness of fit/split threshold to split a peak. Specify as tuples of (log10(area), threshold). |
| peak_split_iterations | 20 | <OMITTED> | (peaklets, lone_hits) | Maximum number of recursive peak splits to do. |
| peak_split_min_area | 40.0 | <OMITTED> | (peaklets, lone_hits) | Minimum area to evaluate natural breaks criterion. Smaller peaks are not split. |
| peaklet_gap_threshold | 700 | <OMITTED> | (peaklets, lone_hits) | No hits for this many ns triggers a new peak |
| peaklet_max_duration | 10000000 | <OMITTED> | (peaklets, lone_hits) | Maximum duration [ns] of a peaklet |
| per_pmt_truth | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Store the info per channel in the truth file |
| pmt_pulse_filter | None | <OMITTED> | (records, veto_regions, pulse_counts) | Linear filter to apply to pulses, will be normalized. |
| right_raw_extension | 100000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| s1_flatten_threshold_aft | (0.6, 100) | <OMITTED> | (peaklet_classification,) | Threshold for AFT, above which we use a flatted boundary for rise timeSpecified values: (AFT boundary, constant rise time). |
| s1_max_rise_time_post100 | 200 | <OMITTED> | (peaklet_classification,) | Maximum S1 rise time for > 100 PE [ns] |
| s1_min_coincidence | 2 | <OMITTED> | (peaklet_classification,) | Minimum tight coincidence necessary to make an S1 |
| s1_risetime_aft_parameters | (-1, 2.6) | <OMITTED> | (peaklet_classification,) | Slope and offset in exponential of emperical boundary in the rise time-AFT plot. Specified as (slope, offset) |
| s1_risetime_area_parameters | (50, 80, 12) | <OMITTED> | (peaklet_classification,) | norm, const, tau in the empirical boundary in the risetime-area plot |
| s2_min_pmts | 4 | <OMITTED> | (peaklet_classification,) | Minimum number of PMTs contributing to an S2 |
| saturation_correction_on | True | <OMITTED> | (peaklets, lone_hits) | On off switch for saturation correction |
| saturation_min_reference_length | 20 | <OMITTED> | (peaklets, lone_hits) | Minimum number of reference sample used to correct saturated samples |
| saturation_reference_length | 100 | <OMITTED> | (peaklets, lone_hits) | Maximum number of reference sample used to correct saturated samples |
| save_outside_hits | (3, 20) | <OMITTED> | (records, veto_regions, pulse_counts) | Save (left, right) samples besides hits; cut the rest |
| seed | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Option for setting the seed of the random number generator used forgeneration of the instructions |
| sum_waveform_top_array | True | <OMITTED> | (peaklets, lone_hits) | Digitize the sum waveform of the top array separately |
| tail_veto_duration | 3000000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time in ns to veto after large peaks |
| tail_veto_pass_extend | 3 | <OMITTED> | (records, veto_regions, pulse_counts) | Extend pass veto by this many samples (tail_veto_resolution!) |
| tail_veto_pass_fraction | 0.05 | <OMITTED> | (records, veto_regions, pulse_counts) | Pass veto if maximum amplitude above max * fraction |
| tail_veto_resolution | 1000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time resolution in ns for pass-veto waveform summation |
| tail_veto_threshold | 0 | <OMITTED> | (records, veto_regions, pulse_counts) | Minimum peakarea in PE to trigger tail veto.Set to None, 0 or False to disable veto. |
| tight_coincidence_window_left | 50 | <OMITTED> | (peaklets, lone_hits) | Time range left of peak center to call a hit a tight coincidence (ns) |
| tight_coincidence_window_right | 50 | <OMITTED> | (peaklets, lone_hits) | Time range right of peak center to call a hit a tight coincidence (ns) |
peaklets
Description
Provided by plugin: Peaklets
Data kind: peaklets
- Split records into:
peaklets
lone_hits
Peaklets are very aggressively split peaks such that we are able to find S1-S2s even if they are close to each other. (S2) Peaks that are split into too many peaklets will be merged later on.
- To get Peaklets from records apply/do:
Hit finding
Peak finding
Peak splitting using the natural breaks algorithm
Compute the digital sum waveform
Lone hits are all hits which are outside of any peak. The area of lone_hits includes the left and right hit extension, except the extension overlaps with any peaks or other hits.
Columns provided
| Field name | Data type | Comment |
|---|---|---|
| time | int64 | Start time since unix epoch [ns] |
| length | int32 | Length of the interval in samples |
| dt | int32 | Width of one sample [ns] |
| channel | int16 | Channel/PMT number |
| type | int8 | Classification of the peak(let) |
| area | float32 | Integral across channels [PE] |
| area_per_channel | ('<f4', (494,)) | Integral per channel [PE] |
| n_hits | int32 | Number of hits contributing at least one sample to the peak |
| data | ('<f4', (200,)) | Waveform data in PE/sample (not PE/ns!) |
| data_top | ('<f4', (200,)) | Waveform data in PE/sample (not PE/ns!), top array |
| width | ('<f4', (11,)) | Peak widths in range of central area fraction [ns] |
| area_decile_from_midpoint | ('<f4', (11,)) | Peak widths: time between nth and 5th area decile [ns] |
| saturated_channel | ('i1', (494,)) | Does the channel reach ADC saturation? |
| n_saturated_channels | int16 | Total number of saturated channels |
| tight_coincidence | int16 | Channel within tight range of mean |
| max_gap | int32 | Largest gap between hits inside peak [ns] |
| max_goodness_of_split | float32 | Maximum interior goodness of split |
| max_diff | int32 | Largest time difference between apexes of hits inside peak [ns] |
| min_diff | int32 | Smallest time difference between apexes of hits inside peak [ns] |
Dependencies
Configuration options
These are all options that affect this data type. This also includes options taken by dependencies of this datatype, because changing any of those options affect this data indirectly.
| option | default | current | applies_to | help |
|---|---|---|---|---|
| allow_sloppy_chunking | False | <OMITTED> | (records, veto_regions, pulse_counts) | Use a default baseline for incorrectly chunked fragments. This is a kludge for improperly converted XENON1T data. |
| baseline_samples | 40 | <OMITTED> | (records, veto_regions, pulse_counts) | Number of samples to use at the start of the pulse to determine the baseline |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (raw_records, raw_records_he, raw_records_aqmon, truth) | immutabledict mapping subdetector to (min, max) channel number. Provided by context |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (peaklets, lone_hits) | immutabledict mapping subdetector to (min, max) channel number. |
| check_raw_record_overlaps | True | False | (records, veto_regions, pulse_counts) | Crash if any of the pulses in raw_records overlap with others in the same channel |
| chunk_size | 100 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Duration of each chunk in seconds |
| detector | XENONnT | XENONnT | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| diagnose_sorting | False | <OMITTED> | (peaklets, lone_hits) | Enable runtime checks for sorting and disjointness |
| event_rate | 1000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Average number of events per second |
| fax_config | fax_config_nt_design.json | fax_config_nt_design.json | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| fax_config_override | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary with configuration option overrides |
| fax_config_override_from_cmt | None | {'drift_time_gate': ('cmt_run_id', '0', 'electron_drift_time_gate', 'ONLINE', True), 'drift_velocity_liquid': ('cmt_run_id', '0', 'electron_drift_velocity', 'ONLINE', True), 'electron_lifetime_liquid': ('cmt_run_id', '0', 'elife', 'ONLINE', True)} | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary of fax parameter names (key) mapped to CMT config names (value)where the fax parameter values will be replaced by CMT |
| fax_file | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Directory with fax instructions |
| gain_model | <OMITTED> | cmt://to_pe_model?run_id=0&version=ONLINE | (peaklets, lone_hits) | PMT gain model. Specify as URL or explicit value |
| gain_model_mc | cmt://to_p...gin.run_id | cmt://to_pe_model?run_id=0&version=ONLINE | (raw_records, raw_records_he, raw_records_aqmon, truth) | PMT gain model. Specify as (model_type, model_config). |
| hev_gain_model | None | <OMITTED> | (records, veto_regions, pulse_counts) | PMT gain model used in the software high-energy veto. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (records, veto_regions, pulse_counts) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (peaklets, lone_hits) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| max_veto_value | None | <OMITTED> | (records, veto_regions, pulse_counts) | Optionally pass a HE peak that exceeds this absolute area. (if performing a hard veto, can keep a few statistics.) |
| n_chunk | 10 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of chunks to simulate |
| n_top_pmts | <OMITTED> | 253 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in top array. Provided by context |
| n_top_pmts | <OMITTED> | 253 | (peaklets, lone_hits) | Number of top TPC array PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (peaklets, lone_hits) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in tpc. Provided by context |
| n_tpc_pmts | <OMITTED> | 494 | (records, veto_regions, pulse_counts) | Number of TPC PMTs |
| peak_left_extension | 30 | <OMITTED> | (peaklets, lone_hits) | Include this many ns left of hits in peaks |
| peak_min_pmts | 2 | <OMITTED> | (peaklets, lone_hits) | Minimum number of contributing PMTs needed to define a peak |
| peak_right_extension | 200 | <OMITTED> | (peaklets, lone_hits) | Include this many ns right of hits in peaks |
| peak_split_filter_wing_width | 70 | <OMITTED> | (peaklets, lone_hits) | Wing width of moving average filter for low-split natural breaks |
| peak_split_gof_threshold | (None, ((0.5, 1.0), (6.0, 0.4)), ((2.5, 1.0), (5.625, 0.4))) | <OMITTED> | (peaklets, lone_hits) | Natural breaks goodness of fit/split threshold to split a peak. Specify as tuples of (log10(area), threshold). |
| peak_split_iterations | 20 | <OMITTED> | (peaklets, lone_hits) | Maximum number of recursive peak splits to do. |
| peak_split_min_area | 40.0 | <OMITTED> | (peaklets, lone_hits) | Minimum area to evaluate natural breaks criterion. Smaller peaks are not split. |
| peaklet_gap_threshold | 700 | <OMITTED> | (peaklets, lone_hits) | No hits for this many ns triggers a new peak |
| peaklet_max_duration | 10000000 | <OMITTED> | (peaklets, lone_hits) | Maximum duration [ns] of a peaklet |
| per_pmt_truth | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Store the info per channel in the truth file |
| pmt_pulse_filter | None | <OMITTED> | (records, veto_regions, pulse_counts) | Linear filter to apply to pulses, will be normalized. |
| right_raw_extension | 100000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| saturation_correction_on | True | <OMITTED> | (peaklets, lone_hits) | On off switch for saturation correction |
| saturation_min_reference_length | 20 | <OMITTED> | (peaklets, lone_hits) | Minimum number of reference sample used to correct saturated samples |
| saturation_reference_length | 100 | <OMITTED> | (peaklets, lone_hits) | Maximum number of reference sample used to correct saturated samples |
| save_outside_hits | (3, 20) | <OMITTED> | (records, veto_regions, pulse_counts) | Save (left, right) samples besides hits; cut the rest |
| seed | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Option for setting the seed of the random number generator used forgeneration of the instructions |
| sum_waveform_top_array | True | <OMITTED> | (peaklets, lone_hits) | Digitize the sum waveform of the top array separately |
| tail_veto_duration | 3000000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time in ns to veto after large peaks |
| tail_veto_pass_extend | 3 | <OMITTED> | (records, veto_regions, pulse_counts) | Extend pass veto by this many samples (tail_veto_resolution!) |
| tail_veto_pass_fraction | 0.05 | <OMITTED> | (records, veto_regions, pulse_counts) | Pass veto if maximum amplitude above max * fraction |
| tail_veto_resolution | 1000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time resolution in ns for pass-veto waveform summation |
| tail_veto_threshold | 0 | <OMITTED> | (records, veto_regions, pulse_counts) | Minimum peakarea in PE to trigger tail veto.Set to None, 0 or False to disable veto. |
| tight_coincidence_window_left | 50 | <OMITTED> | (peaklets, lone_hits) | Time range left of peak center to call a hit a tight coincidence (ns) |
| tight_coincidence_window_right | 50 | <OMITTED> | (peaklets, lone_hits) | Time range right of peak center to call a hit a tight coincidence (ns) |
lone_hits
Description
Provided by plugin: Peaklets
Data kind: lone_hits
- Split records into:
peaklets
lone_hits
Peaklets are very aggressively split peaks such that we are able to find S1-S2s even if they are close to each other. (S2) Peaks that are split into too many peaklets will be merged later on.
- To get Peaklets from records apply/do:
Hit finding
Peak finding
Peak splitting using the natural breaks algorithm
Compute the digital sum waveform
Lone hits are all hits which are outside of any peak. The area of lone_hits includes the left and right hit extension, except the extension overlaps with any peaks or other hits.
Columns provided
| Field name | Data type | Comment |
|---|---|---|
| time | int64 | Start time since unix epoch [ns] |
| length | int32 | Length of the interval in samples |
| dt | int16 | Width of one sample [ns] |
| channel | int16 | Channel/PMT number |
| area | float32 | Integral [ADC x samples] |
| left | int16 | Index of sample in record in which hit starts |
| right | int16 | Index of first sample in record just beyond hit (exclusive bound) |
| left_integration | int16 | For lone hits, index of sample in record where integration starts |
| right_integration | int16 | For lone hits, index of first sample beyond integration region |
| record_i | int32 | Internal (temporary) index of fragment in which hit was found |
| threshold | float32 | ADC threshold applied in order to find hits |
| height | float32 | Maximum amplitude above baseline [ADC counts] |
Dependencies
Configuration options
These are all options that affect this data type. This also includes options taken by dependencies of this datatype, because changing any of those options affect this data indirectly.
| option | default | current | applies_to | help |
|---|---|---|---|---|
| allow_sloppy_chunking | False | <OMITTED> | (records, veto_regions, pulse_counts) | Use a default baseline for incorrectly chunked fragments. This is a kludge for improperly converted XENON1T data. |
| baseline_samples | 40 | <OMITTED> | (records, veto_regions, pulse_counts) | Number of samples to use at the start of the pulse to determine the baseline |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (raw_records, raw_records_he, raw_records_aqmon, truth) | immutabledict mapping subdetector to (min, max) channel number. Provided by context |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (peaklets, lone_hits) | immutabledict mapping subdetector to (min, max) channel number. |
| check_raw_record_overlaps | True | False | (records, veto_regions, pulse_counts) | Crash if any of the pulses in raw_records overlap with others in the same channel |
| chunk_size | 100 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Duration of each chunk in seconds |
| detector | XENONnT | XENONnT | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| diagnose_sorting | False | <OMITTED> | (peaklets, lone_hits) | Enable runtime checks for sorting and disjointness |
| event_rate | 1000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Average number of events per second |
| fax_config | fax_config_nt_design.json | fax_config_nt_design.json | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| fax_config_override | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary with configuration option overrides |
| fax_config_override_from_cmt | None | {'drift_time_gate': ('cmt_run_id', '0', 'electron_drift_time_gate', 'ONLINE', True), 'drift_velocity_liquid': ('cmt_run_id', '0', 'electron_drift_velocity', 'ONLINE', True), 'electron_lifetime_liquid': ('cmt_run_id', '0', 'elife', 'ONLINE', True)} | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary of fax parameter names (key) mapped to CMT config names (value)where the fax parameter values will be replaced by CMT |
| fax_file | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Directory with fax instructions |
| gain_model | <OMITTED> | cmt://to_pe_model?run_id=0&version=ONLINE | (peaklets, lone_hits) | PMT gain model. Specify as URL or explicit value |
| gain_model_mc | cmt://to_p...gin.run_id | cmt://to_pe_model?run_id=0&version=ONLINE | (raw_records, raw_records_he, raw_records_aqmon, truth) | PMT gain model. Specify as (model_type, model_config). |
| hev_gain_model | None | <OMITTED> | (records, veto_regions, pulse_counts) | PMT gain model used in the software high-energy veto. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (records, veto_regions, pulse_counts) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (peaklets, lone_hits) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| max_veto_value | None | <OMITTED> | (records, veto_regions, pulse_counts) | Optionally pass a HE peak that exceeds this absolute area. (if performing a hard veto, can keep a few statistics.) |
| n_chunk | 10 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of chunks to simulate |
| n_top_pmts | <OMITTED> | 253 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in top array. Provided by context |
| n_top_pmts | <OMITTED> | 253 | (peaklets, lone_hits) | Number of top TPC array PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (peaklets, lone_hits) | Number of TPC PMTs |
| n_tpc_pmts | <OMITTED> | 494 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in tpc. Provided by context |
| n_tpc_pmts | <OMITTED> | 494 | (records, veto_regions, pulse_counts) | Number of TPC PMTs |
| peak_left_extension | 30 | <OMITTED> | (peaklets, lone_hits) | Include this many ns left of hits in peaks |
| peak_min_pmts | 2 | <OMITTED> | (peaklets, lone_hits) | Minimum number of contributing PMTs needed to define a peak |
| peak_right_extension | 200 | <OMITTED> | (peaklets, lone_hits) | Include this many ns right of hits in peaks |
| peak_split_filter_wing_width | 70 | <OMITTED> | (peaklets, lone_hits) | Wing width of moving average filter for low-split natural breaks |
| peak_split_gof_threshold | (None, ((0.5, 1.0), (6.0, 0.4)), ((2.5, 1.0), (5.625, 0.4))) | <OMITTED> | (peaklets, lone_hits) | Natural breaks goodness of fit/split threshold to split a peak. Specify as tuples of (log10(area), threshold). |
| peak_split_iterations | 20 | <OMITTED> | (peaklets, lone_hits) | Maximum number of recursive peak splits to do. |
| peak_split_min_area | 40.0 | <OMITTED> | (peaklets, lone_hits) | Minimum area to evaluate natural breaks criterion. Smaller peaks are not split. |
| peaklet_gap_threshold | 700 | <OMITTED> | (peaklets, lone_hits) | No hits for this many ns triggers a new peak |
| peaklet_max_duration | 10000000 | <OMITTED> | (peaklets, lone_hits) | Maximum duration [ns] of a peaklet |
| per_pmt_truth | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Store the info per channel in the truth file |
| pmt_pulse_filter | None | <OMITTED> | (records, veto_regions, pulse_counts) | Linear filter to apply to pulses, will be normalized. |
| right_raw_extension | 100000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| saturation_correction_on | True | <OMITTED> | (peaklets, lone_hits) | On off switch for saturation correction |
| saturation_min_reference_length | 20 | <OMITTED> | (peaklets, lone_hits) | Minimum number of reference sample used to correct saturated samples |
| saturation_reference_length | 100 | <OMITTED> | (peaklets, lone_hits) | Maximum number of reference sample used to correct saturated samples |
| save_outside_hits | (3, 20) | <OMITTED> | (records, veto_regions, pulse_counts) | Save (left, right) samples besides hits; cut the rest |
| seed | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Option for setting the seed of the random number generator used forgeneration of the instructions |
| sum_waveform_top_array | True | <OMITTED> | (peaklets, lone_hits) | Digitize the sum waveform of the top array separately |
| tail_veto_duration | 3000000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time in ns to veto after large peaks |
| tail_veto_pass_extend | 3 | <OMITTED> | (records, veto_regions, pulse_counts) | Extend pass veto by this many samples (tail_veto_resolution!) |
| tail_veto_pass_fraction | 0.05 | <OMITTED> | (records, veto_regions, pulse_counts) | Pass veto if maximum amplitude above max * fraction |
| tail_veto_resolution | 1000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time resolution in ns for pass-veto waveform summation |
| tail_veto_threshold | 0 | <OMITTED> | (records, veto_regions, pulse_counts) | Minimum peakarea in PE to trigger tail veto.Set to None, 0 or False to disable veto. |
| tight_coincidence_window_left | 50 | <OMITTED> | (peaklets, lone_hits) | Time range left of peak center to call a hit a tight coincidence (ns) |
| tight_coincidence_window_right | 50 | <OMITTED> | (peaklets, lone_hits) | Time range right of peak center to call a hit a tight coincidence (ns) |
records
Description
Provided by plugin: PulseProcessing
Data kind: records
- Split raw_records into:
(tpc) records
aqmon_records
pulse_counts
- For TPC records, apply basic processing:
Flip, baseline, and integrate the waveform
Apply software HE veto after high-energy peaks.
Find hits, apply linear filter, and zero outside hits.
pulse_counts holds some average information for the individual PMT channels for each chunk of raw_records. This includes e.g. number of recorded pulses, lone_pulses (pulses which do not overlap with any other pulse), or mean values of baseline and baseline rms channel.
Columns provided
| Field name | Data type | Comment |
|---|---|---|
| time | int64 | Start time since unix epoch [ns] |
| length | int32 | Length of the interval in samples |
| dt | int16 | Width of one sample [ns] |
| channel | int16 | Channel/PMT number |
| pulse_length | int32 | Length of pulse to which the record belongs (without zero-padding) |
| record_i | int16 | Fragment number in the pulse |
| area | int32 | Integral in ADC counts x samples |
| reduction_level | uint8 | Level of data reduction applied (strax.ReductionLevel enum) |
| baseline | float32 | Baseline in ADC counts. data = int(baseline) - data_orig |
| baseline_rms | float32 | Baseline RMS in ADC counts. data = baseline - data_orig |
| amplitude_bit_shift | int16 | Multiply data by 2**(this number). Baseline is unaffected. |
| data | ('<i2', (110,)) | Waveform data in raw counts above integer part of baseline |
Dependencies
Configuration options
These are all options that affect this data type. This also includes options taken by dependencies of this datatype, because changing any of those options affect this data indirectly.
| option | default | current | applies_to | help |
|---|---|---|---|---|
| allow_sloppy_chunking | False | <OMITTED> | (records, veto_regions, pulse_counts) | Use a default baseline for incorrectly chunked fragments. This is a kludge for improperly converted XENON1T data. |
| baseline_samples | 40 | <OMITTED> | (records, veto_regions, pulse_counts) | Number of samples to use at the start of the pulse to determine the baseline |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (raw_records, raw_records_he, raw_records_aqmon, truth) | immutabledict mapping subdetector to (min, max) channel number. Provided by context |
| check_raw_record_overlaps | True | False | (records, veto_regions, pulse_counts) | Crash if any of the pulses in raw_records overlap with others in the same channel |
| chunk_size | 100 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Duration of each chunk in seconds |
| detector | XENONnT | XENONnT | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| event_rate | 1000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Average number of events per second |
| fax_config | fax_config_nt_design.json | fax_config_nt_design.json | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| fax_config_override | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary with configuration option overrides |
| fax_config_override_from_cmt | None | {'drift_time_gate': ('cmt_run_id', '0', 'electron_drift_time_gate', 'ONLINE', True), 'drift_velocity_liquid': ('cmt_run_id', '0', 'electron_drift_velocity', 'ONLINE', True), 'electron_lifetime_liquid': ('cmt_run_id', '0', 'elife', 'ONLINE', True)} | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary of fax parameter names (key) mapped to CMT config names (value)where the fax parameter values will be replaced by CMT |
| fax_file | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Directory with fax instructions |
| gain_model_mc | cmt://to_p...gin.run_id | cmt://to_pe_model?run_id=0&version=ONLINE | (raw_records, raw_records_he, raw_records_aqmon, truth) | PMT gain model. Specify as (model_type, model_config). |
| hev_gain_model | None | <OMITTED> | (records, veto_regions, pulse_counts) | PMT gain model used in the software high-energy veto. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (records, veto_regions, pulse_counts) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| max_veto_value | None | <OMITTED> | (records, veto_regions, pulse_counts) | Optionally pass a HE peak that exceeds this absolute area. (if performing a hard veto, can keep a few statistics.) |
| n_chunk | 10 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of chunks to simulate |
| n_top_pmts | <OMITTED> | 253 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in top array. Provided by context |
| n_tpc_pmts | <OMITTED> | 494 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in tpc. Provided by context |
| n_tpc_pmts | <OMITTED> | 494 | (records, veto_regions, pulse_counts) | Number of TPC PMTs |
| per_pmt_truth | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Store the info per channel in the truth file |
| pmt_pulse_filter | None | <OMITTED> | (records, veto_regions, pulse_counts) | Linear filter to apply to pulses, will be normalized. |
| right_raw_extension | 100000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| save_outside_hits | (3, 20) | <OMITTED> | (records, veto_regions, pulse_counts) | Save (left, right) samples besides hits; cut the rest |
| seed | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Option for setting the seed of the random number generator used forgeneration of the instructions |
| tail_veto_duration | 3000000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time in ns to veto after large peaks |
| tail_veto_pass_extend | 3 | <OMITTED> | (records, veto_regions, pulse_counts) | Extend pass veto by this many samples (tail_veto_resolution!) |
| tail_veto_pass_fraction | 0.05 | <OMITTED> | (records, veto_regions, pulse_counts) | Pass veto if maximum amplitude above max * fraction |
| tail_veto_resolution | 1000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time resolution in ns for pass-veto waveform summation |
| tail_veto_threshold | 0 | <OMITTED> | (records, veto_regions, pulse_counts) | Minimum peakarea in PE to trigger tail veto.Set to None, 0 or False to disable veto. |
veto_regions
Description
Provided by plugin: PulseProcessing
Data kind: veto_regions
- Split raw_records into:
(tpc) records
aqmon_records
pulse_counts
- For TPC records, apply basic processing:
Flip, baseline, and integrate the waveform
Apply software HE veto after high-energy peaks.
Find hits, apply linear filter, and zero outside hits.
pulse_counts holds some average information for the individual PMT channels for each chunk of raw_records. This includes e.g. number of recorded pulses, lone_pulses (pulses which do not overlap with any other pulse), or mean values of baseline and baseline rms channel.
Columns provided
| Field name | Data type | Comment |
|---|---|---|
| time | int64 | Start time since unix epoch [ns] |
| length | int32 | Length of the interval in samples |
| dt | int16 | Width of one sample [ns] |
| channel | int16 | Channel/PMT number |
| area | float32 | Integral [ADC x samples] |
| left | int16 | Index of sample in record in which hit starts |
| right | int16 | Index of first sample in record just beyond hit (exclusive bound) |
| left_integration | int16 | For lone hits, index of sample in record where integration starts |
| right_integration | int16 | For lone hits, index of first sample beyond integration region |
| record_i | int32 | Internal (temporary) index of fragment in which hit was found |
| threshold | float32 | ADC threshold applied in order to find hits |
| height | float32 | Maximum amplitude above baseline [ADC counts] |
Dependencies
Configuration options
These are all options that affect this data type. This also includes options taken by dependencies of this datatype, because changing any of those options affect this data indirectly.
| option | default | current | applies_to | help |
|---|---|---|---|---|
| allow_sloppy_chunking | False | <OMITTED> | (records, veto_regions, pulse_counts) | Use a default baseline for incorrectly chunked fragments. This is a kludge for improperly converted XENON1T data. |
| baseline_samples | 40 | <OMITTED> | (records, veto_regions, pulse_counts) | Number of samples to use at the start of the pulse to determine the baseline |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (raw_records, raw_records_he, raw_records_aqmon, truth) | immutabledict mapping subdetector to (min, max) channel number. Provided by context |
| check_raw_record_overlaps | True | False | (records, veto_regions, pulse_counts) | Crash if any of the pulses in raw_records overlap with others in the same channel |
| chunk_size | 100 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Duration of each chunk in seconds |
| detector | XENONnT | XENONnT | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| event_rate | 1000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Average number of events per second |
| fax_config | fax_config_nt_design.json | fax_config_nt_design.json | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| fax_config_override | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary with configuration option overrides |
| fax_config_override_from_cmt | None | {'drift_time_gate': ('cmt_run_id', '0', 'electron_drift_time_gate', 'ONLINE', True), 'drift_velocity_liquid': ('cmt_run_id', '0', 'electron_drift_velocity', 'ONLINE', True), 'electron_lifetime_liquid': ('cmt_run_id', '0', 'elife', 'ONLINE', True)} | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary of fax parameter names (key) mapped to CMT config names (value)where the fax parameter values will be replaced by CMT |
| fax_file | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Directory with fax instructions |
| gain_model_mc | cmt://to_p...gin.run_id | cmt://to_pe_model?run_id=0&version=ONLINE | (raw_records, raw_records_he, raw_records_aqmon, truth) | PMT gain model. Specify as (model_type, model_config). |
| hev_gain_model | None | <OMITTED> | (records, veto_regions, pulse_counts) | PMT gain model used in the software high-energy veto. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (records, veto_regions, pulse_counts) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| max_veto_value | None | <OMITTED> | (records, veto_regions, pulse_counts) | Optionally pass a HE peak that exceeds this absolute area. (if performing a hard veto, can keep a few statistics.) |
| n_chunk | 10 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of chunks to simulate |
| n_top_pmts | <OMITTED> | 253 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in top array. Provided by context |
| n_tpc_pmts | <OMITTED> | 494 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in tpc. Provided by context |
| n_tpc_pmts | <OMITTED> | 494 | (records, veto_regions, pulse_counts) | Number of TPC PMTs |
| per_pmt_truth | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Store the info per channel in the truth file |
| pmt_pulse_filter | None | <OMITTED> | (records, veto_regions, pulse_counts) | Linear filter to apply to pulses, will be normalized. |
| right_raw_extension | 100000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| save_outside_hits | (3, 20) | <OMITTED> | (records, veto_regions, pulse_counts) | Save (left, right) samples besides hits; cut the rest |
| seed | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Option for setting the seed of the random number generator used forgeneration of the instructions |
| tail_veto_duration | 3000000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time in ns to veto after large peaks |
| tail_veto_pass_extend | 3 | <OMITTED> | (records, veto_regions, pulse_counts) | Extend pass veto by this many samples (tail_veto_resolution!) |
| tail_veto_pass_fraction | 0.05 | <OMITTED> | (records, veto_regions, pulse_counts) | Pass veto if maximum amplitude above max * fraction |
| tail_veto_resolution | 1000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time resolution in ns for pass-veto waveform summation |
| tail_veto_threshold | 0 | <OMITTED> | (records, veto_regions, pulse_counts) | Minimum peakarea in PE to trigger tail veto.Set to None, 0 or False to disable veto. |
pulse_counts
Description
Provided by plugin: PulseProcessing
Data kind: pulse_counts
- Split raw_records into:
(tpc) records
aqmon_records
pulse_counts
- For TPC records, apply basic processing:
Flip, baseline, and integrate the waveform
Apply software HE veto after high-energy peaks.
Find hits, apply linear filter, and zero outside hits.
pulse_counts holds some average information for the individual PMT channels for each chunk of raw_records. This includes e.g. number of recorded pulses, lone_pulses (pulses which do not overlap with any other pulse), or mean values of baseline and baseline rms channel.
Columns provided
| Field name | Data type | Comment |
|---|---|---|
| time | int64 | Start time of the chunk |
| endtime | int64 | End time of the chunk |
| pulse_count | ('<i8', (494,)) | Number of pulses |
| lone_pulse_count | ('<i8', (494,)) | Number of lone pulses |
| pulse_area | ('<i8', (494,)) | Integral of all pulses in ADC_count x samples |
| lone_pulse_area | ('<i8', (494,)) | Integral of lone pulses in ADC_count x samples |
| baseline_mean | ('<i2', (494,)) | Average baseline |
| baseline_rms_mean | ('<f4', (494,)) | Average baseline rms |
Dependencies
Configuration options
These are all options that affect this data type. This also includes options taken by dependencies of this datatype, because changing any of those options affect this data indirectly.
| option | default | current | applies_to | help |
|---|---|---|---|---|
| allow_sloppy_chunking | False | <OMITTED> | (records, veto_regions, pulse_counts) | Use a default baseline for incorrectly chunked fragments. This is a kludge for improperly converted XENON1T data. |
| baseline_samples | 40 | <OMITTED> | (records, veto_regions, pulse_counts) | Number of samples to use at the start of the pulse to determine the baseline |
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (raw_records, raw_records_he, raw_records_aqmon, truth) | immutabledict mapping subdetector to (min, max) channel number. Provided by context |
| check_raw_record_overlaps | True | False | (records, veto_regions, pulse_counts) | Crash if any of the pulses in raw_records overlap with others in the same channel |
| chunk_size | 100 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Duration of each chunk in seconds |
| detector | XENONnT | XENONnT | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| event_rate | 1000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Average number of events per second |
| fax_config | fax_config_nt_design.json | fax_config_nt_design.json | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| fax_config_override | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary with configuration option overrides |
| fax_config_override_from_cmt | None | {'drift_time_gate': ('cmt_run_id', '0', 'electron_drift_time_gate', 'ONLINE', True), 'drift_velocity_liquid': ('cmt_run_id', '0', 'electron_drift_velocity', 'ONLINE', True), 'electron_lifetime_liquid': ('cmt_run_id', '0', 'elife', 'ONLINE', True)} | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary of fax parameter names (key) mapped to CMT config names (value)where the fax parameter values will be replaced by CMT |
| fax_file | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Directory with fax instructions |
| gain_model_mc | cmt://to_p...gin.run_id | cmt://to_pe_model?run_id=0&version=ONLINE | (raw_records, raw_records_he, raw_records_aqmon, truth) | PMT gain model. Specify as (model_type, model_config). |
| hev_gain_model | None | <OMITTED> | (records, veto_regions, pulse_counts) | PMT gain model used in the software high-energy veto. |
| hit_min_amplitude | cmt://hit_...gin.run_id | cmt://hit_thresholds_tpc?run_id=0&version=ONLINE | (records, veto_regions, pulse_counts) | Minimum hit amplitude in ADC counts above baseline. Specify as a tuple of length n_tpc_pmts, or a number,or a string like "pmt_commissioning_initial" which means callinghitfinder_thresholds.pyor a tuple like (correction=str, version=str, nT=boolean),which means we are using cmt. |
| max_veto_value | None | <OMITTED> | (records, veto_regions, pulse_counts) | Optionally pass a HE peak that exceeds this absolute area. (if performing a hard veto, can keep a few statistics.) |
| n_chunk | 10 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of chunks to simulate |
| n_top_pmts | <OMITTED> | 253 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in top array. Provided by context |
| n_tpc_pmts | <OMITTED> | 494 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in tpc. Provided by context |
| n_tpc_pmts | <OMITTED> | 494 | (records, veto_regions, pulse_counts) | Number of TPC PMTs |
| per_pmt_truth | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Store the info per channel in the truth file |
| pmt_pulse_filter | None | <OMITTED> | (records, veto_regions, pulse_counts) | Linear filter to apply to pulses, will be normalized. |
| right_raw_extension | 100000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| save_outside_hits | (3, 20) | <OMITTED> | (records, veto_regions, pulse_counts) | Save (left, right) samples besides hits; cut the rest |
| seed | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Option for setting the seed of the random number generator used forgeneration of the instructions |
| tail_veto_duration | 3000000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time in ns to veto after large peaks |
| tail_veto_pass_extend | 3 | <OMITTED> | (records, veto_regions, pulse_counts) | Extend pass veto by this many samples (tail_veto_resolution!) |
| tail_veto_pass_fraction | 0.05 | <OMITTED> | (records, veto_regions, pulse_counts) | Pass veto if maximum amplitude above max * fraction |
| tail_veto_resolution | 1000 | <OMITTED> | (records, veto_regions, pulse_counts) | Time resolution in ns for pass-veto waveform summation |
| tail_veto_threshold | 0 | <OMITTED> | (records, veto_regions, pulse_counts) | Minimum peakarea in PE to trigger tail veto.Set to None, 0 or False to disable veto. |
truth_id
Description
Provided by plugin: TruthId
Data kind: truth
(no plugin description)
Columns provided
| Field name | Data type | Comment |
|---|---|---|
| time | int64 | Start time since unix epoch [ns] |
| endtime | int64 | Exclusive end time since unix epoch [ns] |
| id | int64 | Id of element in truth |
Dependencies
Configuration options
These are all options that affect this data type. This also includes options taken by dependencies of this datatype, because changing any of those options affect this data indirectly.
| option | default | current | applies_to | help |
|---|---|---|---|---|
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (raw_records, raw_records_he, raw_records_aqmon, truth) | immutabledict mapping subdetector to (min, max) channel number. Provided by context |
| chunk_size | 100 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Duration of each chunk in seconds |
| detector | XENONnT | XENONnT | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| event_rate | 1000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Average number of events per second |
| fax_config | fax_config_nt_design.json | fax_config_nt_design.json | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| fax_config_override | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary with configuration option overrides |
| fax_config_override_from_cmt | None | {'drift_time_gate': ('cmt_run_id', '0', 'electron_drift_time_gate', 'ONLINE', True), 'drift_velocity_liquid': ('cmt_run_id', '0', 'electron_drift_velocity', 'ONLINE', True), 'electron_lifetime_liquid': ('cmt_run_id', '0', 'elife', 'ONLINE', True)} | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary of fax parameter names (key) mapped to CMT config names (value)where the fax parameter values will be replaced by CMT |
| fax_file | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Directory with fax instructions |
| gain_model_mc | cmt://to_p...gin.run_id | cmt://to_pe_model?run_id=0&version=ONLINE | (raw_records, raw_records_he, raw_records_aqmon, truth) | PMT gain model. Specify as (model_type, model_config). |
| n_chunk | 10 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of chunks to simulate |
| n_top_pmts | <OMITTED> | 253 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in top array. Provided by context |
| n_tpc_pmts | <OMITTED> | 494 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in tpc. Provided by context |
| per_pmt_truth | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Store the info per channel in the truth file |
| right_raw_extension | 100000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| seed | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Option for setting the seed of the random number generator used forgeneration of the instructions |
raw_records
Description
Provided by plugin: RawRecordsFromFaxNT
Data kind: raw_records
(no plugin description)
Columns provided
| Field name | Data type | Comment |
|---|---|---|
| time | int64 | Start time since unix epoch [ns] |
| length | int32 | Length of the interval in samples |
| dt | int16 | Width of one sample [ns] |
| channel | int16 | Channel/PMT number |
| pulse_length | int32 | Length of pulse to which the record belongs (without zero-padding) |
| record_i | int16 | Fragment number in the pulse |
| baseline | int16 | Baseline determined by the digitizer (if this is supported) |
| data | ('<i2', (110,)) | Waveform data in raw ADC counts |
Dependencies
Configuration options
These are all options that affect this data type. This also includes options taken by dependencies of this datatype, because changing any of those options affect this data indirectly.
| option | default | current | applies_to | help |
|---|---|---|---|---|
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (raw_records, raw_records_he, raw_records_aqmon, truth) | immutabledict mapping subdetector to (min, max) channel number. Provided by context |
| chunk_size | 100 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Duration of each chunk in seconds |
| detector | XENONnT | XENONnT | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| event_rate | 1000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Average number of events per second |
| fax_config | fax_config_nt_design.json | fax_config_nt_design.json | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| fax_config_override | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary with configuration option overrides |
| fax_config_override_from_cmt | None | {'drift_time_gate': ('cmt_run_id', '0', 'electron_drift_time_gate', 'ONLINE', True), 'drift_velocity_liquid': ('cmt_run_id', '0', 'electron_drift_velocity', 'ONLINE', True), 'electron_lifetime_liquid': ('cmt_run_id', '0', 'elife', 'ONLINE', True)} | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary of fax parameter names (key) mapped to CMT config names (value)where the fax parameter values will be replaced by CMT |
| fax_file | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Directory with fax instructions |
| gain_model_mc | cmt://to_p...gin.run_id | cmt://to_pe_model?run_id=0&version=ONLINE | (raw_records, raw_records_he, raw_records_aqmon, truth) | PMT gain model. Specify as (model_type, model_config). |
| n_chunk | 10 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of chunks to simulate |
| n_top_pmts | <OMITTED> | 253 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in top array. Provided by context |
| n_tpc_pmts | <OMITTED> | 494 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in tpc. Provided by context |
| per_pmt_truth | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Store the info per channel in the truth file |
| right_raw_extension | 100000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| seed | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Option for setting the seed of the random number generator used forgeneration of the instructions |
raw_records_aqmon
Description
Provided by plugin: RawRecordsFromFaxNT
Data kind: raw_records_aqmon
(no plugin description)
Columns provided
| Field name | Data type | Comment |
|---|---|---|
| time | int64 | Start time since unix epoch [ns] |
| length | int32 | Length of the interval in samples |
| dt | int16 | Width of one sample [ns] |
| channel | int16 | Channel/PMT number |
| pulse_length | int32 | Length of pulse to which the record belongs (without zero-padding) |
| record_i | int16 | Fragment number in the pulse |
| baseline | int16 | Baseline determined by the digitizer (if this is supported) |
| data | ('<i2', (110,)) | Waveform data in raw ADC counts |
Dependencies
Configuration options
These are all options that affect this data type. This also includes options taken by dependencies of this datatype, because changing any of those options affect this data indirectly.
| option | default | current | applies_to | help |
|---|---|---|---|---|
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (raw_records, raw_records_he, raw_records_aqmon, truth) | immutabledict mapping subdetector to (min, max) channel number. Provided by context |
| chunk_size | 100 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Duration of each chunk in seconds |
| detector | XENONnT | XENONnT | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| event_rate | 1000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Average number of events per second |
| fax_config | fax_config_nt_design.json | fax_config_nt_design.json | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| fax_config_override | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary with configuration option overrides |
| fax_config_override_from_cmt | None | {'drift_time_gate': ('cmt_run_id', '0', 'electron_drift_time_gate', 'ONLINE', True), 'drift_velocity_liquid': ('cmt_run_id', '0', 'electron_drift_velocity', 'ONLINE', True), 'electron_lifetime_liquid': ('cmt_run_id', '0', 'elife', 'ONLINE', True)} | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary of fax parameter names (key) mapped to CMT config names (value)where the fax parameter values will be replaced by CMT |
| fax_file | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Directory with fax instructions |
| gain_model_mc | cmt://to_p...gin.run_id | cmt://to_pe_model?run_id=0&version=ONLINE | (raw_records, raw_records_he, raw_records_aqmon, truth) | PMT gain model. Specify as (model_type, model_config). |
| n_chunk | 10 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of chunks to simulate |
| n_top_pmts | <OMITTED> | 253 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in top array. Provided by context |
| n_tpc_pmts | <OMITTED> | 494 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in tpc. Provided by context |
| per_pmt_truth | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Store the info per channel in the truth file |
| right_raw_extension | 100000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| seed | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Option for setting the seed of the random number generator used forgeneration of the instructions |
truth
Description
Provided by plugin: RawRecordsFromFaxNT
Data kind: truth
(no plugin description)
Columns provided
| Field name | Data type | Comment |
|---|---|---|
| event_number | int32 | Waveform simulator event number. |
| type | int8 | Quanta type (S1 photons or S2 electrons) |
| time | int64 | Time of the interaction [ns] |
| x | float32 | X position of the cluster [cm] |
| y | float32 | Y position of the cluster [cm] |
| z | float32 | Z position of the cluster [cm] |
| amp | int32 | Number of quanta |
| recoil | int8 | Recoil type of interaction. |
| e_dep | float32 | Energy deposit of interaction |
| tot_e | float32 | Total energy deposit in the sensitive volume |
| g4id | int32 | Eventid like in geant4 output rootfile |
| vol_id | int32 | Volume id giving the detector subvolume |
| local_field | float64 | Local field [ V / cm ] |
| n_excitons | int32 | Number of excitons |
| x_pri | float32 | X position of the primary particle [cm] |
| y_pri | float32 | Y position of the primary particle [cm] |
| z_pri | float32 | Z position of the primary particle [cm] |
| endtime | int64 | End time of the interaction [ns] |
| n_electron | int32 | Number of simulated electrons |
| n_photon | int32 | Number of photons reaching PMT |
| n_pe | int32 | Number of photons + dpe passing |
| n_photon_trigger | int32 | Number of photons passing trigger |
| n_pe_trigger | int32 | Number of photons + dpe passing trigger |
| raw_area | float64 | Raw area in pe |
| raw_area_trigger | float64 | Raw area in pe passing trigger |
| n_photon_bottom | int32 | Number of photons reaching PMT (bottom) |
| n_pe_bottom | int32 | Number of photons + dpe passing (bottom) |
| n_photon_trigger_bottom | int32 | Number of photons passing trigger (bottom) |
| n_pe_trigger_bottom | int32 | Number of photons + dpe passing trigger (bottom) |
| raw_area_bottom | float64 | Raw area in pe (bottom) |
| raw_area_trigger_bottom | float64 | Raw area in pe passing trigger (bottom) |
| t_first_photon | float64 | Arrival time of the first photon [ns] |
| t_last_photon | float64 | Arrival time of the last photon [ns] |
| t_mean_photon | float64 | Mean time of the photons [ns] |
| t_sigma_photon | float64 | Standard deviation of photon arrival times [ns] |
| x_mean_electron | float32 | X field-distorted mean position of the electrons [cm] |
| y_mean_electron | float32 | Y field-distorted mean position of the electrons [cm] |
| t_first_electron | float64 | Arrival time of the first electron [ns] |
| t_last_electron | float64 | Arrival time of the last electron [ns] |
| t_mean_electron | float64 | Mean time of the electrons [ns] |
| t_sigma_electron | float64 | Standard deviation of electron arrival times [ns] |
Dependencies
Configuration options
These are all options that affect this data type. This also includes options taken by dependencies of this datatype, because changing any of those options affect this data indirectly.
| option | default | current | applies_to | help |
|---|---|---|---|---|
| channel_map | <OMITTED> | (tpc, he, aqmon, aqmon_nv, tpc_blank, mv, aux_mv, mv_blank, nveto, nveto_blank) | (raw_records, raw_records_he, raw_records_aqmon, truth) | immutabledict mapping subdetector to (min, max) channel number. Provided by context |
| chunk_size | 100 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Duration of each chunk in seconds |
| detector | XENONnT | XENONnT | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| event_rate | 1000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Average number of events per second |
| fax_config | fax_config_nt_design.json | fax_config_nt_design.json | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| fax_config_override | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary with configuration option overrides |
| fax_config_override_from_cmt | None | {'drift_time_gate': ('cmt_run_id', '0', 'electron_drift_time_gate', 'ONLINE', True), 'drift_velocity_liquid': ('cmt_run_id', '0', 'electron_drift_velocity', 'ONLINE', True), 'electron_lifetime_liquid': ('cmt_run_id', '0', 'elife', 'ONLINE', True)} | (raw_records, raw_records_he, raw_records_aqmon, truth) | Dictionary of fax parameter names (key) mapped to CMT config names (value)where the fax parameter values will be replaced by CMT |
| fax_file | None | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Directory with fax instructions |
| gain_model_mc | cmt://to_p...gin.run_id | cmt://to_pe_model?run_id=0&version=ONLINE | (raw_records, raw_records_he, raw_records_aqmon, truth) | PMT gain model. Specify as (model_type, model_config). |
| n_chunk | 10 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of chunks to simulate |
| n_top_pmts | <OMITTED> | 253 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in top array. Provided by context |
| n_tpc_pmts | <OMITTED> | 494 | (raw_records, raw_records_he, raw_records_aqmon, truth) | Number of pmts in tpc. Provided by context |
| per_pmt_truth | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Store the info per channel in the truth file |
| right_raw_extension | 100000 | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | |
| seed | False | <OMITTED> | (raw_records, raw_records_he, raw_records_aqmon, truth) | Option for setting the seed of the random number generator used forgeneration of the instructions |