prysm ¶

Release:	0.14.0
Date:	Mar 14, 2019

prysm is an open-source library for physical and first-order modeling of optical systems and analysis of related data. It is an unaffiliated sister library to PROPER and POPPY, codes developed to do physical optics modeling for primarily space-based systems. Prysm has a more restrictive capability in that domain, notably lacking multi-plane diffraction propagation, but also offers a broader set of features.

Contents

prysm

Use Cases ¶

prysm aims to be a swiss army knife for optical engineers and students. Its primary use cases include:

Analysis of optical data
robust numerical modeling of optical and opto-electronic systems based on physical optics
wavefront sensing

Please see the Features section for more details.

Installation ¶

prysm is available from either PyPi:

>>> pip install prysm

or github:

>>> pip install git+git://github.com/brandondube/prysm.git

It requires a minimal set of dependencies for scientific python; namely numpy, scipy, and matplotlib. It optionally depends on numba (for acceleration of some routines on CPUs), cupy (for experimental use with nVidia GPUs), imageio (for reading and writing images), h5py (for reading of Zygo’s datx format), and pandas (for some advanced utility MTF functions). Pip can be instructed to install these alongside prysm,

>>> pip install prysm[cpu+]  # for numba

>>> pip install prysm[cuda] # for cupy

>>> pip install prysm[img] # for imageio

>>> pip install prysm[Mx]  # for h5py

>>> pip install prysm[mtf+] # for pandas

or they may be installed at any time.

Features ¶

Physical Optics ¶

Modeing of pupil planes via or with:
- Hopkins’ wave aberration expansion, “Seidel aberrations”
- Fringe Zernike polynomials up to Z48, unit amplitude or RMS
- Zemax Standard Zernike polynomials up to Z48, unit amplitude
- apodization
- masks
- - circles and ellipses
- - n sided regular polygons
- - user-provided
- synthetic interferograms
- PV, rms, standard deviation, strehl evaluation
- plotting
Propagation of pupil planes via Fresnel transforms to Point Spread Functions (PSFs), which support
- calculation and plotting of encircled energy
- evaluation and plotting of slices
- 2D plotting with or without power law or logarithmic scaling
Computation of MTF from PSFs via the FFT method
- MTF Full-Field Displays
- MTF vs Field vs Focus
- - Best Individual Focus
- - Best Average Focus
- evaluation at
- - exact Cartesian spatial frequencies
- - exact polar spatial frequencies
- - Azimuthal average
- 2D and slice plotting
Rich tools for convolution of PSFs with images or synthetic objects:
- pinholes
- slits
- Siemens stars
- tilted squares
- slanted edges
read, write, and display of images
Detector models for e.g. STOP analysis or image synthesis
Interferometric analysis
- cropping, masking
- least-squares fitting and subtraction of Zernike modes, planes, and spheres
- evaluation of PV, RMS, Sa, standard deviation, band-limited RMS
- computation of PSD
- - 2D
- - x, y, azimuthally averaged slices
- - evaluation and/or comparison to lorentzian model
- spike clipping
- plotting