Using Mr Mustard

Development

Mr Mustard API

  1. Docs
  2. mrmustard.math
  3. sf.math.convolution
  4. Show on GitHub

sf.math.convolution

math.convolution(filters, padding=None, data_format='NWC')

Performs a convolution on array with filters.

Parameters:

  • array (ndarray[Tuple[int, ...], Union[TypeVar(R, float16, float32, float64), TypeVar(C, complex64, complex128), TypeVar(Z, int16, int32, int64), TypeVar(N, uint16, uint32, uint64)]]) – The array to convolve.

  • filters (ndarray[Tuple[int, ...], Union[TypeVar(R, float16, float32, float64), TypeVar(C, complex64, complex128), TypeVar(Z, int16, int32, int64), TypeVar(N, uint16, uint32, uint64)]]) – The filters to convolve with.

  • padding (Optional[str]) – The padding mode.

  • data_format – The data format of the array.

Return type:

ndarray[Tuple[int, ...], Union[TypeVar(R, float16, float32, float64), TypeVar(C, complex64, complex128), TypeVar(Z, int16, int32, int64), TypeVar(N, uint16, uint32, uint64)]]

Returns:

The convolved array.

Previous
Next