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 files for psf-generator 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| psf_generator-0.1.0.tar.gz | 25.6 kB | Without provenance | Details for psf_generator-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| psf_generator-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for psf_generator-0.1.0-py3-none-any.whl |
Total release size: 56.7 kB
Release files / psf_generator-0.1.0.tar.gz
| Download URL | psf_generator-0.1.0.tar.gz |
|---|---|
| Size | 25.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
599736ef612a516364bccc28c75fb35e68c66779725d7cafa65b1f41ea6bdc6a
|
|
BLAKE2b-256 checksum How to use checksums |
6880757439be465cb95064f05e011c0c6da4bebf412b1e5c7198223ae534cacd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.10
|
Release files / psf_generator-0.1.0-py3-none-any.whl
| Download URL | psf_generator-0.1.0-py3-none-any.whl |
|---|---|
| Size | 31.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6d180e1d93cf8c75294a9dc3149ddbfd22cf02b691d5aaad9e871ccdb7d2117f
|
|
BLAKE2b-256 checksum How to use checksums |
f6b05dee1c693591e014e0adebd6434870055f386ecd998334f6967e55175347
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.10
|
Security for psf-generator 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
