Skip to main content

A napari plugin to simulate raw-image stacks of Structured illumination microscopy (SIM).

Project description

napari-generic-SIMulator

License BSD-3 PyPI Python Version tests codecov napari hub

A napari plugin to simulate raw-image stacks of Structured illumination microscopy (SIM).

The simulation is originally based on the paper GPU-accelerated real-time reconstruction in Python of three-dimensional datasets from structured illumination microscopy with hexagonal patterns by Hai Gong, Wenjun Guo and Mark A. A. Neil (https://doi.org/10.1098/rsta.2020.0162).

The calculation can be GPU-accelerated if the CUPY (tested with cupy-cuda11x) is installed. In addition, the TORCH package can complete the acceleration both on CPU if TORCH is installed, and on GPU if TORCH is compiled with the CUDA (tested with torch v1.13.1+cu117) enabled.

Currently applies to:

  • conventional 2-beam SIM data with 3 angles and 3 phases
  • 3-beam hexagonal SIM data with 7 phases, as described in the paper
  • 3-beam hexagonal SIM data with 5 phases at right-angles
  • conventional 3-beam 3-D data with 3 angles and 5 phases

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

Installation

You can install napari-generic-SIMulator via pip:

pip install napari-generic-SIMulator

To install latest development version :

pip install git+https://github.com/Meizhu-Liang/napari-generic-SIMulator.git

This plugin is compatible with napari 0.4.17 or above, older versions of napari would show errors in interpolation.

Usage

  1. Open napari and create the viewer.

  2. Launch two widgets: Point cloud generator and SIM data generator in Plugin.

    raw

    The two widgets can be tabbed together. raw

  3. Choose the type and other parameters of point cloud as a sample in Point cloud generator.

    raw

    The point cloud can be displayed in three dimensions, and be saved and loaded as .pcd files.

    https://user-images.githubusercontent.com/74197598/227589232-9006842b-6706-48b7-9f2b-fe93c6698503.mp4

  4. Adjust parameters in SIM data generator to simulate a raw image stack.

    Apart from basic parameters such as the refractive index, the wavelengths and so on, the z scanning can be either z drift: the conventional SIM (imaging a raw stack at the same z-position) or z step: the drifting case in the papaer mentioned above (imaging only one raw image at a z-position).

    raw

    The parameters used in the simulation can be saved with the image stack by clicking save tif with tags. Tags (of current or of one stack dragged into napari viewer) can be printed in Python by print tags.

  5. Three-dimensional point spread function (PSF), optical transfer function (OTF) and illumination patterns applied in the simulation can be showed by buttons. Note the all of these correspond the generated raw-image stack, so keep the parameters the same before showing the PSF (or OTF and illumination).

    https://user-images.githubusercontent.com/74197598/227588321-ad3c8f17-1c61-4079-9e34-9b1f990714c1.mp4

    https://user-images.githubusercontent.com/74197598/227586957-b76ad56e-44d5-4d9b-a1cc-2cfd08ca5400.mp4

    https://user-images.githubusercontent.com/74197598/227585827-64531265-b4fb-48a9-9698-7f263f22d718.mp4

  6. The raw image stacks can be then processed by napari-sim-processor (https://www.napari-hub.org/plugins/napari-sim-processor).

    raw

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 BSD-3 license, "napari-generic-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-generic-SIMulator-0.1.2.tar.gz (1.5 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