scipy.ndimage.filters.correlate¶

scipy.ndimage.filters.correlate(input, weights, output=None, mode='reflect', cval=0.0, origin=0)¶

Multi-dimensional correlation.

The array is correlated with the given kernel.

Parameters :

input : array-like

input array to filter

weights : ndarray

array of weights, same number of dimensions as input

output : array, optional

The output parameter passes an array in which to store the filter output.

mode : {‘reflect’,’constant’,’nearest’,’mirror’, ‘wrap’}, optional

The mode parameter determines how the array borders are handled, where cval is the value when mode is equal to ‘constant’. Default is ‘reflect’

cval : scalar, optional

Value to fill past edges of input if mode is ‘constant’. Default is 0.0

origin : scalar, optional

The origin parameter controls the placement of the filter. Default 0