mne_hfo.utils.apply_hilbert#

mne_hfo.utils.apply_hilbert(metric, threshold_dict, kwargs)[source]#

Apply the Hilbert z-score thresholding scheme.

Parameters:
metricnp.ndarray

The values to apply the threshold rules to.

threshold_dictdict

Dictionary of threshold parameters to apply to metric. Must have zscore, gap, and cycles keys.

kwargsdict

Additional model parameters needed to apply hilbert threshold. Must have n_times, sfreq, filter_band, freq_cutoffs, freq_span, and n_jobs.

Returns:
tdetectsList of Tuple

Detected hfo events with the structure [band_idx, start, stop, max_amplitude, freq_band].