#### Previous topic

scipy.ndimage.convolve1d

#### Next topic

scipy.ndimage.correlate1d

# scipy.ndimage.correlate

`scipy.ndimage.``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. Output array should have different name as compared to input array to avoid aliasing errors.

  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

  See also

  `convolve`
    Convolve an image with a kernel.