A lightweight plugin extending label layer control
Project description
napari-annotator
A lightweight plugin extending label layer control.
This napari plugin was generated with Cookiecutter using @napari's cookiecutter-napari-plugin template.
Description
This lightweight plugin helps you navigate your labels layer. It is intended to ease your manual annotation work.
- 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.
Usage
Start the plugin Plugins > napari-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
- Lag when drawing (probably related to this issue).
- Locating / moving to the center of a label only works on 2D/3D label layers, i.e.:
- single- / multi-channel 2D label layers.
- single-channel 3D label layers (the third dimension being either Z or T).
- Maximum 255 labels supported. Increasing number of supported label is possible, but when increasing it, colors in the canvas will mismatch the layer control and plugin entries (probably related to this issue)
- 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file napari_annotator-0.0.4.tar.gz
.
File metadata
- Download URL: napari_annotator-0.0.4.tar.gz
- Upload date:
- Size: 236.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 15177d50d820c22afc5f70c7d02e4ef56f7ed52a1453c2c692eb488beb2beb7f |
|
MD5 | b6f735c8661f18fa61658225898d105b |
|
BLAKE2b-256 | 415e21cbc3cd0dbdd1bd0a69cc9cfecb4bd5986c16ec77aa55b2af3d3a13f16e |
File details
Details for the file napari_annotator-0.0.4-py3-none-any.whl
.
File metadata
- Download URL: napari_annotator-0.0.4-py3-none-any.whl
- Upload date:
- Size: 14.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2584c26f482c57ca6413c15020add5348fe606c41bfc4b81ce1e6c8c70fbcf23 |
|
MD5 | 6022f493339d35c5b892d50ea1b899d6 |
|
BLAKE2b-256 | f594d1bf43b013e38fca37afc349684abcf9c2ea7c4c8556d353ccb9c7a253ca |