vlf4ions.analyse_change_points

Created on Fri Feb 7 14:28:49 2025

@author: pteysseyre

Functions

analyse_breakpoint(current_time, current_p1, ...)

This is the part of the code that will decide if the breakpoint is a flare signature or not.
vlf4ions.analyse_change_points.analyse_breakpoint(current_time, current_p1, amp, phase, the_time, quiet, quiet_phase, quiet_amp, last_time, last_p1, detection_threshold, quiet_p1, quiet_breakpoint, this_receiver)[source]

This is the part of the code that will decide if the breakpoint is a flare signature or not.

Several cases can occur:

  1. This is the beginning of a flare.

  2. This is a flare maximum

  3. This is a quiet point: this is either a slight positive slope, a negative slope after a quiet breakpoint, or a negative slope after a flare has decayed by more than half of its increase

  4. This is a flare decay, with a negative slope and the phase has not gone down by more than half of its increase.

Parameters:

  • current_time – Time (in UT) of the last data reading

  • current_p1 – Slope of the new breakpoints

  • amp – median amplitude measured over the last minute

  • phase – phase data, since the beginning of the file or for the last two hours

  • the_time – time-array, must match the one for phase

  • quiet – status of the last breakpoint. If quiet==1, the last breakpoint was a quiet one, if not it was a flare time

  • quiet_phase – phase at the last quiet breakpoint

  • quiet_amp – amplitude at the last quiet breakpoint

  • last_time – time of the last breakpoint OR two hours before if the last breakpoint was too long ago

  • last_p1 – Last breakpoint slope

  • detection_threshold – attribute of the station class, slope above which we consider that it is flare time

  • quiet_p1 – slope of the last quiet breakpoint

  • quiet_breakpoint – time of the last quiet breakpoint

  • this_receiver – Receiver class instance

Returns:

  • quiet_now (is 1 if the new breakpoint is considered to be quiet)

  • prev_timedecay which is the predicted time to decay (in UT)

  • DP_now (increase of phase (in °), compared to what the value of the phase should have been)

  • DA (value of the amplitude increase compared to last quiet amp)

History:

  • Written in February 2025

  • Revised in June 2025 to change the way DP was computed