tidy3d.components.monitor.AbstractMediumPropertyMonitor

tidy3d.components.monitor.AbstractMediumPropertyMonitor#

class AbstractMediumPropertyMonitor[source]#

Bases: FreqMonitor, ABC

Monitor that records material properties in the frequency domain.

Parameters:

center (Optional[tuple[Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box]]] = None) – [units = um]. Center of object in x, y, and z.
size (tuple[Union[NonNegativeFloat, autograd.tracer.Box], Union[NonNegativeFloat, autograd.tracer.Box], Union[NonNegativeFloat, autograd.tracer.Box]]) – [units = um]. Size in x, y, and z directions.
name (str) – 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 (Literal[False] = False) – Colocation turned off, since colocated medium property values do not have a physical meaning - they do not correspond to the subpixel-averaged ones.
use_colocated_integration (Literal[True] = True) – Whether to use colocated fields for flux, dot products, and overlap integrals. Hard-coded to True for most monitor types. Can be toggled on field and overlap monitors.
freqs (ArrayLike[dtype=float, ndim=1]) – [units = Hz]. Array or list of frequencies stored by the field monitor.
apodization (ApodizationSpec = ApodizationSpec()) – This field is ignored in this monitor.

Attributes