tidy3d.plugins.autograd.functions.grey_erosion

Contents

tidy3d.plugins.autograd.functions.grey_erosion#

class grey_erosion[source]#

Bases:

Perform grey erosion on an array.

Parameters:

  • array (np.ndarray) – The input array to perform grey dilation on.

  • 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 result of the grey dilation operation.

Return type:

np.ndarray

Raises:

ValueError – If both size and structure are None.

Inherited Common Usage