tidy3d.FieldData#

class tidy3d.FieldData#

Data associated with a FieldMonitor: scalar components of E and H fields.

Parameters
  • monitor (FieldMonitor) – 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)
>>> monitor = FieldMonitor(size=(2,4,6), freqs=[2e14, 3e14], name='field', fields=['Ex', 'Hz'])
>>> data = FieldData(monitor=monitor, Ex=scalar_field, Hz=scalar_field)

Show JSON schema
{
   "title": "FieldData",
   "description": "Data associated with a :class:`.FieldMonitor`: scalar components of E and H fields.\n\nParameters\n----------\nmonitor : FieldMonitor\n        Ex : Optional[ScalarFieldDataArray] = None\n    Spatial distribution of the x-component of the electric field.\nEy : Optional[ScalarFieldDataArray] = None\n    Spatial distribution of the y-component of the electric field.\nEz : Optional[ScalarFieldDataArray] = None\n    Spatial distribution of the z-component of the electric field.\nHx : Optional[ScalarFieldDataArray] = None\n    Spatial distribution of the x-component of the magnetic field.\nHy : Optional[ScalarFieldDataArray] = None\n    Spatial distribution of the y-component of the magnetic field.\nHz : Optional[ScalarFieldDataArray] = None\n    Spatial distribution of the z-component of the magnetic field.\n\nExample\n-------\n>>> x = [-1,1]\n>>> y = [-2,0,2]\n>>> z = [-3,-1,1,3]\n>>> f = [2e14, 3e14]\n>>> coords = dict(x=x, y=y, z=z, f=f)\n>>> scalar_field = ScalarFieldDataArray((1+1j) * np.random.random((2,3,4,2)), coords=coords)\n>>> monitor = FieldMonitor(size=(2,4,6), freqs=[2e14, 3e14], name='field', fields=['Ex', 'Hz'])\n>>> data = FieldData(monitor=monitor, Ex=scalar_field, Hz=scalar_field)",
   "type": "object",
   "properties": {
      "monitor": {
         "$ref": "#/definitions/FieldMonitor"
      },
      "type": {
         "title": "Type",
         "default": "FieldData",
         "enum": [
            "FieldData"
         ],
         "type": "string"
      },
      "Ex": {
         "title": "DataArray",
         "description": "Spatial distribution of the x-component of the electric field.",
         "type": "xr.DataArray",
         "properties": {
            "__slots__": {
               "title": "__slots__",
               "type": "Tuple[str, ...]"
            }
         },
         "required": [
            "__slots__"
         ]
      },
      "Ey": {
         "title": "DataArray",
         "description": "Spatial distribution of the y-component of the electric field.",
         "type": "xr.DataArray",
         "properties": {
            "__slots__": {
               "title": "__slots__",
               "type": "Tuple[str, ...]"
            }
         },
         "required": [
            "__slots__"
         ]
      },
      "Ez": {
         "title": "DataArray",
         "description": "Spatial distribution of the z-component of the electric field.",
         "type": "xr.DataArray",
         "properties": {
            "__slots__": {
               "title": "__slots__",
               "type": "Tuple[str, ...]"
            }
         },
         "required": [
            "__slots__"
         ]
      },
      "Hx": {
         "title": "DataArray",
         "description": "Spatial distribution of the x-component of the magnetic field.",
         "type": "xr.DataArray",
         "properties": {
            "__slots__": {
               "title": "__slots__",
               "type": "Tuple[str, ...]"
            }
         },
         "required": [
            "__slots__"
         ]
      },
      "Hy": {
         "title": "DataArray",
         "description": "Spatial distribution of the y-component of the magnetic field.",
         "type": "xr.DataArray",
         "properties": {
            "__slots__": {
               "title": "__slots__",
               "type": "Tuple[str, ...]"
            }
         },
         "required": [
            "__slots__"
         ]
      },
      "Hz": {
         "title": "DataArray",
         "description": "Spatial distribution of the z-component of the magnetic field.",
         "type": "xr.DataArray",
         "properties": {
            "__slots__": {
               "title": "__slots__",
               "type": "Tuple[str, ...]"
            }
         },
         "required": [
            "__slots__"
         ]
      }
   },
   "required": [
      "monitor"
   ],
   "additionalProperties": false,
   "definitions": {
      "FieldMonitor": {
         "title": "FieldMonitor",
         "description": ":class:`Monitor` that records electromagnetic fields in the frequency domain.\n\nParameters\n----------\ncenter : Tuple[float, float, float] = (0.0, 0.0, 0.0)\n    [units = um].  Center of object in x, y, and z.\nsize : Tuple[NonNegativeFloat, NonNegativeFloat, NonNegativeFloat]\n    [units = um].  Size in x, y, and z directions.\nname : ConstrainedStrValue\n    Unique name for monitor.\nfreqs : Union[Tuple[float, ...], Array]\n    [units = Hz].  Array or list of frequencies stored by the field monitor.\nfields : Tuple[Literal['Ex', 'Ey', 'Ez', 'Hx', 'Hy', 'Hz'], ...] = ['Ex', 'Ey', 'Ez', 'Hx', 'Hy', 'Hz']\n    Collection of field components to store in the monitor.\ninterval_space : Tuple[PositiveInt, PositiveInt, PositiveInt] = (1, 1, 1)\n    Number of grid step intervals between monitor recordings. If equal to 1, there will be no downsampling. If greater than 1, fields will be downsampled and automatically colocated.\ncolocate : Optional[bool] = None\n    Toggle whether fields should be colocated to grid cell centers. Default: ``False`` if ``interval_space`` is 1 in each direction, ``True`` if ``interval_space`` is greater than one in any direction.\n\nExample\n-------\n>>> monitor = FieldMonitor(\n...     center=(1,2,3),\n...     size=(2,2,2),\n...     fields=['Hx'],\n...     freqs=[250e12, 300e12],\n...     name='steady_state_monitor')",
         "type": "object",
         "properties": {
            "type": {
               "title": "Type",
               "default": "FieldMonitor",
               "enum": [
                  "FieldMonitor"
               ],
               "type": "string"
            },
            "center": {
               "title": "Center",
               "description": "Center of object in x, y, and z.",
               "default": [
                  0.0,
                  0.0,
                  0.0
               ],
               "units": "um",
               "type": "array",
               "minItems": 3,
               "maxItems": 3,
               "items": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "number"
                  },
                  {
                     "type": "number"
                  }
               ]
            },
            "size": {
               "title": "Size",
               "description": "Size in x, y, and z directions.",
               "units": "um",
               "type": "array",
               "minItems": 3,
               "maxItems": 3,
               "items": [
                  {
                     "type": "number",
                     "minimum": 0
                  },
                  {
                     "type": "number",
                     "minimum": 0
                  },
                  {
                     "type": "number",
                     "minimum": 0
                  }
               ]
            },
            "name": {
               "title": "Name",
               "description": "Unique name for monitor.",
               "minLength": 1,
               "type": "string"
            },
            "freqs": {
               "title": "Frequencies",
               "description": "Array or list of frequencies stored by the field monitor.",
               "units": "Hz",
               "anyOf": [
                  {
                     "type": "array",
                     "items": {
                        "type": "number"
                     }
                  },
                  {
                     "title": "Array Like",
                     "description": "Accepts sequence (tuple, list, numpy array) and converts to tuple.",
                     "type": "tuple",
                     "properties": {},
                     "required": []
                  }
               ]
            },
            "fields": {
               "title": "Field Components",
               "description": "Collection of field components to store in the monitor.",
               "default": [
                  "Ex",
                  "Ey",
                  "Ez",
                  "Hx",
                  "Hy",
                  "Hz"
               ],
               "type": "array",
               "items": {
                  "enum": [
                     "Ex",
                     "Ey",
                     "Ez",
                     "Hx",
                     "Hy",
                     "Hz"
                  ],
                  "type": "string"
               }
            },
            "interval_space": {
               "title": "Spatial interval",
               "description": "Number of grid step intervals between monitor recordings. If equal to 1, there will be no downsampling. If greater than 1, fields will be downsampled and automatically colocated.",
               "default": [
                  1,
                  1,
                  1
               ],
               "type": "array",
               "minItems": 3,
               "maxItems": 3,
               "items": [
                  {
                     "type": "integer",
                     "exclusiveMinimum": 0
                  },
                  {
                     "type": "integer",
                     "exclusiveMinimum": 0
                  },
                  {
                     "type": "integer",
                     "exclusiveMinimum": 0
                  }
               ]
            },
            "colocate": {
               "title": "Colocate fields",
               "description": "Toggle whether fields should be colocated to grid cell centers. Default: ``False`` if ``interval_space`` is 1 in each direction, ``True`` if ``interval_space`` is greater than one in any direction.",
               "type": "boolean"
            }
         },
         "required": [
            "size",
            "name",
            "freqs"
         ],
         "additionalProperties": false
      }
   }
}

Fields
  • Ex (tidy3d.components.data.data_array.ScalarFieldDataArray)

  • Ey (tidy3d.components.data.data_array.ScalarFieldDataArray)

  • Ez (tidy3d.components.data.data_array.ScalarFieldDataArray)

  • Hx (tidy3d.components.data.data_array.ScalarFieldDataArray)

  • Hy (tidy3d.components.data.data_array.ScalarFieldDataArray)

  • Hz (tidy3d.components.data.data_array.ScalarFieldDataArray)

  • monitor (tidy3d.components.monitor.FieldMonitor)

attribute Ex: tidy3d.components.data.data_array.ScalarFieldDataArray = None#

Spatial distribution of the x-component of the electric field.

Constraints
  • title = DataArray

  • type = xr.DataArray

  • properties = {‘__slots__’: {‘title’: ‘__slots__’, ‘type’: ‘Tuple[str, …]’}}

  • required = [‘__slots__’]

Validated by
  • _contains_fields

attribute Ey: tidy3d.components.data.data_array.ScalarFieldDataArray = None#

Spatial distribution of the y-component of the electric field.

Constraints
  • title = DataArray

  • type = xr.DataArray

  • properties = {‘__slots__’: {‘title’: ‘__slots__’, ‘type’: ‘Tuple[str, …]’}}

  • required = [‘__slots__’]

Validated by
  • _contains_fields

attribute Ez: tidy3d.components.data.data_array.ScalarFieldDataArray = None#

Spatial distribution of the z-component of the electric field.

Constraints
  • title = DataArray

  • type = xr.DataArray

  • properties = {‘__slots__’: {‘title’: ‘__slots__’, ‘type’: ‘Tuple[str, …]’}}

  • required = [‘__slots__’]

Validated by
  • _contains_fields

attribute Hx: tidy3d.components.data.data_array.ScalarFieldDataArray = None#

Spatial distribution of the x-component of the magnetic field.

Constraints
  • title = DataArray

  • type = xr.DataArray

  • properties = {‘__slots__’: {‘title’: ‘__slots__’, ‘type’: ‘Tuple[str, …]’}}

  • required = [‘__slots__’]

Validated by
  • _contains_fields

attribute Hy: tidy3d.components.data.data_array.ScalarFieldDataArray = None#

Spatial distribution of the y-component of the magnetic field.

Constraints
  • title = DataArray

  • type = xr.DataArray

  • properties = {‘__slots__’: {‘title’: ‘__slots__’, ‘type’: ‘Tuple[str, …]’}}

  • required = [‘__slots__’]

Validated by
  • _contains_fields

attribute Hz: tidy3d.components.data.data_array.ScalarFieldDataArray = None#

Spatial distribution of the z-component of the magnetic field.

Constraints
  • title = DataArray

  • type = xr.DataArray

  • properties = {‘__slots__’: {‘title’: ‘__slots__’, ‘type’: ‘Tuple[str, …]’}}

  • required = [‘__slots__’]

Validated by
  • _contains_fields

attribute monitor: tidy3d.components.monitor.FieldMonitor [Required]#
Validated by
  • _contains_fields

normalize(source_spectrum_fn: Callable[[float], complex]) tidy3d.components.data.monitor_data.FieldData#

Return copy of self after normalization is applied using source spectrum function.