The napari hub is transitioning to a community-run implementation due to launch in June 2025.
Since October 1, 2024, this version is no longer actively maintained and will not be updated. New plugins and plugin updates will continue to be listed.

PSF Generator

napari-psfgenerator

Plugin to compute the focal electric field

    MIT License PyPI Python Version napari hub

    PSF Generator Napari Plugin

    The PSF Generator Napari Plugin provides an intuitive, interactive platform for simulating Point Spread Functions (PSFs) directly within the Napari ecosystem. Built on PyTorch, this plugin supports both CPU and GPU-accelerated computations, ensuring fast and efficient simulations for fundamental and advanced optical modeling.

    Key Features:

    • Flexible Propagation Models: Scalar and vectorial propagators in Cartesian and spherical coordinates.
    • Customizable Parameters: Configure physical (e.g., numerical aperture, wavelength), numerical (e.g., pixel size, Z-stacks), and optical settings (e.g., Gibson-Lanni corrections, Zernike aberrations).
    • Real-Time Visualization: Seamless integration with Napari for immediate visual feedback.
    • Versatile API: Access propagators programmatically for custom workflows.
    • Image Export: Save computed PSFs in TIFF format.

    This plugin is a powerful tool for researchers in optics, computational microscopy, and imaging science, bridging user-friendly interactivity with the computational capabilities of our Python library.


    This napari plugin was generated with copier using the napari-plugin-template.

    Installation

    Set up a Python virtual environment and install napari following this guide.

    You can install napari-psfgenerator via pip:

    pip install napari-psfgenerator

    To install latest development version :

    pip install git+https://github.com/Biomedical-Imaging-Group/napari-psfgenerator.git

    Now you can try the plugin out! Open napari, click on the menu "Plugins" and select "Propagators (PSF Generator)".

    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.

    License

    Distributed under the terms of the MIT license, "napari-psfgenerator" is free and open source software

    Issues

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

    Version:

    • 0.2.0

    Last updated:

    • 16 April 2025

    First released:

    • 05 February 2025

    License:

    Supported data:

    • Information not submitted

    Open extension:

    Save extension:

    Save layers:

    GitHub activity:

    • Stars: 2
    • Forks: 0
    • Issues + PRs: 0

    Python versions supported:

    Operating system:

    Requirements:

    • magicgui
    • qtpy
    • torch>=2.0.0
    • psf-generator
    • pyqt5