Skip to content

Commit

Permalink
Add note that the PLI is the signed version, not the unsigned version…
Browse files Browse the repository at this point in the history
…. This closes issue #14.
  • Loading branch information
edeno committed Jul 1, 2020
1 parent d8f07de commit dd98b18
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions spectral_connectivity/connectivity.py
Original file line number Diff line number Diff line change
Expand Up @@ -351,6 +351,11 @@ def phase_lag_index(self):
in-phase or anti-phase signals to zero and the sign scales it to
have the same magnitude regardless of phase.
Note that this is the signed version of the phase lag index. In order
to obtain the unsigned version, as in [1], take the absolute value
of this quantity.
Returns
-------
phase_lag_index : array, shape (..., n_fft_samples, n_signals,
Expand Down

0 comments on commit dd98b18

Please sign in to comment.