Data Objects Summary

Data objects for representing simulation data. Total: 25 classes.

Class

Description

ConvolutionKernel

Convolution Kernel data object. This object stores
the convolution kernels for Laser Guide Star (LGS)
Shack-Hartmann wavefront sensing and performs the
related computations.

ElectricField

Electric field data object. This class represents
a 2D electric field, storing both amplitude and
phase information for each pixel in a rectangular
grid.

GaussianConvolutionKernel

Gaussian Convolution Kernel data object. This
object stores a Gaussian convolution kernel for
Shack-Hartmann wavefront sensing and performs the
related computations.

IFunc

Influence functions data object. This class holds
the influence function matrix and the
corresponding mask. Influence functions data are
stored as [modes, pixels].

IFuncInv

Inverse Influence Function data object. This class
holds the inverse influence function matrix and
the corresponding mask. Inverse influence
functions data are stored as [pixels, modes].

IirFilterData

Infinite Impulse Response (IIR) Filter Data
object. This class stores IIR filter coefficients
and provides methods to analyze the filter’s
transfer function, frequency response and
stability.

InfinitePhaseScreen

Infinite Phase Screen Data object. This class
generates and holds an infinite phase screen
generated using a stochastic process that
simulates atmospheric turbulence.

Intensity

Intensity field data object.

Intmat

Interaction matrix data object. This class holds
the interaction matrix (intmat) and related
metadata for wavefront reconstruction.

LaserLaunchTelescope

Laser Launch Telescope data object. This class
holds the parameters of the laser launch
telescope, such as spot size, position, focus and
tilt.

Layer

Layer data object. This object represents a layer
in the atmosphere for wavefront propagation
simulations. It inherits from the ElectricField
class and adds additional properties such as
height, shifts, rotation, and magnification.

Lenslet

Lenslet data object. This class holds the
information about the lenslet array, such as the
number of lenses and their positions.

M2C

Modal to Command (M2C) matrix data object. This
class holds the M2C matrix, which is used to
convert modal coefficients to actuator commands.
The M2C matrix is stored as [actuators, modes].

Phasescreen

Phasescreen field data object.

Pixels

Pixels data object. Holds a 2d array of pixels,
which can be signed or unsigned. The number of
bits per pixel can be set, up to 64 bits.

PupData

Pupil data object. This class holds the
information about the pupils of a Pyramid WFS (or
a Zernike WFS). PupData includes an ind_pup array
with the pixel indexes of each pupil, of shape
[index, pupil].

Pupilstop

Pupil stop data object. This class holds the
information about the pupil stop, i.e. the
amplitude mask in the pupil plane.

Recmat

Reconstruction matrix data object. This class
holds the information about the reconstruction
matrix, which maps slopes to modes. The
reconstruction matrix axes are [modes, slopes].

SimulParams

Simulation Parameters data object. This class
holds the parameters of the simulation, such as
pixel size, time step, total time, zenith angle,
etc.

Slopes

Slopes data object. Holds a slopes vector, which
can be interleaved (XYXYXY…) or not
(XXX…YYY…). X and Y slopes can be accessed
independently, and a 2d map is available.

Source

Source data object. Holds the properties of a
source, such as polar coordinates, magnitude,
wavelength, height, band, zero point, and error in
coordinates.

SpatioTempArray

Spatio-temporal array data object. This class
holds a multi-dimensional spatio-temporal array
with an associated time vector. Input arrays can
have temporal evolution on the first or last axis.
Internally, data are always stored in time-first
layout: array[i, …] is associated with
time_vector[i].

SsrFilterData

State Space Representation Filter Data data
object. This class stores discrete-time
state-space filter coefficients.

SubapData

Subaperture data object. This class holds the
information about the subapertures, i.e. the
indices of the pixels belonging to each
subaperture of a Shack-Hartmann sensor.

TimeHistory

Time history data object. This class holds the
time history of a variable, such as the seeing
value, during the simulation. The time history is
stored as a 1D array,