convolve

diffsims.utils.fourier_transform.convolve(arr1, arr2, dx=None, axes=None)

Performs a centred convolution of input arrays

Parameters:

arr1, arr2numpy.ndarray

Arrays to be convolved. If dimensions are not equal then 1s are appended to the lower dimensional array. Otherwise, arrays must be broadcastable.

dxfloat > 0, list of float, or None , optional

Grid spacing of input arrays. Output is scaled by dx**max(arr1.ndim, arr2.ndim). default=`None` applies no scaling

axestuple of ints or None, optional

Choice of axes to convolve. default=`None` convolves all axes