tidy3d.plugins.autograd.functions.morphological_gradient

tidy3d.plugins.autograd.functions.morphological_gradient#

class morphological_gradient[source]#

Bases:

Compute the morphological gradient of an array.

Parameters:

  • array (NDArray) – The input array to compute the morphological gradient of.

  • size (Union[Union[int, Tuple[int, int]], None], optional) – The size of the structuring element. If None, structure must be provided. Default is None.

  • structure (Union[NDArray, None], optional) – The structuring element. If None, size must be provided. Default is None.

  • mode (_pad_modes, optional) – The padding mode to use. Default is “reflect”.

  • maxval (float, optional) – Value to assume for infinite elements in the kernel. Default is 1e4.

Returns:

The morphological gradient of the input array.

Return type:

NDArray

Inherited Common Usage