tidy3d.components.data.dataset.FieldDataset

tidy3d.components.data.dataset.FieldDataset#

class FieldDataset[source]#

Bases: ElectromagneticFieldDataset

Dataset storing a collection of the scalar components of E and H fields in the freq. 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().

  • Ex (Optional[ScalarFieldDataArray] = None) – Spatial distribution of the x-component of the electric field.

  • Ey (Optional[ScalarFieldDataArray] = None) – Spatial distribution of the y-component of the electric field.

  • Ez (Optional[ScalarFieldDataArray] = None) – Spatial distribution of the z-component of the electric field.

  • Hx (Optional[ScalarFieldDataArray] = None) – Spatial distribution of the x-component of the magnetic field.

  • Hy (Optional[ScalarFieldDataArray] = None) – Spatial distribution of the y-component of the magnetic field.

  • Hz (Optional[ScalarFieldDataArray] = None) – Spatial distribution of the z-component of the magnetic field.

Example

>>> x = [-1,1]
>>> y = [-2,0,2]
>>> z = [-3,-1,1,3]
>>> f = [2e14, 3e14]
>>> coords = dict(x=x, y=y, z=z, f=f)
>>> scalar_field = ScalarFieldDataArray((1+1j) * np.random.random((2,3,4,2)), coords=coords)
>>> data = FieldDataset(Ex=scalar_field, Hz=scalar_field)

Attributes

attrs

Methods

from_zbf(dim1, dim2)

Creates a FieldDataset from a Zemax Beam File (.zbf).

Inherited Common Usage

Ex#
Ey#
Ez#
Hx#
Hy#
Hz#
from_zbf(dim1, dim2)[source]#

Creates a FieldDataset from a Zemax Beam File (.zbf).

Parameters:

  • filename (str) – The file name of the .zbf file to read.

  • dim1 (xyz) – Tangential field component to map the x-dimension of the zbf data to. eg. dim1 = "z" sets FieldDataset.Ez to Ex of the zbf data.

  • dim2 (xyz) – Tangential field component to map the y-dimension of the zbf data to. eg. dim2 = "z" sets FieldDataset.Ez to Ey of the zbf data.

Returns:

A FieldDataset object with two tangential E field components populated by zbf data.

Return type:

FieldDataset

See also

ZBFData

A class containing data read in from a .zbf file.

__hash__()#

Hash method.