{
  "title": "FieldTimeMonitor",
  "public_path": "flex_rf.tidy3d.FieldTimeMonitor",
  "lookup_path": "tidy3d.FieldTimeMonitor",
  "slug": "flex_rf/tidy3d/FieldTimeMonitor",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/fieldtimemonitor/",
  "object_kind": "class",
  "introduction": "`Monitor` that records electromagnetic fields in the time domain.",
  "notes": "`FieldTimeMonitor` objects are best used to monitor the time dependence of the fields at a single\npoint, but they can also be used to create “animations” of the field pattern evolution.\n\nTo create an animation, we need to capture the frames at different time instances of the simulation. This can\nbe done by using a `FieldTimeMonitor`. Usually a FDTD simulation contains a large number of time steps\nand grid points. Recording the field at every time step and grid point will result in a large dataset. For\nthe purpose of making animations, this is usually unnecessary.",
  "examples": "```python\nmonitor = FieldTimeMonitor(\n    center=(1,2,3),\n    size=(2,2,2),\n    fields=['Hx'],\n    start=1e-13,\n    stop=5e-13,\n    interval=2,\n    colocate=True,\n    name='movie_monitor')\n```",
  "references": "",
  "signature": "class FieldTimeMonitor(AbstractFieldMonitor, TimeMonitor)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/monitor.py",
    "url": "",
    "lineno": 852,
    "endlineno": 893
  },
  "bases": [
    "AbstractFieldMonitor",
    "TimeMonitor"
  ],
  "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": "bool",
      "default": "True",
      "description": "Toggle whether fields should be colocated to grid cell boundaries (i.e. primal grid nodes).",
      "origin": "inherited"
    },
    {
      "name": "use_colocated_integration",
      "annotation": "bool",
      "default": "True",
      "description": "Only takes effect when `colocate=False`. If `True`, flux, dot products, and overlap integrals still use fields interpolated to grid cell boundaries (colocated), even though the field data is stored at native Yee grid positions. Experimental feature that can give improved accuracy by avoiding interpolation of fields to Yee cell positions for integration.",
      "origin": "inherited"
    },
    {
      "name": "start",
      "annotation": "NonNegativeFloat",
      "default": "0.0",
      "description": "Time at which to start monitor recording.",
      "origin": "inherited"
    },
    {
      "name": "stop",
      "annotation": "NonNegativeFloat | None",
      "default": "None",
      "description": "Time at which to stop monitor recording. If not specified, record until end of simulation.",
      "origin": "inherited"
    },
    {
      "name": "interval",
      "annotation": "PositiveInt | None",
      "default": "None",
      "description": "Sampling rate of the monitor: number of time steps between each measurement. Set `interval` to 1 for the highest possible resolution in time. Higher integer values downsample the data by measuring every `interval` time steps. This can be useful for reducing data storage as needed by the application.",
      "origin": "inherited"
    },
    {
      "name": "fields",
      "annotation": "tuple[EMField, ...]",
      "default": "['Ex', 'Ey', 'Ez', 'Hx', 'Hy', 'Hz']",
      "description": "Collection of field components to store in the 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"
}