PAOS Logo

Contents:

  • Home
  • User Guide
    • Introduction
    • Installation
      • Install with pip
      • Install from git
      • Uninstall PAOS
      • Update PAOS
      • Modify PAOS
    • Quickstart
      • Running PAOS from terminal
      • The output file
      • The baseline plot
    • Input system
      • Configuration file
        • General
        • Wavelengths
        • Fields
        • Lens_xx
        • Parse configuration file
      • GUI editor
        • System Explorer
        • Lens Editor
        • Wavefront Editor
        • Optical Analysis
    • ABCD method
      • Paraxial region
      • Optical coordinates
      • Ray tracing
        • Example
      • Propagation
        • Example
      • Thin lens
        • Example
      • Dioptre
        • Example
      • Medium change
        • Example
      • Thick lens
        • Example
      • Magnification
        • Example
      • Prism
        • Example
      • Optical system equivalent
        • Example
      • Thick lens equivalent
    • POP description
      • General diffraction
      • Fresnel diffraction theory
      • Coordinate breaks
        • Example
      • Gaussian beams
        • Rayleigh distance
        • Gaussian beam propagation
        • Example
        • Gaussian beam magnification
        • Example
        • Gaussian beam change of medium
        • Example
      • Wavefront propagation
        • Example
      • Wavefront phase
        • Sloped incoming beam
        • Off-axis incoming beam
        • Paraxial phase correction
      • Apertures
        • Example
      • Stops
        • Example
      • POP propagation loop
        • Example
    • Aberration
      • Introduction
        • Strehl ratio
        • Encircled energy
      • Optical aberrations
        • Example of an aberrated pupil
      • PSD and SR
      • Grid Sag
    • Materials
      • Light dispersion
      • Sellmeier equation
        • Example
      • Temperature and refractive index
        • Example
      • Pressure and refractive index
        • Example
      • Supported materials
        • Example
        • Example
    • Monte Carlo
      • Multi-wavelength simulations
      • Wavefront error simulations
    • Plot
      • Base plot
        • Example
      • POP plot
        • Example
    • Save
      • Save output
        • Example
      • Save datacube
        • Example
    • Pipeline
      • Base pipeline
        • Example
  • Developer Guide
    • Coding conventions
    • Documentation
    • Testing
    • Logging
    • Versioning conventions
    • Source Control
      • Adding new features
  • API Guide
    • ABCD (paos.classes.abcd)
      • ABCD
        • ABCD.thickness
        • ABCD.M
        • ABCD.n1n2
        • ABCD.power
        • ABCD.cin
        • ABCD.cout
        • ABCD.f_eff
        • ABCD.ABCD
    • WFO (paos.classes.wfo)
      • WFO
        • WFO.wl
        • WFO.z
        • WFO.w0
        • WFO.zw0
        • WFO.zr
        • WFO.rayleigh_factor
        • WFO.dx
        • WFO.dy
        • WFO.C
        • WFO.fratio
        • WFO.wfo
        • WFO.amplitude
        • WFO.phase
        • WFO.wz
        • WFO.distancetofocus
        • WFO.propagator
        • WFO.extent
        • WFO.make_stop
        • WFO.aperture
        • WFO.insideout
        • WFO.lens
        • WFO.Magnification
        • WFO.ChangeMedium
        • WFO.ptp
        • WFO.stw
        • WFO.wts
        • WFO.propagate
        • WFO.zernikes
        • WFO.grid_sag
        • WFO.psd
    • Zernike (paos.classes.zernike)
      • Zernike
        • Zernike.j2mn
        • Zernike.mn2j
        • Zernike.cov
      • PolyOrthoNorm
        • PolyOrthoNorm.toZernike
    • PSD (paos.classes.psd)
      • PSD
        • PSD.sfe_rms
    • Core (paos.core)
      • parseConfig
        • getfloat
        • getaperture
        • parse_config
      • coordinateBreak
        • coordinate_break
      • raytrace
        • raytrace
      • run
        • push_results
        • run
      • plot
        • do_legend
        • simple_plot
        • plot_pop
        • plot_psf_xsec
        • plot_surface
      • saveOutput
        • remove_keys
        • save_recursively_to_hdf5
        • save_info
        • save_retval
        • save_output
        • save_datacube
      • pipeline
        • pipeline
    • GUI (paos.gui)
      • Core (paos.gui.core)
        • elems
        • io
        • plot
        • shared
    • Material (paos.util.material)
      • Material
        • Material.sellmeier
        • Material.nT
        • Material.nair
        • Material.nmat
        • Material.plot_relative_index
    • Logger (paos.log.logger)
      • addLogFile
      • setLogLevel
      • disableLogging
      • enableLogging
  • License
  • Changelog
    • Unreleased
      • 0.0.2 [15/09/2021]
      • 0.0.2.1 [20/10/2021]
      • 0.0.3 [23/12/2021]
        • Added
      • 0.0.4 [22/01/2022]
        • Changed
      • 1.0.0 [01/07/2023]
      • 1.0.1 [10/01/2024]
    • [Released]
      • 1.0.2-alpha.0 [10/01/2024]
        • Changed
      • 1.0.2 [10/01/2024]
      • 1.0.3-post1 [11/03/2024]
        • Added
        • Fixed
      • 1.1.0 [22/06/2024]
        • Fixed
        • Added
      • 1.0.3-post1 [11/03/2024]
        • Added
      • 1.1.1 [24/10/2024]
        • Added
        • Fixed
      • 1.1.2 [26/10/2024]
        • Changed
      • 1.2.1 [28/10/2024]
        • Changed
      • 1.2.2 [28/10/2024]
        • Changed
      • 1.2.3 [05/11/2024]
        • Added
      • 1.2.4 [07/11/2024]
        • Changed
      • 1.2.5 [07/11/2024]
        • Added
        • Changed
      • 1.2.6 [15/12/2024]
        • Added
        • Changed
      • 1.2.7 [21/01/2025]
        • Fixed
      • 1.2.8 [19/04/2025]
        • Changed
        • Added
      • 1.2.9-rc0 [21/04/2025]
        • Added
      • 1.2.9 [18/07/2025]
        • Added
        • Changed
        • Fixed
      • 1.2.10 [03/09/2025]
        • Added
        • Changed
      • 1.2.11 [11/11/2025]
        • Changed
        • Fixed
      • 1.2.12 [11/11/2025]
        • Changed
        • Fixed
  • Acknowledgements
  • Project Page
PAOS
  • API guide
  • Edit on GitHub

API guide

  • ABCD (paos.classes.abcd)
    • ABCD
      • ABCD.thickness
      • ABCD.M
      • ABCD.n1n2
      • ABCD.power
      • ABCD.cin
      • ABCD.cout
      • ABCD.f_eff
      • ABCD.ABCD
  • WFO (paos.classes.wfo)
    • WFO
      • WFO.wl
      • WFO.z
      • WFO.w0
      • WFO.zw0
      • WFO.zr
      • WFO.rayleigh_factor
      • WFO.dx
      • WFO.dy
      • WFO.C
      • WFO.fratio
      • WFO.wfo
      • WFO.amplitude
      • WFO.phase
      • WFO.wz
      • WFO.distancetofocus
      • WFO.propagator
      • WFO.extent
      • WFO.make_stop
      • WFO.aperture
      • WFO.insideout
      • WFO.lens
      • WFO.Magnification
      • WFO.ChangeMedium
      • WFO.ptp
      • WFO.stw
      • WFO.wts
      • WFO.propagate
      • WFO.zernikes
      • WFO.grid_sag
      • WFO.psd
  • Zernike (paos.classes.zernike)
    • Zernike
      • Zernike.j2mn
      • Zernike.mn2j
      • Zernike.cov
    • PolyOrthoNorm
      • PolyOrthoNorm.toZernike
  • PSD (paos.classes.psd)
    • PSD
      • PSD.sfe_rms
  • Core (paos.core)
    • parseConfig
      • getfloat
      • getaperture
      • parse_config
    • coordinateBreak
      • coordinate_break
    • raytrace
      • raytrace
    • run
      • push_results
      • run
    • plot
      • do_legend
      • simple_plot
      • plot_pop
      • plot_psf_xsec
      • plot_surface
    • saveOutput
      • remove_keys
      • save_recursively_to_hdf5
      • save_info
      • save_retval
      • save_output
      • save_datacube
    • pipeline
      • pipeline
  • GUI (paos.gui)
    • Core (paos.gui.core)
      • elems
        • app_elems
      • io
        • to_ini
      • plot
        • wfe_plot
      • shared
        • menu_panel
        • fill_value
        • fill_header
        • fill_body
        • refresh_ui
        • to_configparser
        • ellipsis
        • output_text_verbatim
        • modal_download
        • nested_div
  • Material (paos.util.material)
    • Material
      • Material.sellmeier
      • Material.nT
      • Material.nair
      • Material.nmat
      • Material.plot_relative_index
  • Logger (paos.log.logger)
    • addLogFile
    • setLogLevel
    • disableLogging
    • enableLogging
Previous Next

© Copyright 2021-2025, Andrea Bocchieri. Last updated on Nov 11, 2025.

Built with Sphinx using a theme provided by Read the Docs.