tidy3d.components.parameter_perturbation.AbstractPerturbation

class AbstractPerturbation

Bases: ABC, Tidy3dBaseModel

Abstract class for a generic perturbation.

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().

Attributes

is_complex	Whether perturbation is complex valued.
perturbation_range	Perturbation range.
attrs

Methods

Inherited Common Usage

abstract property perturbation_range

Perturbation range.

abstract property is_complex

Whether perturbation is complex valued.

__hash__()

Hash method.