tidy3dclient.TimeProbe

class tidy3dclient.TimeProbe(center, size, t_start=0, t_stop=None, field=['E'], name=None)

Probe recording the time-domain fields within a 3D region.

__init__(center, size, t_start=0, t_stop=None, field=['E'], name=None)

Construct.

Parameters

  • center (array_like) – (micron) x, y, and z position of the center of the Probe.

  • size (array_like) – (micron) Size in x, y, and z.

  • t_start (float, optional) – (second) Starting time of field recording.

  • t_stop (float, optional) – (second) Stopping time of field recording. If None, record until the end of the simulation.

  • field (list, optional) – List of fields to be recorded. Valid values are 'E' and 'H'.

  • name (str, optional) – Custom name of the probe.

Note

Time probes can result in very large amounts of data if defined over a large spatial region. Recommended usage is either recording the full time evolution of a single point in space, or using t_start and t_stop to record just a few time steps of a larger region.

Methods

__init__(center, size[, t_start, t_stop, …])

Construct.

Attributes

E

Electric field stored in the probe, if it was requested and after the probe data has been loaded.

H

Magnetic field stored in the probe, if it was requested and after the probe data has been loaded.

tmesh

Mesh in time over which the field values are stored.

xmesh

Mesh along the x-axis over which the fields values are stored.

ymesh

Mesh along the y-axis over which the fields values are stored.

zmesh

Mesh along the z-axis over which the fields values are stored.