Prysm

A python optics module.

Installation

For the most up-to-date version of prysm, you should install from github:

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

prysm is also on pypi, but is not kept very up-to-date there:

pip install prysm

If you would like to see more frequent updates to the version on pypi, please let the author know. prysm requires numpy, scipy, pandas, and matplotlib as well as pytest for its testing framework. Pip should take care of these for you, but if for some reason it doesn't, make sure they are installed first.

Optional Dependencies

Prysm uses numpy for array operations. If your environment has numba installed, it will automatically accelerate many of prysm's compuations. If pyculib is installed with a compatible nVidia GPU, FFTs should be performed on the GPU automatically.

Features

Pupil modeling via:
- Seidel notation
- Fringe Zernike Polynomials, up to Z49 (base-1)
- Zemax Standard Zernikes, up to Z48 (base-1)
- Orthogonal and Orthonormal versions of both Zernike sets
and with:
- gaussian apodization
- noncircular apertures
- - n-sided regular polygons
- - rotated ellipses
- - user-provided masks
Thin lens / geometrical optics models
Point Spread Function (PSF) models
Modulation Transfer Function (MTF) models
Detector models and sampling
Optical Low Pass Filter (OLPF) models
Image synthesis
Shack-Hartmann sensor models
Colorimetry and color space transforms
Utilities for processing MTF and spectral data
An OceanOptics spectrometer file reader
An Object-Oriented Lens model based on physical optics

Usage

See Examples for jupyter notebooks with more complete samples.

Model the pupil of a diffraction limited optical system, its PSF, and its MTF.

from matplotlib import pyplot as plt
from prysm import Pupil, PSF, MTF, plot_fourier_chain

pupil = Pupil()
psf = PSF.from_pupil(pupil, efl=1)  # focal length in units of mm
mtf = MTF.from_psf(psf)

plot_fourier_chain(pupil, psf, mtf)
plt.show()

Introduce some aberrations

from prysm import FringeZernike

aberrated_pupil = FringeZernike(Z9=1)
pupil += aberrated_pupil
mtf2 = MTF.from_pupil(pupil, efl=1)  # can also skip PSF as long as EFL is given
fig, ax = mtf2.plot2d()
plt.show()

Notice that FringeZernike is also a type of pupil, and pupil objects support addition and subraction. MTF.from_pupil could have been called wiith aberrated_pupil directly.

Documentation

See prysm.readthedocs.io/ -- the docstrings and Examples are much more up-to-date and probably more useful. The docs are currently just an API reference and will require searching to even find anything within them.

Contributing

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. The library is most in need of contributions in the form of tests and documentation.

kaiyeh0913 / prysm