Tensorpac
0.6.5
Install
API
Examples
Site
Installation
Requirements
Standard installation
Install the most up-to-date version
API
Compute phase-amplitude coupling
tensorpac.Pac
tensorpac.EventRelatedPac
tensorpac.PreferredPhase
Utility functions
tensorpac.utils.PSD
tensorpac.utils.ITC
tensorpac.utils.BinAmplitude
tensorpac.utils.PeakLockedTF
tensorpac.utils.pac_vec
tensorpac.utils.pac_trivec
Generate synthetic signals
tensorpac.signals.pac_signals_wavelet
tensorpac.signals.pac_signals_tort
Statistics
tensorpac.stats.test_stationarity
Individual methods
PAC methods
Tensor-based implementation
tensorpac.methods.mean_vector_length
tensorpac.methods.modulation_index
tensorpac.methods.heights_ratio
tensorpac.methods.norm_direct_pac
tensorpac.methods.phase_locking_value
tensorpac.methods.gauss_cop_pac
Numba-based implementation
tensorpac.methods.mean_vector_length_nb
tensorpac.methods.modulation_index_nb
tensorpac.methods.heights_ratio_nb
tensorpac.methods.norm_direct_pac_nb
tensorpac.methods.phase_locking_value_nb
Event Related PAC methods
tensorpac.methods.erpac
tensorpac.methods.ergcpac
Preferred phase
tensorpac.methods.preferred_phase
Surrogates methods
tensorpac.methods.swap_pha_amp
tensorpac.methods.swap_blocks
tensorpac.methods.time_lag
Normalization
tensorpac.methods.normalize
Examples
Tutorials
Phase-Amplitude Coupling tutorial on sEEG data
Download the data
Plot the raw data
Compute and plot Inter Trial Coherence
Compute and plot the Power Spectrum Density
Compute and plot the Event-Related PAC
Align time-frequency map based on alpha phase peak
Compute and compare PAC that is occurring during rest, planning and execution
Test if the alpha-gamma PAC is significant during motor planning
Binning gamma amplitude according to alpha phase
Identify the preferred phase
Phase-Amplitude coupling
README example
Comparison of the implemented PAC methods
Simulate artificial coupling
Extract phases and amplitudes
Compute, plot and compare PAC
Compare methods to correct PAC for spurious coupling
Simulate artificial coupling
Extract phases and amplitudes
Compute PAC and surrogates
Compare normalization types
Simulate artificial coupling
Extract phases and amplitudes
Recompute PAC and surrogates and switch the normalization types
Compare filtering properties
Long-range PAC
Event-Related Phase-Amplitude coupling
Event-Related Phase Amplitude Coupling
Generate a synthetic signal
Define an ERPAC object and extract the phase and the amplitude
Event-Related Phase Amplitude Coupling
Generate a synthetic signal
Define an ERPAC object and extract the phase and the amplitude
Compute the ERPAC using the two implemented methods and plot it
Statistics
Comparison of methods for correcting p-values for multiple comparisons
Simulate artificial coupling
Compute true PAC estimation and surrogates distribution
Identify stationary time-series using unit root test
Define a random dataset
Compute the statistical test
Plot each trial
Compute and plot the p-values
Simulate artificial coupling
Compute true PAC estimation and surrogates distribution
Compare PAC of two experimental conditions with cluster-based statistics
Simulate the data coming from two experimental conditions
Compute the single trial PAC on both datasets
Correct for multiple-comparisons using a cluster-based approach
Plot the significant clusters
Miscellaneous
Compute and plot the Power Spectrum Density (PSD)
Find the optimal bandwidth
Bin amplitude according to the phase
Align time-frequency representations according to phase peak
Simulate artificial coupling
Define the peak-locking object and realign TF representations
Plotting the realignment
Define frequency vectors
Compute and plot the Inter-Trial Coherence (ITC)
Generate a random data of shape (n_epochs, n_times)
Compute and plot the Power Spectrum Density (PSD)
Compute and plot the Inter-Trial Coherence (ITC)
Generate artificially coupled signals
Find the preferred phase (PP)
Generate synthetic signals (sake of illustration)
Extract phases, amplitudes and compute the preferred phase
Plot the preferred phase
Authors
Contributors
Cite Tensorpac
Community
Report an issue
Chat
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
M
|
N
|
P
|
S
|
T
|
W
|
X
|
Y
_
__init__() (tensorpac.EventRelatedPac method)
(tensorpac.Pac method)
(tensorpac.PreferredPhase method)
(tensorpac.utils.BinAmplitude method)
(tensorpac.utils.ITC method)
(tensorpac.utils.PeakLockedTF method)
(tensorpac.utils.PSD method)
A
amplitude() (tensorpac.utils.BinAmplitude property)
B
BinAmplitude (class in tensorpac.utils)
C
comodulogram() (tensorpac.Pac method)
cycle() (tensorpac.EventRelatedPac property)
(tensorpac.Pac property)
(tensorpac.PreferredPhase property)
(tensorpac.utils.BinAmplitude property)
(tensorpac.utils.ITC property)
(tensorpac.utils.PeakLockedTF property)
D
dcomplex() (tensorpac.EventRelatedPac property)
(tensorpac.Pac property)
(tensorpac.PreferredPhase property)
(tensorpac.utils.BinAmplitude property)
(tensorpac.utils.ITC property)
(tensorpac.utils.PeakLockedTF property)
E
ergcpac() (in module tensorpac.methods)
erpac() (in module tensorpac.methods)
(tensorpac.EventRelatedPac property)
EventRelatedPac (class in tensorpac)
F
f_amp() (tensorpac.EventRelatedPac property)
(tensorpac.Pac property)
(tensorpac.PreferredPhase property)
(tensorpac.utils.BinAmplitude property)
(tensorpac.utils.ITC property)
(tensorpac.utils.PeakLockedTF property)
f_pha() (tensorpac.EventRelatedPac property)
(tensorpac.Pac property)
(tensorpac.PreferredPhase property)
(tensorpac.utils.BinAmplitude property)
(tensorpac.utils.ITC property)
(tensorpac.utils.PeakLockedTF property)
filter() (tensorpac.EventRelatedPac method)
(tensorpac.Pac method)
(tensorpac.PreferredPhase method)
(tensorpac.utils.BinAmplitude method)
(tensorpac.utils.ITC method)
(tensorpac.utils.PeakLockedTF method)
filterfit() (tensorpac.EventRelatedPac method)
(tensorpac.Pac method)
(tensorpac.PreferredPhase method)
fit() (tensorpac.EventRelatedPac method)
(tensorpac.Pac method)
(tensorpac.PreferredPhase method)
freqs() (tensorpac.utils.PSD property)
G
gauss_cop_pac() (in module tensorpac.methods)
H
heights_ratio() (in module tensorpac.methods)
heights_ratio_nb() (in module tensorpac.methods)
I
idpac() (tensorpac.Pac property)
infer_pvalues() (tensorpac.EventRelatedPac method)
(tensorpac.Pac method)
ITC (class in tensorpac.utils)
itc() (tensorpac.utils.ITC property)
M
mean_vector_length() (in module tensorpac.methods)
mean_vector_length_nb() (in module tensorpac.methods)
modulation_index() (in module tensorpac.methods)
modulation_index_nb() (in module tensorpac.methods)
N
norm_direct_pac() (in module tensorpac.methods)
norm_direct_pac_nb() (in module tensorpac.methods)
normalize() (in module tensorpac.methods)
P
Pac (class in tensorpac)
pac() (tensorpac.Pac property)
pac_signals_tort() (in module tensorpac.signals)
pac_signals_wavelet() (in module tensorpac.signals)
pac_trivec() (in module tensorpac.utils)
pac_vec() (in module tensorpac.utils)
pacplot() (tensorpac.EventRelatedPac method)
(tensorpac.Pac method)
(tensorpac.PreferredPhase method)
(tensorpac.utils.ITC method)
(tensorpac.utils.PeakLockedTF method)
PeakLockedTF (class in tensorpac.utils)
phase() (tensorpac.utils.BinAmplitude property)
phase_locking_value() (in module tensorpac.methods)
phase_locking_value_nb() (in module tensorpac.methods)
plot() (tensorpac.utils.BinAmplitude method)
(tensorpac.utils.ITC method)
(tensorpac.utils.PeakLockedTF method)
(tensorpac.utils.PSD method)
plot_st_psd() (tensorpac.utils.PSD method)
polar() (tensorpac.PreferredPhase method)
preferred_phase() (in module tensorpac.methods)
PreferredPhase (class in tensorpac)
PSD (class in tensorpac.utils)
psd() (tensorpac.utils.PSD property)
pvalues() (tensorpac.EventRelatedPac property)
(tensorpac.Pac property)
S
savefig() (tensorpac.EventRelatedPac method)
(tensorpac.Pac method)
(tensorpac.PreferredPhase method)
(tensorpac.utils.ITC method)
(tensorpac.utils.PeakLockedTF method)
show() (tensorpac.EventRelatedPac method)
(tensorpac.Pac method)
(tensorpac.PreferredPhase method)
(tensorpac.utils.BinAmplitude method)
(tensorpac.utils.ITC method)
(tensorpac.utils.PeakLockedTF method)
(tensorpac.utils.PSD method)
surrogates() (tensorpac.EventRelatedPac property)
(tensorpac.Pac property)
swap_blocks() (in module tensorpac.methods)
swap_pha_amp() (in module tensorpac.methods)
T
test_stationarity() (in module tensorpac.stats)
time_lag() (in module tensorpac.methods)
triplot() (tensorpac.Pac method)
W
width() (tensorpac.EventRelatedPac property)
(tensorpac.Pac property)
(tensorpac.PreferredPhase property)
(tensorpac.utils.BinAmplitude property)
(tensorpac.utils.ITC property)
(tensorpac.utils.PeakLockedTF property)
X
xvec() (tensorpac.EventRelatedPac property)
(tensorpac.Pac property)
(tensorpac.PreferredPhase property)
(tensorpac.utils.BinAmplitude property)
(tensorpac.utils.ITC property)
(tensorpac.utils.PeakLockedTF property)
Y
yvec() (tensorpac.EventRelatedPac property)
(tensorpac.Pac property)
(tensorpac.PreferredPhase property)
(tensorpac.utils.BinAmplitude property)
(tensorpac.utils.ITC property)
(tensorpac.utils.PeakLockedTF property)