scattered_light

gwas_tools.algorithms.scattered_light.scattered_light(gps, seconds, target_channel_name, channels_file, out_path, f_lowpass, event='center', fs=256, n_scattering=1, smooth_win=50, max_imf=1, bwr=0.1, bsp=26, norm_imfs=True, combos=False, seismic=False, save_data=True, check_lock=False)

Analysis for scattered light identification. The script outputs a folder named as the input gps, with inside three files:

• target channel instantaneous amplitudes (.imf, optional)

• most correlated predictor for each imf (.predictors, optional)

• output.yml, a summary of the analysis’ results

Parameters:

• gps (int) – gps of the event

• seconds (int) – how many seconds to analyze in total

• target_channel_name (str) – target channel name

• channels_file (str) – channels list or single channel name

• out_path (str) – output path where to save results

• f_lowpass (float or str) – lowpass filter frequency

• event (str) – position of the event’s gps in the analysed period. Can be start, center, or end (default : center)

• fs (float, optional) – channels resample frequency (default : 256)

• n_scattering (int, optional) – number of signal bounces (default : 1)

• smooth_win (int, optional) – signals smoothing window (default : 50)

• max_imf (int, optional) – maximum number of imfs to extract (default : 1)

• bwr (float) – instantaneous bandwidth threshold for imfs extraction (default : 0.1)

• bsp (int) – b-spline order for imfs extraction (default : 26)

• norm_imfs (bool) – if to normalize imfs (default : True)

• combos (bool, optional) – if True, combos are computed (default : False)

• seismic (bool, optional) – if True, seismic channels data are saved to output file (default : False)

• save_data (bool, optional) – if True, instantaneous amplitudes and predictors are saved to file (defaults : True)

• check_lock (bool, optional) – if True, lock channel status is checked, and if it is not always locked, the analysis is not performed (default : False)