Eden-Kramer-Lab / spectral_connectivity

Frequency domain estimation and functional and directed connectivity analysis tools for electrophysiological data
GNU General Public License v3.0
121 stars 43 forks source link

Update connectivity.py to fix documentation of coherence_magnitude() #55

Closed bloniaszp closed 1 year ago

bloniaszp commented 1 year ago

Fix typo in coherence_magnitude() in connectivity.py. Originally, the file said that the modulus squared of coherency was not the magnitude squared coherence. However, I believe that's the definition (i.e., drop the complex component and normalize the real component to be bounded by 0 and 1). Provided citation as well for clarity, so folks can see the simplified equation.

coveralls commented 1 year ago

Coverage Status

Coverage: 73.176%. Remained the same when pulling 5a5e8e3ac1df4c2cd8cab111b61e5b3b5cd3a07e on bloniaszp:patch-1 into 548a1b975f3105984c649702290aeb9a217985c0 on Eden-Kramer-Lab:master.