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:

monitor (Union[FieldMonitor, FieldTimeMonitor, AuxFieldTimeMonitor, MediumMonitor, PermittivityMonitor, FluxMonitor, FluxTimeMonitor, ModeMonitor, ModeSolverMonitor, FieldProjectionAngleMonitor, FieldProjectionCartesianMonitor, FieldProjectionKSpaceMonitor, DiffractionMonitor, DirectivityMonitor, MicrowaveModeMonitor, MicrowaveModeSolverMonitor, GaussianOverlapMonitor, AstigmaticGaussianOverlapMonitor, SurfaceFieldMonitor, SurfaceFieldTimeMonitor]) – Monitor associated with the data.

Attributes

symmetry_expanded	Return self with symmetry applied.
monitor

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.

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.