Skip to content

API Reference

Complete reference documentation for all SAOS classes and methods. All docstrings follow the NumPy format.

Module Class Description
Telescope Telescope Pupil model and sampling parameters
Source Source Point source (guide star / science target)
Extended Source ExtendedSource Extended solar source with sub-directions
Layer LayerClass Single turbulent atmospheric layer
Atmosphere Atmosphere Multi-layer Von Kármán atmospheric model
Light Path LightPath Single line-of-sight propagation pipeline
Deformable Mirror DeformableMirror DM model (Cartesian & hexagonal geometry)
Misregistration MisRegistration DM-WFS misalignment model
NCPA NCPA Non-Common Path Aberrations
SHWFS ShackHartmann Classical Shack-Hartmann WFS
Correlating SHWFS CorrelatingShackHartmann Solar correlation-based SH-WFS
Detector Detector Detector noise and quantization model
Science Camera ScienceCam PSF / solar image science camera
Interaction Matrix InteractionMatrixHandler IM measurement and reconstruction
Controller Controller Leaky integrator / PI AO controller
Sharepoint Sharepoint Real-time telemetry via ZeroMQ