{
  "title": "PermittivityMonitor",
  "public_path": "flex_rf.tidy3d.PermittivityMonitor",
  "lookup_path": "tidy3d.PermittivityMonitor",
  "slug": "flex_rf/tidy3d/PermittivityMonitor",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/permittivitymonitor/",
  "object_kind": "class",
  "introduction": "`Monitor` that records the diagonal components of the complex-valued relative\npermittivity tensor in the frequency domain. The recorded data has the same shape as a\n`FieldMonitor` of the same geometry: the permittivity values are saved at the\nYee grid locations, and can be interpolated to any point inside the monitor.",
  "notes": "If 2D materials are present, then the permittivity values correspond to the\nvolumetric equivalent of the 2D materials.\n\n.. TODO add links to relevant areas",
  "examples": "```python\nmonitor = PermittivityMonitor(\n    center=(1,2,3),\n    size=(2,2,2),\n    freqs=[250e12, 300e12],\n    name='eps_monitor')\n```",
  "references": "",
  "signature": "class PermittivityMonitor(AbstractMediumPropertyMonitor)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/monitor.py",
    "url": "",
    "lineno": 979,
    "endlineno": 1005
  },
  "bases": [
    "AbstractMediumPropertyMonitor"
  ],
  "parameter_rows": [
    {
      "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": "center",
      "annotation": "TracedCoordinate",
      "default": "(0.0, 0.0, 0.0)",
      "description": "Center of object in x, y, and z.",
      "origin": "inherited"
    },
    {
      "name": "size",
      "annotation": "TracedSize",
      "default": "",
      "description": "Size in x, y, and z directions.",
      "origin": "inherited"
    },
    {
      "name": "name",
      "annotation": "str",
      "default": "",
      "description": "Unique name for monitor.",
      "origin": "inherited"
    },
    {
      "name": "interval_space",
      "annotation": "tuple[PositiveInt, PositiveInt, PositiveInt]",
      "default": "(1, 1, 1)",
      "description": "Number of grid step intervals between monitor recordings. If equal to 1, there will be no downsampling. If greater than 1, the step will be applied, but the first and last point of the monitor grid are always included.",
      "origin": "inherited"
    },
    {
      "name": "colocate",
      "annotation": "Literal[False]",
      "default": "False",
      "description": "Colocation turned off, since colocated medium property values do not have a physical meaning - they do not correspond to the subpixel-averaged ones.",
      "origin": "inherited"
    },
    {
      "name": "use_colocated_integration",
      "annotation": "Literal[True]",
      "default": "True",
      "description": "Whether to use colocated fields for flux, dot products, and overlap integrals. Hard-coded to `True` for most monitor types. Can be toggled on field and overlap monitors.",
      "origin": "inherited"
    },
    {
      "name": "freqs",
      "annotation": "FreqArray",
      "default": "",
      "description": "Array or list of frequencies stored by the field monitor.",
      "origin": "inherited"
    },
    {
      "name": "apodization",
      "annotation": "ApodizationSpec",
      "default": "factory: ApodizationSpec",
      "description": "This field is ignored in this monitor.",
      "origin": "inherited"
    }
  ],
  "members": [
    {
      "name": "storage_size",
      "kind": "function",
      "signature": "storage_size(num_cells: int, tmesh: ArrayFloat1D)",
      "description": "Size of monitor storage given the number of points after discretization."
    }
  ],
  "group": "flex_rf.tidy3d"
}