Skip to content

PSF Generator: a PyTorch-based library to simulate point spread functions for microscopes.

License

Notifications You must be signed in to change notification settings

Biomedical-Imaging-Group/psf_generator

Repository files navigation

PSF-Generator

MIT License PyPI Python Version


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

About

PSF Generator: a PyTorch-based library to simulate point spread functions for microscopes.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages