metpyrad.Hidex300.analyze_readings#

Hidex300.analyze_readings(input_folder, time_unit, save=False, output_folder=None)#

Processes readings from the input folder, prints a summary, and optionally saves the results.

Parameters:
  • input_folder (str) – Path to the folder containing the CSV files with readings.

  • time_unit (str) – The unit of time for the measurements.

  • save (bool) – If True, saves the results to the specified output folder. Default is False.

  • output_folder (str or None) – Path to the folder where the results will be saved. Required if save is True.

Raises:

ValueError – If save is True and output_folder is not provided.

Examples

>>> inp_dir='/path/to/input/folder'
>>> out_dir='/path/to/output/folder'
>>> processor = Hidex300('Lu-177', 2023, 11)
>>> processor.analyze_readings(input_folder=inp_dir, time_unit='s', save=True, output_folder=out_dir)
Processing readings from /path/to/input/folder.
Found 2 CSV files in folder /path/to/input/folder
Measurements summary:
Measurements of Lu-177 on November 2023
Summary
Number of cycles: 2
Repetitions per cycle: 2
Time per repetition: 100 s
Total number of measurements: 4
Total measurement time: 400 s
Cycles summary
   Cycle  Repetitions  Real time (s)                Date
0      1            2            100 2023-11-30 08:44:20
1      2            2            100 2023-12-01 12:46:16
Saving measurement files to folder /path/to/input/folder/Lu-177_2023_11.
Saving CSV files
Readings measurements CSV saved to "/path/to/input/folder/Lu-177_2023_11" folder.
Background measurements CSV saved to "/path/to/input/folder/Lu-177_2023_11" folder.
Sample measurements CSV saved to "/path/to/input/folder/Lu-177_2023_11" folder.
Net measurements CSV saved to "/path/to/input/folder/Lu-177_2023_11" folder.
All measurements CSV saved to "/path/to/input/folder/Lu-177_2023_11" folder.
Summary saved to /path/to/input/folder/Lu-177_2023_11/summary.txt
Saving figures
Background measurements PNG saved to "/path/to/input/folder/Lu-177_2023_11" folder.
Sample measurements PNG saved to "/path/to/input/folder/Lu-177_2023_11" folder.
Net measurements PNG saved to "/path/to/input/folder/Lu-177_2023_11" folder.