vlf4ions.read_files

Created on Wed Aug 21 11:47:33 2024

@author: pteysseyre

Functions

read_Narrowband_postprocessing(la_date, ...)

Reads the data for the station and the day asked and stores them in the output arrays Needs the path to the data files Reads the .mat files (already ended) Written by C.

read_Narrowband_real_time(station, path, ...)

Reads the data for the station and the day asked and stores them in the output arrays Reads the .mat files still being written Needs the path to the files Written by C.
vlf4ions.read_files.read_Narrowband_postprocessing(la_date, la_station, path, file_endings=['_100A', '_100B', '_101A', '_101B'])[source]

Reads the data for the station and the day asked and stores them in the output arrays Needs the path to the data files Reads the .mat files (already ended) Written by C. Briand on 16//10/2022 Converted to Python by P. Teysseyre on 18/03/2024

Parameters:

  • la_date – Date when the files need to be read (e.g. ‘2023_01_25’)

  • la_station – Transmitter call sign

  • path – path to the files

  • file_endings – List of string. Endings of the files for amp_NS, phase_NS, amp_EW and phase_EW in that order

Returns:

-amp_NS, amplitude in the N/S direction (in the unit of the file) - amp_EW, amplitude in the E/W direction - phase_NS, phase in the N/S direction - phase_EW, phase in the E/W direction - the_time: time-array (in UT)

vlf4ions.read_files.read_Narrowband_real_time(station, path, receiver, today)[source]

Reads the data for the station and the day asked and stores them in the output arrays Reads the .mat files still being written Needs the path to the files Written by C. Briand on 16//10/2022 Converted to Python on 18/03/2024

Parameters:

  • station – ‘station’ class instance

  • path – Path to the files being read

  • receiver – Receiver class instance

  • today – Datetime, time of the file reading

Returns:

-amp_NS, amplitude in the N/S direction (in pT) - amp_EW, amplitude in the E/W direction (in pT) - phase_NS, phase in the N/S direction (in °, not corrected) - phase_EW, phase in the E/W direction (in °, not corrected) - the_time: time-array (in UT) - nb_error: Number of reading error (for flagging)