Skip to main content

A plugin for simulations of the Point Spread Function, with aberrations

Project description

napari-psf-simulator

License PyPI Python Version tests codecov napari hub

A plugin for the simulation of the 3D Point Spread Function of an optical systen, particularly a microscope objective.

Calculates the PSF using scalar and vectorial models.
The following aberrations are included:

  • phase aberration described by a Zernike polynomials with n-m coefficients.
  • aberration induced by a slab, with a refractive index different from the one at the object.

This napari plugin was generated with Cookiecutter using @napari's cookiecutter-napari-plugin template.

Installation

You can install napari-psf-simulator via pip:

pip install napari-psf-simulator

To install latest development version :

pip install git+https://github.com/andreabassi78/napari-psf-simulator.git

Usage

  1. Lauch the plugin and select the parameters of the microscope: NA (numerical aperture), wavelenght, n (refractive index at the object), FOV xy (field of view in the transverse direction), FOV z (field of view in the axial direction), dxy (pixel size, transverse sampling), dz (voxel depth, axial sampling), lens radius (physical aperture of the lens, used in vectorial model)

  2. Select a propagation model between scalar and vectorial.

  3. Select an aberration type (if needed).

  4. Press Calculate PSF to run the simulator. This will create a new image layer with the 3D PSF.

    The option Show Airy disk creates a circle with radius given by the diffraction limit (Rayleigh criterion).

raw Napari viewer with the psf-simulator widget showing the in-focus plane of an aberrated PSF

raw Slicing through a PSF aberrated with Zernike polynomials of order N=3, M=1 (coma)

  1. Click on the Plot PSF Profile in Console checkbox to see the x and z profiles of the PSF. They will show up in the viewer console when Calculate PSF is executed.

raw Plot profile of the PSF, shown in the Console

Detailed documentation

An exhaustive documentation of the use of the plugin on scalar and vectoral propagation models can be found in this presentation.

A detailed explanation of the uses and advantages that simulating a PSF brings can be found here.

The vectorial propagation model implements a secondary library: pyfocus. The full documentation of this library can be found at read the docs and in the paper: "PyFocus: A Python package for vectorial calculations of focused optical fields under realistic conditions. Application to toroidal foci." https://doi.org/10.1016/j.cpc.2022.108315

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request. The plugin has been concived to be modular allowing the insertion of new aberations and pupils. Please contact the developers on github for adding new propagations and aberrations types. Any suggestions or contributions are welcome.

License

Distributed under the terms of the BSD-3 license, "napari-psf-simulator" is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

napari-psf-simulator-0.3.1.tar.gz (10.7 MB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page