API Reference
This page provides an auto-generated summary of slmsuite’s API. You can
find the source on GitHub.
Holography
As a core functionality, slmsuite optimizes nearfield phase profiles
(applied to slms) to produce desired farfield results
(measured by cameras). These methods are provided in:
GPU-accelerated holography algorithms. |
Additionally, quality-of-life support methods are provided, divided into SLM- and camera- centric categories:
Helper functions for manipulating phase patterns. |
|
Helper functions for processing images. |
Hardware
A central concept of slmsuite is experimental holography.
Thus, we require interfaces to control the hardware used in experiment.
While some common hardware implementions are included, we welcome
contributions
to expand the scope and utility of the package!
Hardware is divided into two main categories:
The phase displays used to produce holograms. |
|
The sensor arrays used to measure results. |
The unification of these two categories is stored in:
Datastructures, methods, and calibrations for an SLM monitored by a camera. |
Miscellaneous
Additional functions to handle minutiae.
Utilities for interfacing with files. |
|
Common fit functions. |