Skip to content

Commit d93f582

Browse files
Ramdam17claude
andcommitted
fix(docs): correct citations for coh and ccorr metrics
- coh: replace incorrectly cited Nolte 2004 (about ImCoh) with the actual reference used in Coh class: Nunez & Srinivasan (2006) - ccorr: replace Berens 2009 (MATLAB toolbox) with the original statistical reference used in CCorr class: Fisher (1995) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 09a5ee2 commit d93f582

2 files changed

Lines changed: 6 additions & 8 deletions

File tree

hypyp/analyses.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -490,14 +490,14 @@ def compute_sync(complex_signal: np.ndarray, mode: str, epochs_average: bool = T
490490
Lachaux et al. (1999). *Human Brain Mapping*, 8(4), 194–208.
491491
'ccorr' : Circular Correlation
492492
Circular analogue of Pearson r using global circular mean centering.
493-
Berens (2009). *Journal of Statistical Software*, 31(10), 1–21.
493+
Fisher, N. I. (1995). *Statistical analysis of circular data*. Cambridge University Press.
494494
'accorr' : Adjusted Circular Correlation
495495
Same as ccorr but with per-pair phase centering for improved accuracy.
496496
Supports ``optimization`` parameter (numba / torch).
497497
Zimmermann et al. (2024). *Imaging Neuroscience*, 2.
498498
'coh' : Coherence
499499
``Coh = |⟨S₁₂⟩|² / (⟨|S₁|²⟩·⟨|S₂|²⟩)`` — ranges [0, 1].
500-
Nolte et al. (2004). *Clinical Neurophysiology*, 115(10), 2292–2307.
500+
Nunez, P. L., & Srinivasan, R. (2006). *Electric fields of the brain*. Oxford University Press.
501501
'imaginary_coh' / 'imcoh' : Imaginary Coherence
502502
``Im(⟨S₁₂⟩) / √(⟨|S₁|²⟩·⟨|S₂|²⟩)`` — volume-conduction resistant.
503503
Nolte et al. (2004). *Clinical Neurophysiology*, 115(10), 2292–2307.

hypyp/sync/README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,8 @@ CCorr = Σ sin(α₁ − ᾱ₁) · sin(α₂ − ᾱ₂)
3434
```
3535
where `` is the circular mean of `α`.
3636

37-
**Reference:** Berens, P. (2009). CircStat: A MATLAB toolbox for circular statistics.
38-
*Journal of Statistical Software*, 31(10), 1–21.
39-
https://doi.org/10.18637/jss.v031.i10
37+
**Reference:** Fisher, N. I. (1995). *Statistical analysis of circular data*.
38+
Cambridge University Press.
4039

4140
---
4241

@@ -76,9 +75,8 @@ where `S₁₂(f)` is the cross-spectrum.
7675

7776
Ranges from 0 to 1. Sensitive to volume conduction.
7877

79-
**Reference:** Nolte, G., et al. (2004). Identifying true brain interaction from EEG
80-
data using the imaginary part of coherency. *Clinical Neurophysiology*, 115(10), 2292–2307.
81-
https://doi.org/10.1016/j.clinph.2004.04.029
78+
**Reference:** Nunez, P. L., & Srinivasan, R. (2006). *Electric fields of the brain:
79+
the neurophysics of EEG*. Oxford University Press.
8280

8381
---
8482

0 commit comments

Comments
 (0)