Prysm is a python 3.6+ library for numerical optics. Its features are a superset of those in both POPPY and PROPER, not limited to physical optics, thin lens, thin film, and detector modeling. There is also a submodule that can replace the software that comes with an interferometer for data analysis.
Prysm is believed to be by significant margin the fastest package in the world at what it does. On CPU, end-to-end calculation is more than 100x as fast as the above for like-for-like calculations. On GPU, prysm is more than 1,000x faster than its competition. The lowfssim model can run at over 2kHz in real-time and is all prysm under the hood.
Prysm can be used for everything from forward modeling of optical systems from camera lenses to coronographs to reverse modeling and phase retrieval. Due to its composable structure, it plays well with others and can be substituted in or out of other code easily. Of special note is prysm's interchangeable backend system, which allows the user to freely exchange numpy for cupy, enabling use of a GPU for all computations, or other similar exchanges, such as pytorch for algorithmic differentiation.
prysm is on pypi:
pip install prysm
prysm requires only numpy, and scipy.
Prysm uses numpy for array operations or any compatible library. To use GPUs, you may install cupy and use it as the backend at runtime. Plotting uses matplotlib. Images are read and written with imageio. Some MTF utilities utilize pandas and seaborn. Reading of Zygo datx files requires h5py.
- Pupil-to-Focus
- Focus-to-Pupil
- Free space ("plane to plane" or "angular spectrum")
- FFTs, Matrix DFTs, Chirp C Transforms
- Thin Lens Phase Screens
- Zernike
- Legendre
- Chebyshev (1st, 2nd, 3rd, 4th kind)
- Jacobi
- 2D-Q, Qbfs, Qcon
- Hopkins
- Hermite (Probablist's and Physicist's)
- Dickson
- fitting
- projection
All of these polynomials provide highly optimized GPU-compatible implementations, as well as derivatives.
- circles, binary and anti-aliased
- ellipses
- rectangles
- N-sided regular convex polygons
- N-vaned spiders
- parametrized pupil mask generation
- per-segment errors based on any polynomial basis expansion
- Convolution
- Smear
- Jitter
- in-the-box targets
-
- Siemens' Star
-
- Slanted Edge
-
- BMW Target (crossed edges)
-
- Pinhole
-
- Slit
-
- Tilted Square
- Strehl
- Encircled Energy
- RMS, PV, Sa, Std, Var
- Centroid
- FWHM, 1/e, 1/e^2
- PSD
- MTF / PTF / OTF
- PSD (and parametric fit, synthesis from parameters)
- slope / gradient
- Total integrated scatter
- Bandlimited RMS
- fully integrated noise model (shot, read, prnu, etc)
- arbitrary pixel apertures (square, oblong, purely numerical)
- optical low pass filters
- Bayer compositing, demosaicing
- r, t parameters, even over spatially varying extent with high performance
- Brewster's angle
- Critical Angle
- Snell's law
- Cauchy's equation
- Sellmeier's equation
- Defocus to delta z at the image and reverse
- object/image distance relation
- image/object distances and magnification
- image/object distances and NA/F#
- magnification and working F/#
- two lens BFL, EFL (thick lenses)
- forward or reverse projection of surfaces
- surface synthesis in or out of beam normal based on arbitrary influence function with arbitrary sampling
- DM surface misalignment / registration errors
- PSD
- Low/High/Bandpass/Bandreject filtering
- spike clipping
- polynomial fitting and projection
- statistical evaluation (PV, RMS, PVr, Sa, bandlimited RMS...)
- total integrated scatter
- synthetic fringe maps with extra tilt fringes
- synthesize map from PSD spec
See the documentation on each
If you find an issue with prysm, please open an issue or pull request. Prysm has some usage of f-strings, so any code contributed is only expected to work on python 3.6+, and is licensed under the MIT license.