tidy3d.components.parameter_perturbation.AbstractPerturbation#
- class AbstractPerturbation[source]#
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 anattr
obj.attrs['foo'] = bar
. Also note that Tidy3D` will raise aTypeError
ifattrs
contain objects that can not be serialized. One can check ifattrs
are serializable by callingobj.json()
.
Attributes
Whether perturbation is complex valued.
Perturbation range.
Methods
Inherited Common Usage
- abstract property perturbation_range#
Perturbation range.
- abstract property is_complex#
Whether perturbation is complex valued.
- __hash__()#
Hash method.