jax.scipy.signal.correlate2d¶

jax.scipy.signal.correlate2d(in1, in2, mode='full', boundary='fill', fillvalue=0, precision=None)[source]¶

Cross-correlate two 2-dimensional arrays.

LAX-backend implementation of correlate2d().

Original docstring below.

Cross correlate in1 and in2 with output size determined by mode, and boundary conditions determined by boundary and fillvalue.

Parameters
  • in1 (array_like) – First input.

  • in2 (array_like) – Second input. Should have the same number of dimensions as in1.

  • mode (str {'full', 'valid', 'same'}, optional) –

    A string indicating the size of the output:

    full

    The output is the full discrete linear cross-correlation of the inputs. (Default)

    valid

    The output consists only of those elements that do not rely on the zero-padding. In ‘valid’ mode, either in1 or in2 must be at least as large as the other in every dimension.

    same

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

  • boundary (str {'fill', 'wrap', 'symm'}, optional) –

    A flag indicating how to handle boundaries:

    fill

    pad input arrays with fillvalue. (default)

    wrap

    circular boundary conditions.

    symm

    symmetrical boundary conditions.

  • fillvalue (scalar, optional) – Value to fill pad input arrays with. Default is 0.

Returns

correlate2d – A 2-dimensional array containing a subset of the discrete linear cross-correlation of in1 with in2.

Return type

ndarray