tidy3d.plugins.autograd.invdes.CircularFilter

tidy3d.plugins.autograd.invdes.CircularFilter#

class CircularFilter[source]#

Bases: AbstractFilter

A circular filter for creating and applying convolution filters.

Parameters:

  • attrs (dict = {}) – Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, attrs are mutable. For example, the following is allowed for setting an attr obj.attrs['foo'] = bar. Also note that Tidy3D` will raise a TypeError if attrs contain objects that can not be serialized. One can check if attrs are serializable by calling obj.json().

  • kernel_size (Union[PositiveInt, tuple[pydantic.v1.types.PositiveInt, ...]]) – Size of the kernel in pixels for each dimension.

  • normalize (bool = True) – Whether to normalize the kernel so that it sums to 1.

  • padding (Literal['constant', 'edge', 'reflect', 'symmetric', 'wrap'] = reflect) – The padding mode to use.

Attributes

attrs

Methods

get_kernel(size_px, normalize)

Get the circular kernel.

Inherited Common Usage

static get_kernel(size_px, normalize)[source]#

Get the circular kernel.

See also

get_kernel()

__hash__()#

Hash method.