Output Data

Contents

Output Data#

Overview#

This page contains information on simulation and monitor data containers.

The `SimulationData` Object#

SimulationData

Stores data from a collection of Monitor objects in a Simulation.

The `BatchData` Object#

web.api.container.BatchData

Holds a collection of SimulationData returned by Batch.

List of Monitor Data Types#

`FieldData`	Data associated with a `FieldMonitor`: scalar components of E and H fields.
`FieldTimeData`	Data associated with a `FieldTimeMonitor`: scalar components of E and H fields.
`ModeSolverData`	Data associated with a `ModeSolverMonitor`: scalar components of E and H fields.
`PermittivityData`	Data for a `PermittivityMonitor`: diagonal components of the permittivity tensor.
`FluxData`	Data associated with a `FluxMonitor`: flux data in the frequency-domain.
`FluxTimeData`	Data associated with a `FluxTimeMonitor`: flux data in the time-domain.
`ModeData`	Data associated with a `ModeMonitor`: modal amplitudes, propagation indices and mode profiles.
`FieldProjectionAngleData`	Data associated with a `FieldProjectionAngleMonitor`: components of projected fields.
`FieldProjectionCartesianData`	Data associated with a `FieldProjectionCartesianMonitor`: components of projected fields.
`FieldProjectionKSpaceData`	Data associated with a `FieldProjectionKSpaceMonitor`: components of projected fields.
`DiffractionData`	Data for a `DiffractionMonitor`: complex components of diffracted far fields.
`rf.DirectivityData`	Data associated with a `DirectivityMonitor`.
`AuxFieldTimeData`	Data associated with a `AuxFieldTimeMonitor`: scalar components of aux fields.
`SurfaceFieldData`	Data associated with a `SurfaceFieldMonitor`: E and H fields on a surface.
`SurfaceFieldTimeData`

List of Dataset Types#

`SpatialDataArray`	Spatial distribution.
`PermittivityDataset`	Dataset storing the diagonal components of the permittivity tensor.
`ScalarFieldDataArray`	Spatial distribution in the frequency-domain.
`ScalarModeFieldDataArray`	Spatial distribution of a mode in frequency-domain as a function of mode index.
`ScalarFieldTimeDataArray`	Spatial distribution in the time-domain.
`components.data.data_array.FreqDataArray`	Frequency-domain array.
`components.data.data_array.FreqModeDataArray`	Array over frequency and mode index.
`ModeAmpsDataArray`	Forward and backward propagating complex-valued mode amplitudes.
`ModeIndexDataArray`	Complex-valued effective propagation index of a mode.
`FluxDataArray`	Flux through a surface in the frequency-domain.
`FluxTimeDataArray`	Flux through a surface in the time-domain.
`FieldProjectionAngleDataArray`	Far fields in frequency domain as a function of angles theta and phi.
`FieldProjectionCartesianDataArray`	Far fields in frequency domain as a function of local x and y coordinates.
`FieldProjectionKSpaceDataArray`	Far fields in frequency domain as a function of normalized kx and ky vectors on the observation plane.
`DiffractionDataArray`	Diffraction power amplitudes as a function of diffraction orders and frequency.
`SteadyVoltageDataArray`	Steady voltage data array.
`IndexedSurfaceFieldDataArray`	Stores indexed values of vector fields on the sides of a surface in frequency domain.
`IndexedSurfaceFieldTimeDataArray`	Stores indexed values of vector fields on the sides of a surface in time domain.
`IndexedSurfaceFreqDataArray`	Stores indexed values of scalar fields on the sides of a surface.
`IndexedSurfaceTimeDataArray`	Stores indexed values of scalar fields on the sides of a surface.
`TriangularSurfaceDataset`	Dataset for storing triangulated surface data.