vlf4ions.detect_change_points

Created on Tue Aug 27 11:42:43 2024

@author: pteysseyre

Functions

detect_change_points(the_time, data, threshold)

Based on Guralnik, V.

find_break_point_realtime(the_time, data[, ...])

Based on the incremental algorithm presented by Guralnik & Srivastava (1999)
vlf4ions.detect_change_points.find_break_point_realtime(the_time, data, delta=0.1)[source]

Based on the incremental algorithm presented by Guralnik & Srivastava (1999)

Parameters:

  • the_time – time-array

  • data – the phase data that has just been read (time-averaged & smoothed if needed)

  • delta – in percent/100 (default : 0.1). This is the threshold over which we decide that a breakpoint is indeed a breakpoint and not due to noise. In Guralnik & Srivastava’s paper, this is also called delta and only appears for the incremental algorithm.

Returns:

  • detec: Boolean, ‘True’ if a breakpoint was detected, ‘False’ if not

  • p1: Slope of the detected breakpoint

vlf4ions.detect_change_points.detect_change_points(the_time, data, threshold)[source]

Based on Guralnik, V. & Srivastava, J. (1999) Detect change_points in the ‘data’ array in post_processing (bash algorithm)

Parameters:

  • the_time – time-array

  • data – Data array

  • threshold – Criterion used to end the search for breakpoints. (s in the article)

Returns:

change_points: time of breakpoints found in the data array