Skip to content

Commit

Permalink
Merge pull request #55 from bloniaszp/patch-1
Browse files Browse the repository at this point in the history
Update connectivity.py to fix documentation of coherence_magnitude()
  • Loading branch information
edeno committed May 8, 2023
2 parents 548a1b9 + 5a5e8e3 commit f0f178d
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions spectral_connectivity/connectivity.py
Original file line number Diff line number Diff line change
Expand Up @@ -325,9 +325,15 @@ def coherence_phase(self):

@_asnumpy
def coherence_magnitude(self):
"""The magnitude of the complex coherency.
Note that this is not the magnitude squared coherence.
"""The magnitude squared of the complex coherency. Note that the
squared modulus of coherency (originally a complex quantity) is the
magnitude-squared coherence (i.e., the normalized, real component of coherency).
This value should bounded by 0 and 1.
Hansson-Sandsten M (2011) Cross-spectrum and coherence function
estimation using time-delayed Thomson multitapers. In: 2011 IEEE
International Conference on Acoustics, Speech and Signal
Processing (ICASSP), pp 4240–4243.
Returns
-------
Expand Down

0 comments on commit f0f178d

Please sign in to comment.