Skip to main content

Simple napari plugin to erase the current label value in 3D for an entire Labels volume.

Project description

napari-3d-label-eraser

A simple tool to erase a selected label across an entire 3D volume in napari.

Overview

napari-3d-label-eraser provides a fast and convenient way to remove all voxels belonging to a given label in a 3D Labels layer.
This is useful for cleaning segmentation results, removing misdetected objects, or performing manual corrections in volumetric datasets.

The plugin adds a dock widget featuring:

  • a dropdown menu to select the target Labels layer,
  • a button to erase the currently selected label across the entire 3D volume,
  • optional usage instructions.

A keyboard shortcut (A) can also be used to trigger the erase operation directly from the viewer.

Features

  • Erase all voxels of the selected label throughout a 3D volume.
  • Dropdown to choose the active Labels layer.
  • Compatible with napari’s label picker (L key).
  • Optional keyboard shortcut (A) for quick editing.
  • Minimal, lightweight, and easy to integrate into existing workflows.

Installation

Install with pip:

pip install napari-3d-label-eraser

Or install from the napari plugin manager:

Plugins → Install/Uninstall Plugins

For development installation:

git clone https://github.com/koopa31/napari-3d-label-eraser.git
cd napari-3d-label-eraser
pip install -e .

Usage

  1. Load a Labels layer in napari.
  2. Open the plugin:
    Plugins → 3D Label Eraser → 3D Label Eraser
  3. In the widget:
    • Select your target Labels layer.
    • Choose the label to erase using the label picker (L key).
    • Click the button to erase that label across the full 3D volume.
  4. Alternatively, press A to erase the current label directly from the viewer (focus must be on the viewer).

Notes

  • The plugin operates only on Labels layers.
  • The erase action sets all voxels with the selected label to 0.
  • The A shortcut is registered automatically when the widget is opened.

Contributing

Issues, feature requests, and pull requests are welcome.

License

This project is released under the MIT License.

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

Uploaded Source

Built Distribution

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

napari_3d_label_eraser-0.1.0-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for napari_3d_label_eraser-0.1.0.tar.gz
Algorithm Hash digest
SHA256 9a32e183a5c674d12cb86b51a56540b311a00bb1a8e4348f2a08e967a6593523
MD5 0d361c415259d64cbe045f2e9f1e112d
BLAKE2b-256 690319b979d4c15a949a29fa32e4413a0c53f026065eb224b02fae63392e66d9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for napari_3d_label_eraser-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c38275db901b20c6d64edcf39c07b1d4c82d1ae95b3b89becd7341b1f957b6c8
MD5 80d8ee524f2a1af93bc5a4ee47e9ad98
BLAKE2b-256 3c16301e000f091282d2a62a545594c940921f925d610821e656fbee54d9c13b

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