Skip to main content

A lightweight plugin extending label layer control

Project description

napari-annotator

License BSD-3 PyPI Python Version tests codecov napari hub

A lightweight plugin extending label layer control.


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

Description

This lightweight plugin helps you navigate your labels layer. It is intended to ease your manual annotation work. Overview image

  • Select a label from the list.
  • Toggle the visibility of individual label entries.
  • Move to the centroid of a label at the current zoom.
  • Change the color of individual labels.
  • Erase all drawn pixels of a given label.
  • Restore an erased label.

Version >=0.1.0 works for napari version >= 0.5.5

Version <0.1.0 should work for napari version < 0.4.19

Usage

Start the plugin Plugins > Annotator (Annotator).

The plugin will list available labels once a labels layer is selected and labels drawn.

Color shuffling for labels will not work, since the plugin sets the color mode of the layer to direct. But you can always change the color of individual labels, using the color picker.

Known limitations

  1. Locating / moving to the center of a label only works on 2D/3D label layers, i.e.:
    1. single- / multi-channel 2D label layers.
    2. single-channel 3D label layers (the third dimension being either Z or T).
  2. (Theoretical) maximum of 20'000 labels supported.
  1. Restoring an erased labels is lost after switching between layers.

Installation

You can install napari-annotator via pip:

pip install napari-annotator

To install latest development version :

pip install git+https://github.com/loicsauteur/napari-annotator.git

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 BSD-3 license, "napari-annotator" is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description. Or open a thread on forum.image.sc with a detailed description and a @loicsauteur tag.

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

Uploaded Source

Built Distribution

napari_annotator-0.1.1-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: napari_annotator-0.1.1.tar.gz
  • Upload date:
  • Size: 237.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for napari_annotator-0.1.1.tar.gz
Algorithm Hash digest
SHA256 897ac292682469a2c4eb15af393f3950df8151e53a30e74e2f4fd54711da8175
MD5 869999f6bafaa3f2aa94f4038b882108
BLAKE2b-256 ae8da8f6fed4d1112d6c5d6450332e83f48d279dca026ac37cd0ef0cc939694f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for napari_annotator-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 93b80d36d5b6e17939dd1e86e1729091c3abf110dafdf48d246c33419989dbad
MD5 641cee0fc3a226d807cd013a727ca005
BLAKE2b-256 138c8d0c88c143177f5139d3577ff995b356520f9ca0acf947b35b40102a5baf

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