{
  "title": "FluxTimeData",
  "public_path": "flex_rf.tidy3d.FluxTimeData",
  "lookup_path": "tidy3d.FluxTimeData",
  "slug": "flex_rf/tidy3d/FluxTimeData",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/fluxtimedata/",
  "object_kind": "class",
  "introduction": "Data associated with a `FluxTimeMonitor`: flux data in the time-domain.",
  "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 FluxTimeDataArray\nt = [0, 1e-12, 2e-12]\ncoords = dict(t=t)\nflux_data = FluxTimeDataArray(np.random.random(3), coords=coords)\nmonitor = FluxTimeMonitor(size=(2,0,6), interval=100, name='flux_time')\ndata = FluxTimeData(monitor=monitor, flux=flux_data)\n```",
  "references": "",
  "signature": "class FluxTimeData(MonitorData)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/data/monitor_data.py",
    "url": "",
    "lineno": 3774,
    "endlineno": 3802
  },
  "bases": [
    "MonitorData"
  ],
  "parameter_rows": [
    {
      "name": "monitor",
      "annotation": "FluxTimeMonitor",
      "default": "",
      "description": "Time-domain flux monitor associated with the data.",
      "origin": "declared"
    },
    {
      "name": "flux",
      "annotation": "FluxTimeDataArray",
      "default": "",
      "description": "Flux values in the time-domain.",
      "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"
    }
  ],
  "members": [],
  "group": "flex_rf.tidy3d"
}