tidy3d.ScalarFieldTimeData
tidy3d.ScalarFieldTimeData#
- class tidy3d.ScalarFieldTimeData#
stores a single scalar field in time domain
- Parameters
values (Array) – Multi-dimensional array storing the raw scalar field values in time domain.
data_attrs (Optional[Mapping[str, str]] = None) – Dictionary storing extra attributes associated with the monitor data.
t (Array) – [units = sec]. Array of time values to use as coordintes.
x (Array) – [units = um]. Array of x location values to use as coordintes.
y (Array) – [units = um]. Array of y location values to use as coordintes.
z (Array) – [units = um]. Array of z location values to use as coordintes.
Example
>>> t = np.linspace(0, 1e-12, 1001) >>> x = np.linspace(-1, 1, 10) >>> y = np.linspace(-2, 2, 20) >>> z = np.linspace(0, 0, 1) >>> values = np.random.random((len(x), len(y), len(z), len(t))) >>> data = ScalarFieldTimeData(values=values, x=x, y=y, z=z, t=t)
Show JSON schema
{ "title": "ScalarFieldTimeData", "description": "stores a single scalar field in time domain\n\nParameters\n----------\nvalues : Array\n Multi-dimensional array storing the raw scalar field values in time domain.\ndata_attrs : Optional[Mapping[str, str]] = None\n Dictionary storing extra attributes associated with the monitor data.\nt : Array\n [units = sec]. Array of time values to use as coordintes.\nx : Array\n [units = um]. Array of x location values to use as coordintes.\ny : Array\n [units = um]. Array of y location values to use as coordintes.\nz : Array\n [units = um]. Array of z location values to use as coordintes.\n\nExample\n-------\n>>> t = np.linspace(0, 1e-12, 1001)\n>>> x = np.linspace(-1, 1, 10)\n>>> y = np.linspace(-2, 2, 20)\n>>> z = np.linspace(0, 0, 1)\n>>> values = np.random.random((len(x), len(y), len(z), len(t)))\n>>> data = ScalarFieldTimeData(values=values, x=x, y=y, z=z, t=t)", "type": "object", "properties": { "type": { "title": "Type", "default": "ScalarFieldTimeData", "enum": [ "ScalarFieldTimeData" ], "type": "string" }, "values": { "title": "NumpyArray", "description": "Wrapper around numpy arrays that has a well defined json schema.", "type": "object", "properties": { "data_list": { "title": "Data List", "type": "array", "items": {} } }, "required": [ "data_list" ] }, "data_attrs": { "title": "Data Attributes", "description": "Dictionary storing extra attributes associated with the monitor data.", "type": "object", "additionalProperties": { "type": "string" } }, "t": { "title": "NumpyArray", "description": "Wrapper around numpy arrays that has a well defined json schema.", "units": "sec", "type": "object", "properties": { "data_list": { "title": "Data List", "type": "array", "items": {} } }, "required": [ "data_list" ] }, "x": { "title": "NumpyArray", "description": "Wrapper around numpy arrays that has a well defined json schema.", "units": "um", "type": "object", "properties": { "data_list": { "title": "Data List", "type": "array", "items": {} } }, "required": [ "data_list" ] }, "y": { "title": "NumpyArray", "description": "Wrapper around numpy arrays that has a well defined json schema.", "units": "um", "type": "object", "properties": { "data_list": { "title": "Data List", "type": "array", "items": {} } }, "required": [ "data_list" ] }, "z": { "title": "NumpyArray", "description": "Wrapper around numpy arrays that has a well defined json schema.", "units": "um", "type": "object", "properties": { "data_list": { "title": "Data List", "type": "array", "items": {} } }, "required": [ "data_list" ] } }, "required": [ "values", "t", "x", "y", "z" ] }
- Fields
values (tidy3d.components.types.Array)
- attribute values: tidy3d.components.types.Array [Required]#
Multi-dimensional array storing the raw scalar field values in time domain.
- Constraints
title = NumpyArray
description = Wrapper around numpy arrays that has a well defined json schema.
type = object
properties = {‘data_list’: {‘title’: ‘Data List’, ‘type’: ‘array’, ‘items’: {}}}
required = [‘data_list’]