{
  "title": "PermittivityData",
  "public_path": "flex_rf.tidy3d.PermittivityData",
  "lookup_path": "tidy3d.PermittivityData",
  "slug": "flex_rf/tidy3d/PermittivityData",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/permittivitydata/",
  "object_kind": "class",
  "introduction": "Data for a `PermittivityMonitor`: diagonal components of the permittivity tensor.",
  "notes": "The data is stored as a [DataArray](https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html)\nobject using the [xarray](https://docs.xarray.dev/en/stable/index.html) package.",
  "examples": "```python\nfrom tidy3d import ScalarFieldDataArray\nx = [-1,1,3]\ny = [-2,0,2,4]\nz = [-3,-1,1,3,5]\nf = [2e14, 3e14]\ncoords = dict(x=x[:-1], y=y[:-1], z=z[:-1], f=f)\ngrid = Grid(boundaries=Coords(x=x, y=y, z=z))\nsclr_fld = ScalarFieldDataArray((1+1j) * np.random.random((2,3,4,2)), coords=coords)\nmonitor = PermittivityMonitor(size=(2,4,6), freqs=[2e14, 3e14], name='eps')\ndata = PermittivityData(\n    monitor=monitor, eps_xx=sclr_fld, eps_yy=sclr_fld, eps_zz=sclr_fld, grid_expanded=grid\n)\n```",
  "references": "",
  "signature": "class PermittivityData(PermittivityDataset, AbstractFieldData)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/data/monitor_data.py",
    "url": "",
    "lineno": 2292,
    "endlineno": 2320
  },
  "bases": [
    "PermittivityDataset",
    "AbstractFieldData"
  ],
  "parameter_rows": [
    {
      "name": "monitor",
      "annotation": "PermittivityMonitor",
      "default": "",
      "description": "Permittivity monitor associated with the data.",
      "origin": "declared"
    },
    {
      "name": "attrs",
      "annotation": "dict",
      "default": "factory: dict",
      "description": "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.model_dump_json()`.",
      "origin": "inherited"
    },
    {
      "name": "symmetry",
      "annotation": "tuple[Symmetry, Symmetry, Symmetry]",
      "default": "(0, 0, 0)",
      "description": "Symmetry eigenvalues of the original simulation in x, y, and z.",
      "origin": "inherited"
    },
    {
      "name": "symmetry_center",
      "annotation": "Coordinate | None",
      "default": "None",
      "description": "Center of the symmetry planes of the original simulation in x, y, and z. Required only if any of the `symmetry` field are non-zero.",
      "origin": "inherited"
    },
    {
      "name": "grid_expanded",
      "annotation": "Grid | None",
      "default": "None",
      "description": "`Grid` discretization of the associated monitor in the simulation which created the data. Required if symmetries are present, as well as in order to use some functionalities like getting Poynting vector and flux.",
      "origin": "inherited"
    },
    {
      "name": "eps_xx",
      "annotation": "ScalarFieldDataArray",
      "default": "",
      "description": "Spatial distribution of the xx-component of the relative permittivity.",
      "origin": "inherited"
    },
    {
      "name": "eps_yy",
      "annotation": "ScalarFieldDataArray",
      "default": "",
      "description": "Spatial distribution of the yy-component of the relative permittivity.",
      "origin": "inherited"
    },
    {
      "name": "eps_zz",
      "annotation": "ScalarFieldDataArray",
      "default": "",
      "description": "Spatial distribution of the zz-component of the relative permittivity.",
      "origin": "inherited"
    }
  ],
  "members": [],
  "group": "flex_rf.tidy3d"
}