tidy3d.components.monitor.Monitor
tidy3d.components.monitor.Monitor#
- class tidy3d.components.monitor.Monitor#
Abstract base class for monitors.
- Parameters
center (Tuple[float, float, float] = (0.0, 0.0, 0.0)) – [units = um]. Center of object in x, y, and z.
size (Tuple[NonNegativeFloat, NonNegativeFloat, NonNegativeFloat]) – [units = um]. Size in x, y, and z directions.
name (ConstrainedStrValue) – Unique name for monitor.
Show JSON schema
{ "title": "Monitor", "description": "Abstract base class for monitors.\n\nParameters\n----------\ncenter : Tuple[float, float, float] = (0.0, 0.0, 0.0)\n [units = um]. Center of object in x, y, and z.\nsize : Tuple[NonNegativeFloat, NonNegativeFloat, NonNegativeFloat]\n [units = um]. Size in x, y, and z directions.\nname : ConstrainedStrValue\n Unique name for monitor.", "type": "object", "properties": { "type": { "title": "Type", "default": "Monitor", "enum": [ "Monitor" ], "type": "string" }, "center": { "title": "Center", "description": "Center of object in x, y, and z.", "default": [ 0.0, 0.0, 0.0 ], "units": "um", "type": "array", "minItems": 3, "maxItems": 3, "items": [ { "type": "number" }, { "type": "number" }, { "type": "number" } ] }, "size": { "title": "Size", "description": "Size in x, y, and z directions.", "units": "um", "type": "array", "minItems": 3, "maxItems": 3, "items": [ { "type": "number", "minimum": 0 }, { "type": "number", "minimum": 0 }, { "type": "number", "minimum": 0 } ] }, "name": { "title": "Name", "description": "Unique name for monitor.", "minLength": 1, "type": "string" } }, "required": [ "size", "name" ], "additionalProperties": false }
- attribute name: str [Required]#
Unique name for monitor.
- Constraints
minLength = 1
- abstract storage_size(num_cells: int, tmesh: tidy3d.components.types.Array) int #
Size of monitor storage given the number of points after discretization.
- Parameters
num_cells (int) – Number of grid cells within the monitor after discretization by a
Simulation
.tmesh (Array) – The discretized time mesh of a
Simulation
.
- Returns
Number of bytes to be stored in monitor.
- Return type
int
- property geometry: tidy3d.components.geometry.Box#
Box
representation of monitor.- Returns
Representation of the monitor geometry as a
Box
.- Return type
Box
- property plot_params: tidy3d.components.viz.PlotParams#
Default parameters for plotting a Monitor object.