tidy3d.EMESMatrixDataset#

class EMESMatrixDataset[source]#

Bases: Dataset

Dataset storing the scattering matrix of an EME simulation.

Parameters:
  • S11 (EMESMatrixDataArray) – S matrix relating output modes at port 1 to input modes at port 1.

  • S12 (EMESMatrixDataArray) – S matrix relating output modes at port 1 to input modes at port 2.

  • S21 (EMESMatrixDataArray) – S matrix relating output modes at port 2 to input modes at port 1.

  • S22 (EMESMatrixDataArray) – S matrix relating output modes at port 2 to input modes at port 2.

Notes

The S matrix relates incoming and outgoing mode amplitudes at the two ports of the EME device. Port 1 is at the beginning and port 2 is at the end of the propagation axis.

Convention:

  • S11: reflection at port 1 (input at port 1, output at port 1).

  • S21: transmission from port 1 to port 2.

  • S12: transmission from port 2 to port 1.

  • S22: reflection at port 2 (input at port 2, output at port 2).

Each element is indexed by (f, mode_index_out, mode_index_in) and optionally sweep_index when a sweep is used.

See also

EMESimulationData

Simulation data containing the S matrix.

Example

>>> from tidy3d import EMESMatrixDataArray
>>> f = [2e14]
>>> sweep_index = [0]
>>> mode_index_in = [0, 1]
>>> mode_index_out = [0, 1]
>>> coords = dict(
...     f=f, sweep_index=sweep_index,
...     mode_index_out=mode_index_out, mode_index_in=mode_index_in,
... )
>>> S = EMESMatrixDataArray((1+1j) * np.random.random((1, 1, 2, 2)), coords=coords)
>>> smatrix = EMESMatrixDataset(S11=S, S12=S, S21=S, S22=S)

Attributes

S11#
S12#
S21#
S22#