tidy3d.components.monitor.TimeMonitor

class TimeMonitor

Bases: Monitor, ABC

Monitor that records data in the time-domain.

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

• center (Tuple[float, float, float] = (0.0, 0.0, 0.0)) – [units = um]. Center of object in x, y, and z.

• size (Tuple[NonNegativeFloat, NonNegativeFloat, NonNegativeFloat]) – [units = um]. Size in x, y, and z directions.

• name (ConstrainedStrValue) – 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 (Literal[True] = True) – Defines whether fields are colocated to grid cell boundaries (i.e. to the primal grid) on-the-fly during a solver run. Can be toggled for field recording monitors and is hard-coded for other monitors depending on their specific function.

• start (NonNegativeFloat = 0.0) – [units = sec]. Time at which to start monitor recording.

• stop (Optional[NonNegativeFloat] = None) – [units = sec]. Time at which to stop monitor recording. If not specified, record until end of simulation.

• interval (Optional[PositiveInt] = None) – Sampling rate of the monitor: number of time steps between each measurement. Set interval to 1 for the highest possible resolution in time. Higher integer values downsample the data by measuring every interval time steps. This can be useful for reducing data storage as needed by the application.

Attributes

attrs

Methods

num_steps(tmesh)	Compute number of time steps for a time monitor.
stop_greater_than_start(val, values)	Ensure sure stop is greater than or equal to start.
time_inds(tmesh)	Compute the starting and stopping index of the monitor in a given discrete time mesh.

Inherited Common Usage

start

stop

interval

classmethod stop_greater_than_start(val, values)

Ensure sure stop is greater than or equal to start.

time_inds(tmesh)

Compute the starting and stopping index of the monitor in a given discrete time mesh.

num_steps(tmesh)

Compute number of time steps for a time monitor.

__hash__()

Hash method.