tidy3d.ModulationSpec

class ModulationSpec

Specification adding space-time modulation to the non-dispersive part of medium including relative permittivity at infinite frequency and electric conductivity.

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

• permittivity (Optional[SpaceTimeModulation] = None) – Space-time modulation of relative permittivity at infinite frequency applied on top of the base permittivity at infinite frequency.

• conductivity (Optional[SpaceTimeModulation] = None) – Space-time modulation of electric conductivity applied on top of the base conductivity.

__init__(**kwargs)

Init method, includes post-init validators.

Methods

__init__(**kwargs)	Init method, includes post-init validators.
add_type_field()	Automatically place "type" field with model name in the model field dictionary.
construct([_fields_set])	Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data.
copy([deep, validate])	Copy a Tidy3dBaseModel.
dict(*[, include, exclude, by_alias, ...])	Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
dict_from_file(fname[, group_path])	Loads a dictionary containing the model from a .yaml, .json, .hdf5, or .hdf5.gz file.
dict_from_hdf5(fname[, group_path, ...])	Loads a dictionary containing the model contents from a .hdf5 file.
dict_from_hdf5_gz(fname[, group_path, ...])	Loads a dictionary containing the model contents from a .hdf5.gz file.
dict_from_json(fname)	Load dictionary of the model from a .json file.
dict_from_yaml(fname)	Load dictionary of the model from a .yaml file.
from_file(fname[, group_path])	Loads a Tidy3dBaseModel from .yaml, .json, .hdf5, or .hdf5.gz file.
from_hdf5(fname[, group_path, custom_decoders])	Loads Tidy3dBaseModel instance to .hdf5 file.
from_hdf5_gz(fname[, group_path, ...])	Loads Tidy3dBaseModel instance to .hdf5.gz file.
from_json(fname, **parse_obj_kwargs)	Load a Tidy3dBaseModel from .json file.
from_orm(obj)
from_yaml(fname, **parse_obj_kwargs)	Loads Tidy3dBaseModel from .yaml file.
generate_docstring()	Generates a docstring for a Tidy3D mode and saves it to the __doc__ of the class.
get_sub_model(group_path, model_dict)	Get the sub model for a given group path.
get_submodels_by_hash()	Return a dictionary of this object's sub-models indexed by their hash values.
get_tuple_group_name(index)	Get the group name of a tuple element.
get_tuple_index(key_name)	Get the index into the tuple based on its group name.
help([methods])	Prints message describing the fields and methods of a Tidy3dBaseModel.
insert_traced_fields(field_mapping)	Recursively insert a map of paths to autograd-traced fields into a copy of this obj.
json(*[, include, exclude, by_alias, ...])	Generate a JSON representation of the model, include and exclude arguments as per dict().
parse_file(path, *[, content_type, ...])
parse_obj(obj)
parse_raw(b, *[, content_type, encoding, ...])
schema([by_alias, ref_template])
schema_json(*[, by_alias, ref_template])
sel_inside(bounds)	Return a new modulation specficiation that contains the minimal amount data necessary to cover a spatial region defined by bounds.
strip_traced_fields([starting_path, ...])	Extract a dictionary mapping paths in the model to the data traced by autograd.
to_file(fname)	Exports Tidy3dBaseModel instance to .yaml, .json, or .hdf5 file
to_hdf5(fname[, custom_encoders])	Exports Tidy3dBaseModel instance to .hdf5 file.
to_hdf5_gz(fname[, custom_encoders])	Exports Tidy3dBaseModel instance to .hdf5.gz file.
to_json(fname)	Exports Tidy3dBaseModel instance to .json file
to_static()	Version of object with all autograd-traced fields removed.
to_yaml(fname)	Exports Tidy3dBaseModel instance to .yaml file.
tuple_to_dict(tuple_values)	How we generate a dictionary mapping new keys to tuple values for hdf5.
update_forward_refs(**localns)	Try to update ForwardRefs on fields based on this Model, globalns and localns.
updated_copy([path, deep, validate])	Make copy of a component instance with **kwargs indicating updated field values.
validate(value)

Attributes

applied_modulation	Check if any modulation has been applied to permittivity or conductivity.
permittivity
conductivity
attrs

permittivity

conductivity

property applied_modulation

Check if any modulation has been applied to permittivity or conductivity.

sel_inside(bounds)

Return a new modulation specficiation that contains the minimal amount data necessary to cover a spatial region defined by bounds.

Parameters:

bounds (Tuple[float, float, float], Tuple[float, float float]) – Min and max bounds packaged as (minx, miny, minz), (maxx, maxy, maxz).

Returns:

ModulationSpec with reduced data.

Return type:

ModulationSpec

__hash__()

Hash method.