tidy3d.components.data.monitor_data.MonitorData

class MonitorData

Bases: AbstractMonitorData, ABC

Abstract base class of objects that store data pertaining to a single monitor.

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 an attr obj.attrs['foo'] = bar. Also note that Tidy3D` will raise a TypeError if attrs contain objects that can not be serialized. One can check if attrs are serializable by calling obj.json().

• monitor (Union[FieldMonitor, FieldTimeMonitor, AuxFieldTimeMonitor, PermittivityMonitor, FluxMonitor, FluxTimeMonitor, ModeMonitor, ModeSolverMonitor, FieldProjectionAngleMonitor, FieldProjectionCartesianMonitor, FieldProjectionKSpaceMonitor, DiffractionMonitor, DirectivityMonitor]) – Monitor associated with the data.

Attributes

symmetry_expanded	Return self with symmetry applied.
attrs

Methods

flip_direction(direction)	Flip the direction of a string ('+', '-') -> ('-', '+').
get_amplitude(x)	Get the complex amplitude out of some data.
normalize(source_spectrum_fn)	Return copy of self after normalization is applied using source spectrum function.
scale_fields_by_freq_array(freq_array[, method])	Scale fields in MonitorData by an array of values stored in a FreqDataArray.

Inherited Common Usage

monitor

property symmetry_expanded

Return self with symmetry applied.

normalize(source_spectrum_fn)

Return copy of self after normalization is applied using source spectrum function.

scale_fields_by_freq_array(freq_array, method=None)

Scale fields in MonitorData by an array of values stored in a FreqDataArray.

Parameters:

• freq_array (FreqDataArray) – Array containing the scaling factors in the frequency domain.

• method (str = None) – Interpolation method to use when selecting frequency values. If None, uses default xarray method. Passed to xarray’s sel() method.

Returns:

A new instance of MonitorData with scaled field values.

Return type:

MonitorData

static flip_direction(direction)

Flip the direction of a string ('+', '-') -> ('-', '+').

static get_amplitude(x)

Get the complex amplitude out of some data.

__hash__()

Hash method.