tidy3d.FluxTimeData

class FluxTimeData

Bases: MonitorData

Data associated with a FluxTimeMonitor: flux 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().

• monitor (FluxTimeMonitor) – Time-domain flux monitor associated with the data.

• flux (FluxTimeDataArray) – Flux values in the time-domain.

Notes

The data is stored as a DataArray object using the xarray package.

Example

>>> from tidy3d import FluxTimeDataArray
>>> t = [0, 1e-12, 2e-12]
>>> coords = dict(t=t)
>>> flux_data = FluxTimeDataArray(np.random.random(3), coords=coords)
>>> monitor = FluxTimeMonitor(size=(2,0,6), interval=100, name='flux_time')
>>> data = FluxTimeData(monitor=monitor, flux=flux_data)

Attributes

attrs

Methods

Inherited Common Usage

monitor

flux

__hash__()

Hash method.