Skip to content

Commit 81aced7

Browse files
committed
Update docstring for Fourier frequencies
1 parent d5b8d15 commit 81aced7

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

pysteps/utils/spectral.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,16 @@ def rapsd(Z, fft_method=None, return_freq=False, **fft_kwargs):
1717
scipy.fftpack. If set to None, Z is assumed to represent the shifted
1818
discrete Fourier transform of the input field, where the origin is at
1919
the center of the array (see numpy.fft.fftshift or scipy.fftpack.fftshift).
20+
return_freq: bool
21+
Whether to also return the Fourier frequencies.
2022
2123
Returns
2224
-------
2325
out : ndarray
2426
One-dimensional array containing the RAPSD. The length of the array is
2527
int(L/2)+1 (if L is even) or int(L/2) (if L is odd), where L=max(M,N).
28+
freq : ndarray
29+
One-dimensional array containing the Fourier frequencies.
2630
2731
References
2832
----------

0 commit comments

Comments
 (0)