cogpy.measures.pac

Phase-amplitude coupling (PAC) measures.

STATUS: ACTIVE Reason: PAC modulation index, preferred phase, comodulogram, and surrogate

testing for pixecog coupling analysis (H3, H6).

Superseded by: n/a Safe to remove: no

All functions are pure — numpy in, numpy out. No file I/O. Accepts either raw continuous signals (phase/amplitude extracted internally via Hilbert transform) or pre-computed phase/amplitude arrays.

- Tort modulation index (Tort et al., 2010)
- Ozkurt modulation index (Ozkurt & Schnitzler, 2011)
- Canolty mean vector length (Canolty et al., 2006)

References

Tort et al. (2010) J Neurophysiol, Ozkurt & Schnitzler (2011) J Neurosci Methods, Canolty et al. (2006) Science, Cairney et al. (2018), Stokes et al. (2023).

Functions

comodulogram(signal, freq_phase_range, ...)

Frequency x frequency PAC comodulogram.

modulation_index(phase_signal, amp_signal, *)

Compute phase-amplitude coupling modulation index.

preferred_phase(phase_signal, amp_signal)

Preferred coupling phase and mean vector length.

surrogate_pac(phase_signal, amp_signal, *[, ...])

Surrogate testing for phase-amplitude coupling significance.