vlf4ions.correct_phase

Created on Wed Aug 21 10:29:16 2024

@author: pteysseyre

Functions

compute_df(date_inf, date_sup, station, ...)	Compute the value of df for a specific station over a specified time period
correctionphase(station, phase, the_time)	Completely corrects the phase in real time the phase so that all phase jumps from -180° to 180° are corrected, and the phase detrended
correctionphaseparDw(station, phase, the_time)	Corrects the phase by compensating for the phase detrend induced by the transmitter frequency not being exactly stable
unwrap_moco(Data_In, UnwrapNumber)	Originally written by M.

vlf4ions.correct_phase.correctionphase(station, phase, the_time)

Completely corrects the phase in real time the phase so that all phase jumps from -180° to 180° are corrected, and the phase detrended

Parameters:

• station – station class instance

• phase – phase data (in °)

• the_time – time-array in UT (or at least in hr)

Returns:

phase_corr, corrected phase data

vlf4ions.correct_phase.unwrap_moco(Data_In, UnwrapNumber)

Originally written by M. Cohen in Matlab. Unwraps ‘Data_in’, by compensating any jumps more than UnwrapNumer/2

Parameters:

• Data_In – Data to unwrap

• UnwrapNumber – Value of the jumps to compensate

Returns:

Unwrapped data and position of the jumps

vlf4ions.correct_phase.correctionphaseparDw(station, phase, the_time)

Corrects the phase by compensating for the phase detrend induced by the transmitter frequency not being exactly stable

Parameters:

• station – station class instance

• phase – phase data array (in °)

• the_time – time-array (in hr or UT)

Returns:

phase_corr (unwrapped and detrended phase) and jumps (position of the 90° jumps)

vlf4ions.correct_phase.compute_df(date_inf, date_sup, station, path_to_files, file_endings, epsilon)

Compute the value of df for a specific station over a specified time period

Parameters:

• date_inf – Datetime object, date from which we want to compute df

• date_sup – Datetime object, date before which we want to compute df

• station – Station class instance

• path_to_files – Path to the data files

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

• epsilon – Maximum phase jump (in °) that we accept in average from one day to the next

Returns:

df value for the station