tidy3d.FluxData#

class FluxData[source]#

Bases: MonitorData

Data associated with a FluxMonitor: flux data in the frequency-domain.

Parameters:

monitor (FluxMonitor) – Frequency-domain flux monitor associated with the data.
flux (FluxDataArray) – Flux values in the frequency-domain.

Notes

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

We can access the data for each monitor by indexing into the SimulationData with the monitor .name. For the flux monitor data, we can access the raw flux data as a function of frequency with .flux. As most data are multidimensional, it’s often very helpful to print out the data and directly inspect its structure.

Example

>>> from tidy3d import FluxDataArray
>>> f = [2e14, 3e14]
>>> coords = dict(f=f)
>>> flux_data = FluxDataArray(np.random.random(2), coords=coords)
>>> monitor = FluxMonitor(size=(2,0,6), freqs=[2e14, 3e14], name='flux')
>>> data = FluxData(monitor=monitor, flux=flux_data)

tidy3d.FluxData

Contents

tidy3d.FluxData#