Table of Contents

Namespace VirtualLabAPI.Core.FieldRepresentations

Classes

ApertureSettings

Class describing aperture settings, i.e. its shape, size, and edge width. Sometimes also used for describing a field edge.

ChromaticFieldsSet

Class for a two-dimensional Chromatic Fields Set.

ChromaticFieldsSetBase

Abstract base class for a Chromatic Fields Set (can be 1D or 2D)

ChromaticFieldsSet_1D

Class for a one-dimensional Chromatic Fields Set.

ComplexAmplitude

This class represents a complex amplitude of a wave (without time depending part) in a plane or a complex transmission function.
Both X and Y field components are stored. In general all functions are applied to both components.
This class is also used to represent globally polarized fields and transmissions.
It contains one or two ComplexField as mathematical representations for complex fields. See manual for details of physical interpretation.
The ComplexAmplitude class can contain some additional information about the radius (distance from the origin) of a spherical phase factor. Using this information field may contain a spherical phase factor that is undersampled. If the radius of the spherical phase factor is known, the whole complex amplitude at every point can be reconstructed. The radius of the spherical phase factor helps to reduce the number of sampling points. Functions that use the ComplexAmplitude class have to take into account this spherical phase information to avoid numerical errors.
Operators (\(a+b\), \(a-b\), \(a*b\) and \(a/b\)) can be used. Passing \(a\) or \(b\) as Complex is supported. \(a^b\) can be applied for pointwise power function: \(a[x,y] ^ b\) \(b\) must be Complex. Operator \(a|b\) is used for calculation of inner product of two Complex Amplitudes: \(a|b=\sum _{j=0}^{m}\sum _{i=0}^{n}a_{{i,j}}b_{{i,j}^{\star}}\) (\(z^{\star}\) means conjugation of complex number).

ComplexAmplitudeInterpolation

This class contains static member functions for interpolating a complex amplitude to another sampling grid.

ComplexAmplitudeOperations

Contains different operators for the manipulation of a ComplexAmplitude.

ComplexAmplitudePointInterpolation

Class with static members that are able to interpolate pointwise between different sampling points of a complex amplitude. The point to interpolate is specified in physical coordinates. Additionally for most interpolation methods a non-static optimized version is supported. These functions are optimized for an interpolation on an equidistant grid. Different interpolation methods are supported.

ComplexAmplitudeView

Class which combines a complex amplitude with view settings.

FieldRepresentationObject

Abstract base class for all field representations.

HarmonicFieldBase

Base class for Harmonic Fields and Harmonic Fields Sets.

HarmonicFieldMode

Class to represent a harmonic field mode

HarmonicFieldsSet

Class containing a set of harmonic fields (i.e. of instances of class ComplexAmplitude).

HarmonicFieldsSetEvaluation

Evaluation functions for HarmonicFieldSet objects.

HarmonicFieldsSetView

Class which combines a harmonic fields set with view settings.

ImportExport

Collection of static support functions for export and import of data fields.

RigorousSimulationResult1D

Class for storing the results of rigorous calculations for which there is no modulation in y-direction. In this case the result is a line of orders. For each order the efficiency and Rayleigh coefficients are stored.

RigorousSimulationResult2D

Class for storing the results of rigorous calculations for real 3D systems, i. e. efficiencies and Rayleigh coefficients per order.

RigorousSimulationResultBase

Base class for storing the results of rigorous calculations, i. e. efficiencies and Rayleigh coefficients per order.

Transformations

Fourier transformations on various representations of fields.

Structs

ASCIIParam

Structure that contains parameters for ASCII Export.

AdditionalCAImportParams

Struct containing additional parameters for Import of a ComplexAmplitude.

Enums

CombinedComponent

Used for selection of the combination of the field components in a ComplexAmplitude.

ComplexAmplitudeType

The physical interpretation of a ComplexAmplitude.

VectorialComponent

Enum describing the vectorial components of a field (\(E_x\), \(E_y\), and \(E_z\)).