ffrprep.analysis.compute_phase_consistency

ffrprep.analysis.compute_phase_consistency(epochs_A, epochs_B, chunksize=0.04, overlap=0.036, freqcap=2000)[source]

Compute phase consistency from FFR epochs.

The function computes phase consistency for: - Polarity A (from epochs_A) - Polarity B (from epochs_B) - ADD polarity: (A + B) / 2 (computed from phase vectors) - SUB polarity: (A - B) / 2 (computed from phase vectors)

Parameters:

  • epochs_A (mne.Epochs) – Individual epochs for polarity A

  • epochs_B (mne.Epochs) – Individual epochs for polarity B

  • chunksize (float) – Analysis window size in seconds (default: 0.04 = 40 ms)

  • overlap (float) – Window overlap in seconds (default: 0.036 = 36 ms, gives ~4 ms step)

  • freqcap (int) – Maximum frequency in Hz (default: 2000)

Returns:

  • phasecon (dict) – Dictionary with keys ‘A’, ‘B’, ‘add’, ‘sub’ and phase consistency arrays (freq x time) as values

  • xaxis (ndarray) – Time axis in milliseconds

  • yaxis (ndarray) – Frequency axis in Hz

  • numsweeps (int) – Number of sweeps used (minimum of A and B)

Examples

>>> phasecon, xaxis, yaxis, numsweeps = compute_phase_consistency_minimal(
...     epochs_A, epochs_B, chunksize=0.04, overlap=0.036
... )
>>>
>>> # Plot
>>> plot_phase_consistency(phasecon, xaxis, yaxis)