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

  • Read FLIM and hyperspectral files (.fbd, .sdt, .ptu, .lsm, .ome.tif)
  • Simultaneous multi-layer phasor analysis with primary-layer selection
  • Calibration, filtering (median / wavelet), and automatic thresholding
  • Phasor selections: circular cursors, automatic clustering, and manual drawing
  • Phasor Mapping: colormap apparent/normal lifetime, phasor phase, and modulation per pixel, with an interactive 1D histogram and statistics table
  • Component analysis and FRET trajectory analysis
  • Export as OME-TIF or CSV (multiple layers simultaneously)

Installation

You can install napari-phasors via pip. Follow these steps from a terminal.

We recommend using miniforge whenever possible. Click here to choose the right download option for your OS. If you do not use miniforge, but rather Anaconda or Miniconda, replace the mamba term whenever you see it below with conda.

Create a conda environment with napari by typing :

mamba create -y -n napari-phasors-env napari pyqt python=3.12

Activate the environment :

mamba activate napari-phasors-env

Install napari-phasors via pip :

pip install napari-phasors

Alternatively, install latest development version with :

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.5.0.tar.gz (378.5 kB 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.5.0-py3-none-any.whl (228.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: napari_phasors-0.5.0.tar.gz
  • Upload date:
  • Size: 378.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for napari_phasors-0.5.0.tar.gz
Algorithm Hash digest
SHA256 a11dcbf9669b3ee9e4ff2d549fef76f723acc12cc75c5a71591e5660bd9d46bf
MD5 bc17e6ffda8e7a2f3a2d63c5272e6033
BLAKE2b-256 e32696c134bb4956bb3838417565a1f16c426d1c55279a7a51bedc51b43be282

See more details on using hashes here.

Provenance

The following attestation bundles were made for napari_phasors-0.5.0.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.5.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for napari_phasors-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cc675a21264395fe6d03e0536ba2778e1b91dcefb673a4043c34c8b11d89ec28
MD5 443585ea444e0db6745ff69bded245ff
BLAKE2b-256 6c7483e38ec9ac237e7a146b1f0818fa124986cb238a8c0e3e585d7a9acacb46

See more details on using hashes here.

Provenance

The following attestation bundles were made for napari_phasors-0.5.0-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