scipy.ndimage.filters.correlate1d

scipy.ndimage.filters.correlate1d(input, weights, axis=-1, output=None, mode='reflect', cval=0.0, origin=0)

Calculate a one-dimensional correlation along the given axis.

The lines of the array along the given axis are correlated with the given weights.

Parameters :

input : array-like

input array to filter

weights : array

one-dimensional sequence of numbers

axis : integer, optional

axis of input along which to calculate. Default is -1

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 :