tensorpac.methods.modulation_index¶
-
tensorpac.methods.
modulation_index
(pha, amp, n_bins=18)[source]¶ Tensor-based Modulation index (MI).
The modulation index is obtained using the Kullback Leibler Distance which measures how much the distribution of binned amplitude differs from a uniform distribution.
- Parameters
- pha, amparray_like
Respectively the arrays of phases of shape (n_pha, …, n_times) and the array of amplitudes of shape (n_amp, …, n_times).
- n_binsint | 18
Number of bins to binarize the amplitude according to phase intervals
- Returns
- pacarray_like
Array of phase amplitude coupling of shape (n_amp, n_pha, …)
References
Tort et al. 2010 [11]