Skip to main content

A Napari plugin to detect and count nuclei on phase contrast images

Project description

napari-nuclephaser

License MIT PyPI Python Version tests napari hub npe2 Copier

A Napari plugin to detect and count nuclei on phase contrast images

napari-nuclephaser utilizes Ultralytics YOLO object detection models and obss/sahi sliced inference methods to detect cell nuclei on phase contrast (and other brightfield) images of any size, including large whole slide ones.

Nuclei detection

We trained a series of YOLOv5 and YOLOv11 models to detect nuclei on phase contrast images. It can be used for counting cells or for individual cell tracking (using nuclei detections as tracking marks). Prominent features of this approach are:

  • Napari-nuclephaser plugin inclues obss/sahi functionality, allowing detection on images of arbitrary sizes.
  • YOLO models are fast, providing reasonable inference speed even with CPU.
  • Ability to predict and automatically count nuclei on stacks of images, making it convenient for cell population growth studies and individual cell tracking.

Inference examples

Calibration algorithm

Result of object detection model inference is highly dependent on confidence threshold parameter.

Confidence threshold

We created several calibration (finding optimal confidence threshold) algorithms that allow adjusting models to specific use cases (cell types, magnifications, illumination settings, cameras etc.):

  • Calibration using known number of objects on an image. Doesn't produce accuracy metrics.
  • Calibration using fluorescent nuclei stain image (for example, DAPI image). Produces accuracy metrics.
  • Calibration using manual annotation of nuclei. Produces accuracy metrics.

Apart from optimal confidence threshold search, these algorithms return accuracy metrics for specific use cases. Given that the calibration image is large, only part of it is used for search of threshold, while the second part is used for evaluation model's accuracy. Accuracy metrics are Mean Absolute Percentage Error (MAPE) and prediction-ground truth scatterplot, which shows how well model performs with different densities of cells.

Calibration methods

Models

Currently only YOLOv5n, YOLOv5s, YOLOv11n and YOLOv11s models, as well as fluorescent nuclei detector YOLOv5s are available (downloaded automatically with pip install napari-nuclephaser). We are currently working on adding YOLOv5m-x and YOLOv11m-x models.

Plugin functionality

napari-nuclephaser plugin offers following widgets:

  • Widget for inference on single image. Result can be in the form of points or boxes with or without confidence scores. Automatically returns number of cells in the name of result layer.
  • Widget for inference on stack of images. Optionally can create .csv or .xlsx file at given location with counting results.
  • Widget for calibration using known number of cells.
  • Widget for calibration using fluorescent nuclei image (fluorescent nuclei detection model is used as a perfect predictor).
  • Widget for calibration using manual annotations.
  • Widget for transforming Napari Points layer into Labels layer, which allows turning detection in tracking algorithms-digestible form (in particular, btrack).
  • Widget for counting number of points in Points layer.

Hover with a mouse over a parameter to get a tooltip with short description of functionality. We are currently working on documentation with full description of widgets and their parameters. For now, if you have questions about widgets and/or parameters, please refer to ultralytics documentation and obss/sahi documentation

Citation

We are currently working on a paper with full description of our approach and how we trained and tested our models.


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

Installation

Option 1: Using Anaconda (recommended)

We recommend installation using Anaconda Distribution

  1. Install Anaconda with Installation instructions

  2. Open Anaconda Prompt using Search Bar or Anaconda Navigator

  3. Create new environment with default anaconda packages using command

conda create --name napari-env anaconda
  1. Activate new environment using command
conda activate napari-env
  1. Install Napari using command
pip install napari[all]
  1. Verify napari installation using following command. It should open napari GUI.
napari
  1. Install napari-nuclephase plugin using command
pip install napari-nuclephaser
  1. Plugin is ready to be used! Start napari by typing
napari

Initialize plugin's widgets by opening Plugins window and choosing NuclePhaser.

Installation with GPU

We are currently working on GPU-powered version of the plugin.

Option 2: Using standalone napari app (simpler)

  1. Download and install napari as standalone app using installation instructions

  2. Search, download and install napari-nuclephaser plugin by opening the app, navigating to Plugins window and choosing Install/Uninstall plugins...

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-nuclephaser" 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_nuclephaser-0.0.4.tar.gz (42.5 MB view details)

Uploaded Source

Built Distribution

napari_nuclephaser-0.0.4-py3-none-any.whl (42.5 MB view details)

Uploaded Python 3

File details

Details for the file napari_nuclephaser-0.0.4.tar.gz.

File metadata

  • Download URL: napari_nuclephaser-0.0.4.tar.gz
  • Upload date:
  • Size: 42.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for napari_nuclephaser-0.0.4.tar.gz
Algorithm Hash digest
SHA256 94f2d7ecfd53451c6c5648ae8f1584412df659b9f00ae75334bacf9becb2fe63
MD5 1ec9ce6fd98cbdc871b731ba33f30cd8
BLAKE2b-256 159fe3f48985420ebc4f8d58a9b7f9cd7d475218114e4367a224f37717812beb

See more details on using hashes here.

File details

Details for the file napari_nuclephaser-0.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for napari_nuclephaser-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 edbc67f8d32c9b0c6805997b6d40620ef8bf456c3d972b3d609ebc005a3b1145
MD5 f7d60e808a69d5216fe1ad9c68beedbd
BLAKE2b-256 f7c855f2e2c70e3f017380f1f6c9e699e5dc822f2e6d3bc7a8a34f3c1b7b1a62

See more details on using hashes here.

Supported by

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