tidy3d.components.monitor.AbstractModeMonitor

tidy3d.components.monitor.AbstractModeMonitor#

class AbstractModeMonitor[source]#

Bases: AbstractOverlapMonitor

Monitor that records mode-related data.

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[Literal[1], Literal[1], Literal[1]] = (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. Not all monitors support values different from 1.

  • colocate (bool = True) – Toggle whether fields should be colocated to grid cell boundaries (i.e. primal grid nodes).

  • freqs (ArrayLike[dtype=float, ndim=1]) – [units = Hz]. Array or list of frequencies stored by the field monitor.

  • apodization (ApodizationSpec = ApodizationSpec()) – Sets parameters of (optional) apodization. Apodization applies a windowing function to the Fourier transform of the time-domain fields into frequency-domain ones, and can be used to truncate the beginning and/or end of the time signal, for example to eliminate the source pulse when studying the eigenmodes of a system. Note: apodization affects the normalization of the frequency-domain fields.

  • store_fields_direction (Optional[Literal['+', '-']] = None) – Propagation direction for the mode field profiles stored from mode solving.

  • conjugated_dot_product (bool = True) – Use conjugated or non-conjugated dot product for mode decomposition.

  • mode_spec (ModeSpec = ModeSpec()) – Parameters to feed to mode solver which determine modes measured by monitor.

Attributes

mode_spec

store_fields_direction

colocate

conjugated_dot_product

freqs

apodization

interval_space

name

size

center

Methods

plot([x, y, z, ax])

Plot this monitor.

Inherited Common Usage

mode_spec#
store_fields_direction#
colocate#
conjugated_dot_product#
plot(x=None, y=None, z=None, ax=None, **patch_kwargs)[source]#

Plot this monitor.