Skip to main content

A simple plugin to use phasor analysis

Project description

napari-phasors

License BSD-3 PyPI Python Version tests codecov napari hub Documentation Status DOI

A comprehensive plugin for phasor analysis in napari. Based on the phasorpy library.


Documentation

Full documentation, including step-by-step guides and the API reference, is available at https://napari-phasors.readthedocs.io.

Features

  • Reading a wide range of FLIM and hyperspectral file formats:
    • Raw data formats:
      • .ptu, .fbd, .sdt, .lsm, .tif, .tiff, .czi, .flif, .bh, .b&h, .bhz, .lif, .bin, .json
    • Processed data formats:
      • .ome.tif, .ome.tiff, .r64, .ref, .ifli, .lif, .json
  • Phasor analysis on multiple layers simultaneously, including support for stacking multiple raw data files
  • Calibration using reference images with known lifetimes
  • Filtering with median, wavelet, and automatic thresholding (Otsu, Li, Yen)
  • Component analysis for multi-component systems
  • Phasor Mapping — colormap apparent/normal lifetime, phasor phase, and phasor modulation per pixel, with interactive 1D histograms, statistics tables, and arc overlay tools
  • FRET analysis with donor trajectory visualization and multi-layer donor/background source selection
  • Selections via manual drawing, circular/polar/elliptical cursors, and automatic clustering
  • Exporting results as OME-TIF or CSV (multiple layers simultaneously)

Installation

There are several ways to install napari-phasors:

Easiest: napari's plugin manager

If you already have napari installed, go to Plugins → Install/Uninstall Plugins..., search for napari-phasors, and click Install.

Standalone installer (no Python required)

Pre-built installers for Windows (.exe), macOS (.dmg), and Linux (.sh) are available on the latest release page. Download and run — no Python installation needed. Installers are ~350–470 MB and bundle everything required.

Using conda + pip

We recommend using miniforge. If you use Anaconda or Miniconda, replace mamba with conda.

mamba create -y -n napari-phasors-env napari pyqt6 python=3.14 # or 3.12, 3.13

Activate the environment :

conda activate napari-phasors-env
pip install napari-phasors

Development version

pip install git+https://github.com/napari-phasors/napari-phasors.git

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.

Pre-commit Hooks

This project uses pre-commit to run black, isort, and ruff automatically on every commit. To set it up:

pip install pre-commit
pre-commit install

From now on, every git commit will auto-format and lint your code before the commit goes through. You can also run the hooks manually on all files:

pre-commit run --all-files

License

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

Please cite doi: https://doi.org/10.5281/zenodo.14647626 if napari-phasors contributes to a project that leads to a publication.

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_phasors-0.6.2.tar.gz (1.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

napari_phasors-0.6.2-py3-none-any.whl (319.9 kB view details)

Uploaded Python 3

File details

Details for the file napari_phasors-0.6.2.tar.gz.

File metadata

  • Download URL: napari_phasors-0.6.2.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for napari_phasors-0.6.2.tar.gz
Algorithm Hash digest
SHA256 189a9a24af329aa13c96921af6303d9254f29be3620fdb8917af6ac0ef986b29
MD5 24c270f17f241fbdaceb780a098f9c8e
BLAKE2b-256 31902058c41734d1f7e5e793028d7f8ee0a647020a7d7eb2d87f60aa9635496c

See more details on using hashes here.

Provenance

The following attestation bundles were made for napari_phasors-0.6.2.tar.gz:

Publisher: run-tests.yml on napari-phasors/napari-phasors

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file napari_phasors-0.6.2-py3-none-any.whl.

File metadata

  • Download URL: napari_phasors-0.6.2-py3-none-any.whl
  • Upload date:
  • Size: 319.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for napari_phasors-0.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6a97126ae082bc42377e49ccc8897dcfb11c6ad5530d408b87dcddd59d53298d
MD5 0c4334a99fe3f3cb6619b3187014545b
BLAKE2b-256 9a501cc4f5062159b0d11f0ca20fbae1afaa0e86954ddae9c12d87fb54436de8

See more details on using hashes here.

Provenance

The following attestation bundles were made for napari_phasors-0.6.2-py3-none-any.whl:

Publisher: run-tests.yml on napari-phasors/napari-phasors

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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