API reference¶

Generated from the source docstrings. If you are looking for how the pieces fit together, start with Concepts instead.

At a glance¶

Class	What it does
`tomographicReconstructor`	Loads the configuration and builds the reconstruction matrices
`fitting`	Influence functions and the phase-to-command projection
`atmosphereParameters`	Layered turbulence model with airmass corrections
`lgsAsterismParameters`	Guide star asterism geometry and direction vectors
`lgsWfsParameters`	Shack–Hartmann geometry and valid subaperture map
`dmParameters`	Deformable mirror actuator geometry
`tomographyParameters`	Optimisation field of view and source sampling

All seven classes are re-exported at package level, so either import style works:

from pyTomoAO import tomographicReconstructor                # convenient
from pyTomoAO.reconstructor import tomographicReconstructor  # explicit

Module names are distinct from the class names, so import pyTomoAO.reconstructor gives the module and from pyTomoAO import tomographicReconstructor gives the class.

Classes¶

Each class gets its own page with every public method and property.

`pyTomoAO.reconstructor.tomographicReconstructor`	A class for computing tomographic reconstructors for adaptive optics systems.
`pyTomoAO.dm_fitting.fitting`	A class for handling deformable mirror fitting operations with influence function computation.
`pyTomoAO.atmosphereParametersClass.atmosphereParameters`	Encapsulates atmospheric parameters for optical turbulence modeling.
`pyTomoAO.lgsAsterismParametersClass.lgsAsterismParameters`	Encapsulates Laser Guide Star (LGS) Asterism parameters with validation and enhanced string representation.
`pyTomoAO.lgsWfsParametersClass.lgsWfsParameters`	Encapsulates Laser Guide Star Wavefront Sensor (LGS WFS) parameters with validation.
`pyTomoAO.dmParametersClass.dmParameters`	Encapsulates Deformable Mirror (DM) parameters with validation and type conversion.
`pyTomoAO.tomographyParametersClass.tomographyParameters`	Encapsulates tomography optimization parameters with validation, geometry computation, and enhanced string representation.

Internal computation kernels¶

pyTomoAO.tomographyUtilsCPU and pyTomoAO.tomographyUtilsGPU implement the covariance and reconstructor kernels behind matching private interfaces. They are selected automatically at import time and are not part of the public API — their signatures may change without notice.

Internal kernels