Skip to main content

Task-based EM image processing assistant for napari.

Project description

napari-em-assistant

Task-based electron microscopy image processing tools for napari.

napari-em-assistant is organized around small, explicit processing tasks that can be used interactively on an active napari layer or applied to folders of EM images. The first task is ImageJ/Fiji-style local contrast enhancement with CLAHE.

Current Task

Enhance Local Contrast CLAHE

The CLAHE task provides a napari widget for 2D grayscale EM images and 3D grayscale stacks. It follows the ImageJ/Fiji dialog shape and default values:

  • block size: 127
  • histogram bins: 256
  • maximum slope: 3.00
  • mask: *None*
  • fast: checked

The widget can:

  • show a top CUDA status bar for CuPy CUDA and OpenCV CUDA CLAHE availability
  • preview CLAHE on the active image layer
  • apply CLAHE to the active 2D image layer or 3D grayscale stack
  • create a new layer named <source_layer_name>_CLAHE
  • batch process TIFF folders to an output folder
  • show batch progress with load/process checks, status, and output path

Backends

  • opencv_cpu: fast CPU approximation using cv2.createCLAHE.
  • imagej_reference: Python implementation ported from Fiji's mpicbg.ij.clahe.PlugIn 2D grayscale CLAHE path. 3D stacks are processed slice-by-slice.
  • gpu_cupy: optional CuPy/CUDA batch backend. If CuPy or a CUDA device is not available, it falls back to opencv_cpu.

The CUDA status bar is diagnostic: CuPy indicates whether the GPU CuPy backend can run on CUDA now, while OpenCV CUDA CLAHE reports whether the installed OpenCV build exposes CUDA CLAHE support.

OpenCV CLAHE parameters are not identical to ImageJ/Fiji CLAHE parameters. Use imagej_reference when Fiji-style output is the priority. Current OpenCV and CuPy paths should be treated as practical approximations.

Install

From this repository:

pip install -e .

Optional CuPy support depends on the workstation CUDA stack. A convenience extra is provided:

pip install -e ".[gpu]"

If that wheel does not match the local CUDA runtime, install the correct CuPy package manually and keep the base plugin install CPU-only.

Use In napari

After installation, open napari and choose:

Plugins > Enhance Local Contrast CLAHE

For interactive use, select a 2D grayscale image layer or 3D grayscale stack and use Preview or Apply to Active Layer.

For batch use, choose an input folder containing 2D images or 3D grayscale stacks saved as .tif or .tiff files, choose an output folder, select a backend, and run the batch. Outputs are saved as:

<stem>_clahe.tif

Validation

The current implementation is tested for:

  • widget and backend imports
  • Fiji-derived imagej_reference fast and exact paths
  • OpenCV CLAHE on synthetic uint8 and uint16 images
  • shape preservation
  • dtype preservation where possible
  • 3D stack support
  • GPU stub behavior
  • gpu_cupy CPU fallback behavior
  • batch result and progress reporting

Run tests with:

python3 -m pytest tests/tasks/test_enhance_local_contrast_clahe.py

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_em_assistant-0.1.0.tar.gz (16.9 kB view details)

Uploaded Source

Built Distribution

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

napari_em_assistant-0.1.0-py3-none-any.whl (20.8 kB view details)

Uploaded Python 3

File details

Details for the file napari_em_assistant-0.1.0.tar.gz.

File metadata

  • Download URL: napari_em_assistant-0.1.0.tar.gz
  • Upload date:
  • Size: 16.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for napari_em_assistant-0.1.0.tar.gz
Algorithm Hash digest
SHA256 c83059c80f523ba464a93ee8bacdf310c8eacc4f71bf38df8949d791fe0ffd96
MD5 1c48a505bf15d99de9fcfa62fdb5e445
BLAKE2b-256 1da2cb8c261c8f7a76dd65c0bba8816f79e777b531d61b3f6e594cb1b04974c0

See more details on using hashes here.

File details

Details for the file napari_em_assistant-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for napari_em_assistant-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ef27c399031ab15ddef1c3a9d21c46aa519b835dfa79eee7875f07586e7ccc8b
MD5 994db0ea13bc1b7d4e48d23778f0b4e0
BLAKE2b-256 c8e828af382f68de9bcf4682f694c3588fe02acafcd39534cbdd120b6247d0f8

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