{
  "title": "SurfaceFieldData",
  "public_path": "flex_rf.tidy3d.SurfaceFieldData",
  "lookup_path": "tidy3d.SurfaceFieldData",
  "slug": "flex_rf/tidy3d/SurfaceFieldData",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/surfacefielddata/",
  "object_kind": "class",
  "introduction": "Data associated with a `SurfaceFieldMonitor`: E and H fields on a surface.",
  "notes": "",
  "examples": "```python\nfrom tidy3d import PointDataArray, IndexedSurfaceFieldDataArray, TriangularSurfaceDataset, CellDataArray\nimport tidy3d as td\nold_logging_level = td.config.logging_level\ntd.config.logging_level = \"ERROR\"\npoints = PointDataArray([[0, 0, 0], [0, 1, 0], [1, 1, 1]], dims=[\"index\", \"axis\"])\ncells = CellDataArray([[0, 1, 2]], dims=[\"cell_index\", \"vertex_index\"])\nvalues = PointDataArray([[1, 0, 0], [0, 1, 0], [0, 0, 1]], dims=[\"index\", \"axis\"])\nfield_values = IndexedSurfaceFieldDataArray(np.ones((3, 1, 3, 1)) + 0j, coords={\"index\": [0, 1, 2], \"side\": [\"outside\"],\"axis\": [0, 1, 2], \"f\": [1e10]})\nfield = TriangularSurfaceDataset(points=points, cells=cells, values=field_values)\nnormal = TriangularSurfaceDataset(points=points, cells=cells, values=values)\nmonitor = SurfaceFieldMonitor(\n    size=(2,4,6), freqs=[1e10], name='field', fields=['E', 'H']\n)\ndata = SurfaceFieldData(monitor=monitor, E=field, H=field, normal=normal)\ntd.config.logging_level = old_logging_level\n```",
  "references": "",
  "signature": "class SurfaceFieldData(ElectromagneticSurfaceFieldData)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/data/monitor_data.py",
    "url": "",
    "lineno": 2196,
    "endlineno": 2248
  },
  "bases": [
    "ElectromagneticSurfaceFieldData"
  ],
  "parameter_rows": [
    {
      "name": "monitor",
      "annotation": "SurfaceFieldMonitor",
      "default": "...",
      "description": "Frequency-domain field 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": "E",
      "annotation": "TriangularSurfaceDataset | None",
      "default": "None",
      "description": "Spatial distribution of the electric field on the one side of the surface.",
      "origin": "inherited"
    },
    {
      "name": "H",
      "annotation": "TriangularSurfaceDataset | None",
      "default": "None",
      "description": "Spatial distribution of the magnetic field on the one side of the surface.",
      "origin": "inherited"
    },
    {
      "name": "normal",
      "annotation": "TriangularSurfaceDataset",
      "default": "...",
      "description": "Normal direction of the surface oriented outward from the surface.",
      "origin": "inherited"
    },
    {
      "name": "symmetry",
      "annotation": "tuple[Symmetry, Symmetry, Symmetry]",
      "default": "(0, 0, 0)",
      "description": "Symmetry of the original simulation in x, y, and z.",
      "origin": "inherited"
    },
    {
      "name": "symmetry_center",
      "annotation": "Coordinate",
      "default": "(0, 0, 0)",
      "description": "Symmetry center of the original simulation in x, y, and z.",
      "origin": "inherited"
    }
  ],
  "members": [
    {
      "name": "normalize",
      "kind": "function",
      "signature": "normalize(source_spectrum_fn: Callable[[float], complex])",
      "description": "Return copy of self after normalization is applied using source spectrum function."
    },
    {
      "name": "poynting",
      "kind": "attribute",
      "signature": "poynting: TriangularSurfaceDataset",
      "description": "Time-averaged Poynting vector for frequency-domain data."
    }
  ],
  "group": "flex_rf.tidy3d"
}