tidy3d.FluxTimeData
tidy3d.FluxTimeData#
- class tidy3d.FluxTimeData#
Stores time-domain power flux data from a
FluxTimeMonitor
.- Parameters
values (Array) – Values of the raw flux data in the time domain.
data_attrs (Mapping[str, str] = {'units': 'W', 'long_name': 'flux'}) – Dictionary storing extra attributes associated with the monitor data.
t (Array) – [units = sec]. Array of time values to use as coordintes.
Example
>>> t = np.linspace(0, 1e-12, 1001) >>> values = np.random.random((len(t),)) >>> data = FluxTimeData(values=values, t=t)
Show JSON schema
{ "title": "FluxTimeData", "description": "Stores time-domain power flux data from a :class:`.FluxTimeMonitor`.\n\nParameters\n----------\nvalues : Array\n Values of the raw flux data in the time domain.\ndata_attrs : Mapping[str, str] = {'units': 'W', 'long_name': 'flux'}\n Dictionary storing extra attributes associated with the monitor data.\nt : Array\n [units = sec]. Array of time values to use as coordintes.\n\nExample\n-------\n>>> t = np.linspace(0, 1e-12, 1001)\n>>> values = np.random.random((len(t),))\n>>> data = FluxTimeData(values=values, t=t)", "type": "object", "properties": { "type": { "title": "Type", "default": "FluxTimeData", "enum": [ "FluxTimeData" ], "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.", "default": { "units": "W", "long_name": "flux" }, "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" ] } }, "required": [ "values", "t" ] }
- Fields
data_attrs (Dict[str, str])
values (tidy3d.components.types.Array)
- attribute data_attrs: Dict[str, str] = {'long_name': 'flux', 'units': 'W'}#
explanation of values values is a numpy array that stores the raw data associated with each
MonitorData
. It can be complex-valued or real valued, depending on whether data is in the frequency or time domain, respectively. Each axis invalues
corresponds to a specific dimension in theMonitorData
, which are supplied as arguments to theMonitorData
subclasses. The order of the dimensions is specified in the_dims
attribute of eachMonitorData
subclassDictionary storing extra attributes associated with the monitor data.
- attribute values: tidy3d.components.types.Array [Required]#
Values of the raw flux data in the 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’]