tidy3d.components.base_sim.data.sim_data.AbstractSimulationData

class AbstractSimulationData

Bases: Tidy3dBaseModel, ABC

Stores data from a collection of AbstractMonitor objects in a AbstractSimulation.

Parameters:

• simulation (AbstractSimulation) – Original AbstractSimulation associated with the data.

• data (tuple[AbstractMonitorData, …]) – List of AbstractMonitorData instances associated with the monitors of the original AbstractSimulation.

• log (Optional[str] = None) – A string containing the log information from the simulation run.

Attributes

monitor_data	Dictionary mapping monitor name to its associated AbstractMonitorData.
simulation
data
log

Methods

data_monitors_match_sim()	Ensure each AbstractMonitorData in .data corresponds to a monitor in .simulation.
get_monitor_by_name(name)	Return monitor named 'name'.
to_mat_file(fname, **kwargs)	Output the simulation data object as .mat MATLAB file.
validate_no_ambiguity(val)	Ensure all AbstractMonitorData entries in .data correspond to different monitors in .simulation.

simulation

data

log

property monitor_data

Dictionary mapping monitor name to its associated AbstractMonitorData.

data_monitors_match_sim()

Ensure each AbstractMonitorData in .data corresponds to a monitor in .simulation.

classmethod validate_no_ambiguity(val)

Ensure all AbstractMonitorData entries in .data correspond to different monitors in .simulation.

get_monitor_by_name(name)

Return monitor named ‘name’.

to_mat_file(fname, **kwargs)

Output the simulation data object as .mat MATLAB file.

Parameters:

• fname (PathLike) – Full path to the output file. Should include .mat file extension.

• **kwargs (dict, optional) – Extra arguments to scipy.io.savemat: see scipy documentation for more detail.

Example

>>> sim_data.to_mat_file('/path/to/file/data.mat')