tensorpac.utils.pac_vec¶
-
tensorpac.utils.
pac_vec
(f_pha='mres', f_amp='mres')[source]¶ Generate cross-frequency coupling vectors.
- Parameters
- Frequency vector for the phase and amplitude. Here you can use
- several forms to define those vectors :
Basic list/tuple (ex: [2, 4] or [8, 12]…)
List of frequency bands (ex: [[2, 4], [5, 7]]…)
Dynamic definition : (start, stop, width, step)
Range definition (ex : np.arange(3) => [[0, 1], [1, 2]])
Using a string. f_pha and f_amp can be ‘lres’, ‘mres’, ‘hres’ respectively for low, middle and high resolution vectors. In that case, it uses the definition proposed by Bahramisharif et al. 2013 [2] i.e f_pha = [f - f / 4, f + f / 4] and f_amp = [f - f / 8, f + f / 8]
- Returns
- f_pha, f_amparray_like
Arrays containing the pairs of phase and amplitude frequencies. Each vector have a shape of (N, 2).