phase_amplitude_coupling

phase_amplitude_coupling#

class braintools.metric.phase_amplitude_coupling(lfp, dt, phase_freq_range=(4, 8), amplitude_freq_range=(30, 100), n_bins=18)#

Compute phase-amplitude coupling (PAC) using the modulation index.

Parameters:
  • lfp (Array | ndarray | bool | number | bool | int | float | complex | Quantity) – LFP signal with shape (n_time,).

  • dt (float) – Sampling interval in seconds.

  • phase_freq_range (tuple) – Frequency range for phase extraction (low frequency, e.g., theta).

  • amplitude_freq_range (tuple) – Frequency range for amplitude extraction (high frequency, e.g., gamma).

  • n_bins (int) – Number of phase bins for analysis.

Return type:

tuple

Returns:

  • modulation_index (float) – Normalized entropy-based modulation index.

  • phase_bins (jax.Array) – Phase bin centers.

  • mean_amplitudes (jax.Array) – Mean amplitude in each phase bin.