https://github.com/holodyne/slmsuite
Python package for high-performance spatial light modulator (SLM) control and holography. Supports features from aberration-corrected 3D point clouds to automated Fourier-domain calibrations.
https://github.com/holodyne/slmsuite
3d adaptive-optics cgh computer-generated-hologram computer-generated-holography gerchberg-saxton gerchberg-saxton-algorithm hologram holography optics phase-retrieval photonics slm spatial-light-modulator wavefront-sensing zernike-polynomials
Last synced: 4 months ago
JSON representation
Python package for high-performance spatial light modulator (SLM) control and holography. Supports features from aberration-corrected 3D point clouds to automated Fourier-domain calibrations.
- Host: GitHub
- URL: https://github.com/holodyne/slmsuite
- Owner: holodyne
- License: mit
- Created: 2022-09-11T18:35:15.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2026-03-30T16:53:05.000Z (4 months ago)
- Last Synced: 2026-03-30T18:27:39.337Z (4 months ago)
- Topics: 3d, adaptive-optics, cgh, computer-generated-hologram, computer-generated-holography, gerchberg-saxton, gerchberg-saxton-algorithm, hologram, holography, optics, phase-retrieval, photonics, slm, spatial-light-modulator, wavefront-sensing, zernike-polynomials
- Language: Python
- Homepage: https://slmsuite.readthedocs.io
- Size: 7.22 MB
- Stars: 153
- Watchers: 4
- Forks: 55
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
High-Performance Spatial Light Modulator Control and Holography
`slmsuite` combines GPU-accelerated beamforming algorithms with optimized hardware control, automated calibration, and user-friendly scripting to enable high-performance programmable optics with modern spatial light modulators.
## Key Features
- [GPU-accelerated iterative phase retrieval algorithms](https://slmsuite.readthedocs.io/en/latest/_examples/computational_holography.html#Computational-Holography) (e.g. Gerchberg-Saxton, weighted GS, or phase-stationary WGS)
- [A simple hardware-control interface](https://slmsuite.readthedocs.io/en/latest/_examples/experimental_holography.html#Loading-Hardware) for working with various SLMs and cameras
- [Automated Fourier- to image-space coordinate transformations](https://slmsuite.readthedocs.io/en/latest/_examples/experimental_holography.html#Fourier-Calibration): choose how much light goes to which camera pixels; `slmsuite` takes care of the rest!
- [Automated wavefront calibration](https://slmsuite.readthedocs.io/en/latest/_examples/wavefront_calibration.html) to improve manufacturer-supplied flatness maps or compensate for additional aberrations along the SLM imaging train
- Optimized [optical focus/spot arrays](https://slmsuite.readthedocs.io/en/latest/_examples/computational_holography.html#Spot-Arrays) using [camera feedback](https://slmsuite.readthedocs.io/en/latest/_examples/experimental_holography.html#A-Uniform-Square-Array), automated statistics, and numerous analysis routines
- [Mixed region amplitude freedom](https://slmsuite.readthedocs.io/en/latest/_autosummary/slmsuite.holography.algorithms.Hologram.html#slmsuite.holography.algorithms.Hologram.optimize), which ignores unused far-field regions in favor of optimized hologram performance in high-interest areas.
- [Toolboxes for structured light](https://slmsuite.readthedocs.io/en/latest/_examples/structured_light.html#), imprinting sectioned phase masks, SLM unit conversion, padding and unpadding data, and more
- A fully-featured [example library](https://slmsuite.readthedocs.io/en/latest/examples.html) that demonstrates these and other features
## Installation
Install the stable version of `slmsuite` from [PyPI](https://pypi.org/project/slmsuite/) using:
```console
pip install slmsuite
```
Install the latest version of `slmsuite` from GitHub using:
```console
pip install git+https://github.com/holodyne/slmsuite
```
## Documentation and Examples
Extensive
[documentation](https://slmsuite.readthedocs.io/en/latest/)
and
[API reference](https://slmsuite.readthedocs.io/en/latest/api.html)
are available through readthedocs.
Examples can be found embedded in
[documentation](https://slmsuite.readthedocs.io/en/latest/examples.html)
or directly in
[source](https://github.com/holodyne/slmsuite-examples).
## Support
Users are encouraged to submit [issues](https://github.com/holodyne/slmsuite/issues) and [discussions](https://github.com/holodyne/slmsuite/discussions) via GitHub.
`slmsuite` is maintained by [Holodyne Labs, Inc](www.holodyne.com). Contact slmsuite@holodyne.com for additional information.