Skip to main content

Livewire-based annotation of objects.

Project description

🪄 napari-magic-wand

Object annotation in Napari using magic wands (shortest path algorithms). This plugin supports annotation in 2D (grayscale and RGB), 2D+t (grayscale, frame by frame) and 3D images (slice by slice). It can be used to annotate paths or the contour of solid objects.

The plugin provides two annotation functions:

  • The Magic wand tool is based on the PyIFT library. Use it to trace annotations that follow the intensity gradients in the image.
  • The Brightest path tool is based on the Brightest Path Lib library. Use it to trace annotations that follow the brightest (or darkest) path between two points.

Related plugins

Take a look at these related plugins that offer similar functionality and slightly different user interactions.

Installation

You can install napari-magic-wand via pip:

pip install napari-magic-wand

Usage

  • Select the tool of your choice from the Plugins menu of Napari.
  • Open an image to annotate (2D, 2D+t, or 3D).
  • Click on the button "Start live wire". A new Labels layer Live wire (current edit) should appear.
  • Click on the image to annotate paths interactively.
  • Double-click to confirm an annotation and move to the next.

Options and parameters

  • Close and fill objects: You can fill (or not) the inside of the annotated object. Do not tick this option if you are annotating paths (e.g. filament-like strucutres).
  • Auto-increment label index: Tick this option to increment the label index every time a new object is completed (e.g. if you are annotating multiple objects).
  • Sigma: Higher values of sigma increase the "stickiness" of the object boundaries to the magic wand.
  • Black ridges: Tick this checkbox if you are annotating dark paths on a bright background.

Contributing

Contributions are very welcome. Please get in touch if you'd like to be involved in improving or extending the package.

License

Distributed under the terms of the BSD-3 license, "napari-magic-wand" is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.


This napari plugin was generated with Cookiecutter using @napari's cookiecutter-napari-plugin template.

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-magic-wand-0.0.3.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

napari_magic_wand-0.0.3-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file napari-magic-wand-0.0.3.tar.gz.

File metadata

  • Download URL: napari-magic-wand-0.0.3.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for napari-magic-wand-0.0.3.tar.gz
Algorithm Hash digest
SHA256 1330e05048c57ab1a2e3deed22ede22cc83e522dea8e6c4f4646ac3c39b2b615
MD5 b6abd1ac3a3c36bb9276386e895ea855
BLAKE2b-256 684d7bc34a7525f900f85ec8977714b60f89741e1c3a3fe9ea4efcf3d91e588f

See more details on using hashes here.

File details

Details for the file napari_magic_wand-0.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for napari_magic_wand-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0f21b22aa183a27ebb3c726cad640c20dfe260863504710f1d8986d0510c0ba6
MD5 f1148ef72ef1107dd9e6a0789aef9781
BLAKE2b-256 23b6c79087cb2abd73cacc81510558cbf3334f6ebc8650d1128bcfc72b7643ed

See more details on using hashes here.

Supported by

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