tidy3d.components.base_sim.data.sim_data.AbstractSimulationData#
- class AbstractSimulationData[source]#
Bases:
Tidy3dBaseModel
,ABC
Stores data from a collection of
AbstractMonitor
objects in aAbstractSimulation
.- Parameters:
attrs (dict = {}) – 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 anattr
obj.attrs['foo'] = bar
. Also note that Tidy3D` will raise aTypeError
ifattrs
contain objects that can not be serialized. One can check ifattrs
are serializable by callingobj.json()
.simulation (AbstractSimulation) – Original
AbstractSimulation
associated with the data.data (Tuple[AbstractMonitorData, ...]) – List of
AbstractMonitorData
instances associated with the monitors of the originalAbstractSimulation
.log (Optional[str] = None) – A string containing the log information from the simulation run.
Attributes
Dictionary mapping monitor name to its associated
AbstractMonitorData
.Methods
data_monitors_match_sim
(val, values)Ensure each
AbstractMonitorData
in.data
corresponds to a monitor in.simulation
.validate_no_ambiguity
(val, values)Ensure all
AbstractMonitorData
entries in.data
correspond to different monitors in.simulation
.Inherited Common Usage
- simulation#
- data#
- log#
- property monitor_data#
Dictionary mapping monitor name to its associated
AbstractMonitorData
.
- classmethod data_monitors_match_sim(val, values)[source]#
Ensure each
AbstractMonitorData
in.data
corresponds to a monitor in.simulation
.
- classmethod validate_no_ambiguity(val, values)[source]#
Ensure all
AbstractMonitorData
entries in.data
correspond to different monitors in.simulation
.
- __hash__()#
Hash method.