tidy3d.components.monitor.AbstractFieldMonitor#
- class AbstractFieldMonitor[source]#
Bases:
Monitor
,ABC
Monitor
that records electromagnetic field data as a function of x,y,z.- 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()
.center (Union[tuple[Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box]], Box] = (0.0, 0.0, 0.0)) β [units = um]. Center of object in x, y, and z.
size (Union[tuple[Union[pydantic.v1.types.NonNegativeFloat, autograd.tracer.Box], Union[pydantic.v1.types.NonNegativeFloat, autograd.tracer.Box], Union[pydantic.v1.types.NonNegativeFloat, autograd.tracer.Box]], Box]) β [units = um]. Size in x, y, and z directions.
name (ConstrainedStrValue) β Unique name for monitor.
interval_space (Tuple[PositiveInt, PositiveInt, PositiveInt] = (1, 1, 1)) β Number of grid step intervals between monitor recordings. If equal to 1, there will be no downsampling. If greater than 1, the step will be applied, but the first and last point of the monitor grid are always included.
colocate (bool = True) β Toggle whether fields should be colocated to grid cell boundaries (i.e. primal grid nodes).
fields (Tuple[Literal['Ex', 'Ey', 'Ez', 'Hx', 'Hy', 'Hz'], ...] = ['Ex', 'Ey', 'Ez', 'Hx', 'Hy', 'Hz']) β Collection of field components to store in the monitor.
Attributes
Methods
Inherited Common Usage
- fields#
- interval_space#
- colocate#
- __hash__()#
Hash method.