Skip to content

Latest commit

 

History

History
98 lines (64 loc) · 4.61 KB

README.md

File metadata and controls

98 lines (64 loc) · 4.61 KB

napari-cell-centroid-annotator

License MIT PyPI Python Version tests codecov napari hub

A simple plugin to annotate cell centroids in 2D or 3D images


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

Short discription

Easily annotate cell centroids in 2D/3D images. While annotating, every annotated point gets a random color to increase your focus and overview while annotating. Annotated points get a radius to make it easier to see which cells were already annotated when you are in a neighboring slice of its centroid.

3D image with annotated centroids Sequence of slices 3D image with annotated centroids

Installation

You can install napari-cell-centroid-annotator via pip:

pip install napari-cell-centroid-annotator

To install latest development version :

pip install git+https://github.com/tim-vdl/napari-cell-centroid-annotator.git

While strictly not required, it is recommended to install this plug-in into a virtual environment, like this:

conda create -y -n napari-env -c conda-forge python=3.9
conda activate napari-env
pip install napari-cell-centroid-annotator

Usage

Get started by importing a 2D/3D image, either by drag-and-drop into the viewer, or via the menu on top. Next, create a new or import an existing points layer.

Then, start the Centroid Annotation Widget from the Plug-in menu.

Start the plug-in

Afterwards, select the points layer in the widget that opened on the right and click "Run" to confirm to use this layer for centroid annotation.

Run the plug-in

Finally, you can start annotating by adding new points, or by editing the existing points.

Run the plug-in

To get an overview of all annotated points, be sure to have the points layer selected in the layer list and open the Points Table plug-in from the Plug-in menu. This plug-in opens a table with the face color and coordinates of every point. From the table, you can now select points in the viewer, and vice-versa. This can come in handy when you want to edit/remove some points.

Table overview

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 MIT license, "napari-cell-centroid-annotator" is free and open source software

Issues

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