vlf4ions.flag

Created on Wed Aug 21 10:44:38 2024

@author: pteysseyre

Functions

flags(amp, previous_nb_points, today, ...)

Flags 1 if the antenna is down, 2 if the transmitter is down, 3 if it is nighttime
vlf4ions.flag.flags(amp, previous_nb_points, today, this_station, this_receiver, phase)[source]

Flags 1 if the antenna is down, 2 if the transmitter is down, 3 if it is nighttime

Parameters:

  • amp – Amplitude (pT)

  • previous_nb_points – Number of points read last time

  • today – Datetime, instant of file reading. Must be timezone-aware

  • this_station – station class instance

  • this_receiver – receiver class instance

  • phase – Phase, before any filtering

Returns:

  • flag: flag indicating the state of the transmitter/receiver

  • length_data: number of points read this time

  • data_last_min: median total amplitude over the last minute