This is documentation for an old release of SciPy (version 0.12.0). Read this page Search for this page in the documentation of the latest stable release (version 1.15.1).

scipy.signal.convolve

scipy.signal.convolve(in1, in2, mode='full')

Convolve two N-dimensional arrays.

Convolve in1 and in2, with the output size determined by the mode argument.

Parameters :

in1 : array_like

First input.

in2 : array_like

Second input. Should have the same number of dimensions as in1; if sizes of in1 and in2 are not equal then in1 has to be the larger array.

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.

same

The output is the same size as in1, centered with respect to the ‘full’ output.

Returns :

convolve : array

An N-dimensional array containing a subset of the discrete linear convolution of in1 with in2.