tidy3d.components.data.monitor_data.MonitorData#

class MonitorData[source]#

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, PermittivityMonitor, FluxMonitor, FluxTimeMonitor, ModeMonitor, ModeSolverMonitor, FieldProjectionAngleMonitor, FieldProjectionCartesianMonitor, FieldProjectionKSpaceMonitor, DiffractionMonitor]) – 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.
`make_adjoint_sources`(dataset_names)	Generate adjoint sources for this `MonitorData` instance.
`normalize`(source_spectrum_fn)	Return copy of self after normalization is applied using source spectrum function.

Inherited Common Usage

normalize(source_spectrum_fn)[source]#: Return copy of self after normalization is applied using source spectrum function.

make_adjoint_sources(dataset_names)[source]#: Generate adjoint sources for this MonitorData instance.

static flip_direction(direction)[source]#: Flip the direction of a string ('+', '-') -> ('-', '+').

static get_amplitude(x)[source]#: Get the complex amplitude out of some data.

tidy3d.components.data.monitor_data.MonitorData