tidy3d.components.data.AbstractFluxData
tidy3d.components.data.AbstractFluxData#
- class tidy3d.components.data.AbstractFluxData#
Stores electromagnetic flux through a plane.
- Parameters
values (Union[Array, Array]) – Values of the raw data being stored.
data_attrs (Optional[Mapping[str, str]] = None) – Dictionary storing extra attributes associated with the monitor data.
Show JSON schema
{ "title": "AbstractFluxData", "description": "Stores electromagnetic flux through a plane.\n\nParameters\n----------\nvalues : Union[Array, Array]\n Values of the raw data being stored.\ndata_attrs : Optional[Mapping[str, str]] = None\n Dictionary storing extra attributes associated with the monitor data.", "type": "object", "properties": { "type": { "title": "Type", "default": "AbstractFluxData", "enum": [ "AbstractFluxData" ], "type": "string" }, "values": { "title": "Values", "description": "Values of the raw data being stored.", "anyOf": [ { "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" ] }, { "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" } } }, "required": [ "values" ] }
- Fields
- attribute data_attrs: Dict[str, str] = None#
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: Union[tidy3d.components.types.Array, tidy3d.components.types.Array] [Required]#
Values of the raw data being stored.