Skip to main content

Interactive batch annotation tool for microscopy datasets with tiled grid visualization

Project description

napari-grid-curator

License MIT PyPI Python Version napari hub

Interactive batch annotation tool for microscopy datasets with tiled grid visualization.


Overview

napari-grid-curator is a napari plugin for efficient manual curation of large microscopy datasets. The key feature is a tiled grid layout that displays many segmented objects simultaneously, allowing rapid quality control and annotation.

Key Features

  • Tiled Grid Layout: View 100+ cells at once in an organized montage
  • Batch Processing: Efficiently navigate through thousands of segmented objects
  • 2D & 3D Support: Works with both 2D image stacks and 3D volumetric data with scrollable Z-stacks
  • Dual View Modes:
    • Mosaic Mode: See all cells in batch simultaneously
    • Slide Mode: Navigate cell-by-cell with arrow keys
  • Interactive Annotation:
    • Alt + Click: Exclude/include individual cells
    • Shift + Click: Mark cells as positive (thresholding)
    • Quick Filters: DAPI intensity and nearest-neighbor distance sliders
  • Flexible Data Loading:
    • Legacy mode (all data in single .pkl)
    • Lazy mode (split per-scene .pkl files)
    • Minimal mode (on-the-fly cropping from original .lif/.tif files)
  • Multi-channel Thresholding: Set per-channel thresholds with interactive histograms
  • Smart Caching: Efficient caching for large 3D wholebrain datasets

Installation

Install directly from PyPI:

pip install napari-grid-curator

Or install latest development version:

pip install git+https://github.com/jojofranz/napari-grid-curator.git

Usage

From napari GUI

  1. Open napari
  2. Go to Plugins > Grid Curator
  3. Load your dataset (.pkl file)
  4. Use mouse interactions to annotate:
    • Alt + Click: Toggle cell inclusion/exclusion
    • Shift + Click: Mark cell as positive
  5. Set thresholds per channel using histogram widget
  6. Export annotated dataset when done

Supported Dataset Formats

The plugin works with three dataset modes:

  1. Legacy Mode: All images stored in single .pkl file
  2. Lazy Mode: Images split across per-scene .pkl files
  3. Minimal Mode: References to original .lif or .tif files with on-the-fly cropping

See DATASET_FORMATS.md for detailed format specifications.

Key Bindings

  • Alt + Click: Toggle cell exclusion (include/exclude)
  • Shift + Click: Toggle positive marker (for thresholding)
  • Arrow Keys: Navigate between cells in slide mode (Left/Right)
  • Mouse Wheel: Scroll through Z-slices (3D mode)

Use Cases

This plugin was originally developed for retinal ganglion cell (RGC) analysis but is applicable to:

  • Quality control of automated segmentations
  • Manual classification of cell types
  • Thresholding based on marker expression
  • Excluding edge artifacts or missegmented objects
  • Any workflow requiring rapid inspection of many segmented objects

Development

This plugin was generated using the napari-plugin-template and follows napari plugin best practices.

Dataset Preparation

Your dataset should include:

  • Images (2D or 3D, multi-channel)
  • Segmentation labels
  • Metadata table with regionprops (e.g., from skimage.measure.regionprops_table)

The plugin uses bounding boxes to crop regions around each segmented object for efficient visualization.

Contributing

Contributions are welcome! Please open an issue or pull request on GitHub.

License

Distributed under the terms of the MIT license. "napari-grid-curator" is free and open source software.

Issues

If you encounter any problems, please file an issue with:

  • Dataset format and size
  • Full error traceback
  • napari and plugin versions (napari --info)

Acknowledgements

This plugin was developed for wholebrain RGC analysis and uses (amongst others):

Development of this plugin was funded by NL-BioImaging AM and is happening in at the MCL.

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_grid_curator-0.1.1.tar.gz (82.2 kB view details)

Uploaded Source

Built Distribution

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

napari_grid_curator-0.1.1-py3-none-any.whl (70.8 kB view details)

Uploaded Python 3

File details

Details for the file napari_grid_curator-0.1.1.tar.gz.

File metadata

  • Download URL: napari_grid_curator-0.1.1.tar.gz
  • Upload date:
  • Size: 82.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.0

File hashes

Hashes for napari_grid_curator-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c8f4731370895096aa7fa39a6f53631e736589b8362be7cc32d097ee2b862d78
MD5 371699340e8e455b4b10c33a951b463b
BLAKE2b-256 18c16ec6dcfee7873a10b0a25847bf6f3349fe52b3b1278f08c79848d700b075

See more details on using hashes here.

File details

Details for the file napari_grid_curator-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for napari_grid_curator-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 99a284a0294bc1612d20d805f3a9914868125ab1a41ea76592463c606a9a843a
MD5 dbff6cb536273c52e10db651f54c652c
BLAKE2b-256 bd81e3318e2096511e8215c231f88a94ac23dca5458ab828e590e2a83c6e4ed2

See more details on using hashes here.

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