pyccapt.calibration.tutorials.tutorials_helpers package

Submodules

pyccapt.calibration.tutorials.tutorials_helpers.helper_3d_reconstruction module

pyccapt.calibration.tutorials.tutorials_helpers.helper_3d_reconstruction.call_x_y_z_calculation(variables, flight_path_length, element_selected, colab=False)

pyccapt.calibration.tutorials.tutorials_helpers.helper_calibration module

pyccapt.calibration.tutorials.tutorials_helpers.helper_calibration.call_voltage_bowl_calibration(variables, det_diam, flight_path_length, pulse_mode, t0=0.0)

pyccapt.calibration.tutorials.tutorials_helpers.helper_data_loader module

pyccapt.calibration.tutorials.tutorials_helpers.helper_data_loader.add_columns(variables, max_mc)

pyccapt.calibration.tutorials.tutorials_helpers.helper_data_loader.load_calibrated_h5(dataset_path, variables, *, range_path=None, show_progress=True)

Load a PyCCAPT .h5 (or LEAP .RHIT) file for raw-data analysis.

Three file layouts are supported, dispatched by file extension:

1. Calibrated PyCCAPT bundle (.h5, preferred) — produced by data_tools.save_data(..., save_tdc=True, save_range=True). Contains /df (calibrated dld), and optionally /tdc (raw delay-line timestamps linked via event_group_id) and /range (identified ion windows).

2. Pure raw PyCCAPT acquisition (.h5) — the file as written by the control software: /dld and /tdc groups (no /df, no /range). The dld records are converted to the processed dataframe schema in memory, and the linked raw tdc rows are kept on variables.data_tdc.

3. LEAP CAMECA RHIT (.rhit) — a Cameca-LEAP ROOT bundle. Decoded via pyccapt.calibration.leap_tools.cameca_raw.rhit_load() and converted to the processed dataframe schema with rhit_to_ccapt(). RHIT files have no raw delay-line tdc data (the mass/charge and detector positions are already calibrated by the instrument), so variables.data_tdc is set to None and the downstream analyses that require /tdc (DLTS-per-pulse, combinatorial recovery) are skipped automatically.

Older datasets that store the range table in a separate <dataset>_range.h5 file are also supported via range_path.

Populates variables.data, variables.data_tdc, variables.range_data, and the standard backup fields.

pyccapt.calibration.tutorials.tutorials_helpers.helper_data_loader.load_data(dataset_path, max_mc, flightPathLength, pulse_mode, tdc, variables, processing_mode=True, load_tdc_raw=False)

Load a calibration dataset and stash it on variables.

Parameters:

load_tdc_raw (bool, default False) – If True and tdc == 'pyccapt', also load the raw /tdc group from the h5 file. The dld and tdc dataframes are linked via a shared event_group_id column so dld filtering decisions can later be propagated to tdc at save time. Stored on variables.data_tdc.

pyccapt.calibration.tutorials.tutorials_helpers.helper_ion_list module

pyccapt.calibration.tutorials.tutorials_helpers.helper_ion_list.call_ion_list(variables, selector, path='../../../files/')

pyccapt.calibration.tutorials.tutorials_helpers.helper_ion_list.reset_back_on_click(variables)

pyccapt.calibration.tutorials.tutorials_helpers.helper_ion_selection module

pyccapt.calibration.tutorials.tutorials_helpers.helper_ion_selection.call_ion_selection(variables, colab=False, show_gaussian_controls=False)

pyccapt.calibration.tutorials.tutorials_helpers.helper_mc_plot module

pyccapt.calibration.tutorials.tutorials_helpers.helper_mc_plot.call_mc_plot(variables, selector)

pyccapt.calibration.tutorials.tutorials_helpers.helper_special_crop module

pyccapt.calibration.tutorials.tutorials_helpers.helper_special_crop.apply_crop(variables, out, use_manual_values, center_x_widget, center_y_widget, radius_widget)

pyccapt.calibration.tutorials.tutorials_helpers.helper_special_crop.call_plot_crop_fdm(variables)

pyccapt.calibration.tutorials.tutorials_helpers.helper_special_crop.reset(variables, out)

pyccapt.calibration.tutorials.tutorials_helpers.helper_t_0_tune module

pyccapt.calibration.tutorials.tutorials_helpers.helper_t_0_tune.call_fine_tune_t_0(variables, flightPathLength, pulse_mode, t0)

pyccapt.calibration.tutorials.tutorials_helpers.helper_temporal_crop module

pyccapt.calibration.tutorials.tutorials_helpers.helper_temporal_crop.apply_crop(variables, out, use_manual_values, start_widget, end_widget)

pyccapt.calibration.tutorials.tutorials_helpers.helper_temporal_crop.call_plot_crop_experiment(variables, pulse_mode)

pyccapt.calibration.tutorials.tutorials_helpers.helper_temporal_crop.reset(variables, out)

pyccapt.calibration.tutorials.tutorials_helpers.helper_visualization module

pyccapt.calibration.tutorials.tutorials_helpers.helper_visualization.call_visualization(variables, colab=False)

Module contents

Shared helper functions used by calibration tutorial notebooks.