Typo in signal.ShortTimeFFR.spectrogram documentation

Contributor & Development Discussion scipy
1

I noticed a typo in the intro paragraph for the spectrogram method of the ShortTimeFFT class.

Currently, the documentation includes the sentence: “For two STFTs Sx[q,p], Sy[q,p] , the cross-spectrogram is defined as Sx[q,p] * np.conj(Sx[q,p]) and is complex-valued.”

I’m fairly certain this should instead say “Sx[q,p] * np.conj(Sy[q,p])” . I checked with the source code, and the cross-spectrogram is indeed implemented as Sx[q,p] * np.conj(Sy[q,p]).

Although this typo may not be a huge deal, it did cause me some confusion when I first encountered it, and I hope that fixing the typo will save others the same confusion.

1 Like
2

cc @DietBru

(Post must be at least 20 chars)

3

Thanks @colebarnett for taking the time to report this. A fix can be found in PR 21387.
Cheers, Dietrich