jax.scipy.signal.fftconvolve#
- jax.scipy.signal.fftconvolve(in1, in2, mode='full', axes=None)[source]#
Convolve two N-dimensional arrays using FFT.
LAX-backend implementation of
scipy.signal._signaltools.fftconvolve()
.Original docstring below.
Convolve in1 and in2 using the fast Fourier transform method, with the output size determined by the mode argument.
This is generally much faster than convolve for large arrays (n > ~500), but can be slower when only a few output values are needed, and can only output float arrays (int or object array inputs will be cast to float).
As of v0.19, convolve automatically chooses this method or the direct method based on an estimation of which is faster.
- Parameters:
in1 (array_like) – First input.
in2 (array_like) – Second input. Should have the same number of dimensions as in1.
mode (str {'full', 'valid', 'same'}, optional) –
A string indicating the size of the output:
full
The output is the full discrete linear convolution of the inputs. (Default)
valid
The output consists only of those elements that do not rely on the zero-padding. In ‘valid’ mode, either in1 or in2 must be at least as large as the other in every dimension.
same
The output is the same size as in1, centered with respect to the ‘full’ output.
axes (int or array_like of ints or None, optional) – Axes over which to compute the convolution. The default is over all axes.
- Returns:
out – An N-dimensional array containing a subset of the discrete linear convolution of in1 with in2.
- Return type:
array