PSF Generator: a PyTorch-based library to simulate point spread functions for microscopy.
Project description
PSF-Generator
Welcome to the psf-generator library!
This library implements various physical models that compute the point spread function (PSF) of optical microscopes. PSF characterizes the response of an imaging system to a point source and is crucial for tasks such as deconvolution, correction of aberrations, and characterization of the system.
We classify these models in two types---scalar or vectorial--- and in both cases the PSF integral can be computed in Cartesian or spherical coordinate systems. This results in the following four propagators
| Name of propagator | Other names |
|---|---|
ScalarCartesianPropagator |
simple/scalar Fourier model |
ScalarSphericalPropagator |
Kirchhoff model |
VectorialCartesianPropagator |
vectorial Fourier model |
VectorialSphericalPropagator |
Richards-Wolf model |
For details on the theory, please refer to our paper Revisiting PSF models: unifying framework and high-performance implementation.
Documentation
Documentation can be found here: https://psf-generator.readthedocs.io/
Installation
Basic Installation
pip install psf-generator
That's it for the basic installation; you're ready to go!
Developer Installation
If you're interested in experimenting with the code base, please clone the repository and install it using the following commands:
git clone git@github.com:Biomedical-Imaging-Group/psf_generator.git
cd psf_generator
pip install -e .
Demos
Jupyter Notebook demos can be found under demos/.
Napari Plugin
You can find our Napari plugin here.
Cite Us
TODO
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file psf_generator-0.1.0.tar.gz.
File metadata
- Download URL: psf_generator-0.1.0.tar.gz
- Upload date:
- Size: 25.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
599736ef612a516364bccc28c75fb35e68c66779725d7cafa65b1f41ea6bdc6a
|
|
| MD5 |
a38e5859aa5adcda2a999d4fb70bef72
|
|
| BLAKE2b-256 |
6880757439be465cb95064f05e011c0c6da4bebf412b1e5c7198223ae534cacd
|
File details
Details for the file psf_generator-0.1.0-py3-none-any.whl.
File metadata
- Download URL: psf_generator-0.1.0-py3-none-any.whl
- Upload date:
- Size: 31.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6d180e1d93cf8c75294a9dc3149ddbfd22cf02b691d5aaad9e871ccdb7d2117f
|
|
| MD5 |
45387c9d476b1fd92337b2efe5c6fe48
|
|
| BLAKE2b-256 |
f6b05dee1c693591e014e0adebd6434870055f386ecd998334f6967e55175347
|
