tidy3d.plugins.autograd.functions.morphological_gradient_external

tidy3d.plugins.autograd.functions.morphological_gradient_external#

class morphological_gradient_external[source]#

Bases:

Compute the external morphological gradient of an array.

Parameters:

  • array (np.ndarray) – The input array to compute the external 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[np.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 external morphological gradient of the input array.

Return type:

np.ndarray

Inherited Common Usage