We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 48ca157 commit 7c0569cCopy full SHA for 7c0569c
pysteps/utils/fft.py
@@ -20,7 +20,22 @@
20
scipy_fft.irfft2 = numpy_fft.irfft2
21
22
def get_method(name):
23
- """Return a callable function for the FFT method corresponding to the given name."""
+ """Return a callable function for the FFT method corresponding to the given
24
+ name.
25
+
26
+ Parameters
27
+ ----------
28
+ name : str
29
+ The name of the method. The available options are 'numpy', 'scipy' and
30
+ 'pyfftw'
31
32
+ Returns
33
+ -------
34
+ out : tuple
35
+ A two-element tuple containing the FFT module and a dictionary of
36
+ default keyword arguments for calling the FFT method. Each module
37
+ implements the numpy.fft interface.
38
+ """
39
if name == "numpy":
40
return numpy_fft,{}
41
elif name == "scipy":
0 commit comments