This is documentation for an old release of SciPy (version 0.10.1). 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 output size determined by mode.

Parameters :

in1: array :

first input.

in2: array :

second input. Should have the same number of dimensions as in1.

mode: str {‘valid’, ‘same’, ‘full’} :

a string indicating the size of the output:

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.

full : the output is the full discrete linear cross-correlation

of the inputs. (Default)

Returns :

out: array :

an N-dimensional array containing a subset of the discrete linear cross-correlation of in1 with in2.