A toolbox for annotating objects one by one in nD
A toolbox for annotating objects one by one in nD.
This plugin contains some tools to make 2D/3D (and technically any dimensional) annotation easier. Main features:
- auto-filling labels
- label slice interpolation (geometric mean, RPSV representation)
- minimal contour segmentation
- list objects annotated with bounding boxes
- visualize selected objects from different projections
You can install
napari-nD-annotator via pip:
pip install napari-nD-annotator
There are some functionalities which require additional Python packages.
The bounding box and object list functionality requires the
napari-bbox Python package.
If you want to use these features, install
napari-bbox separately either using pip or directly from napari.
You can also install it together with this plugin:
pip install napari-nD-annotator[bbox]
napari-bboxplugin currently works only with
napari<=0.4.17. Do not install it with newer versions.
pip install minimal-surface
Or bundled with the plugin:
pip install napari-nD-annotator[ms]
minimal-surfacepackage is only available for Windows at the time. We are actively working on bringing it to Linux and Mac systems as well.
If you would like to install all optional packages, use
pip install napari-nD-annotator[all]
If any problems occur during installation or while using the plugin, please file an issue.
You can start napari with the plugin's widgets already opened as:
napari -w napari-nD-annotator "Object List" "Annotation Toolbox"
The main idea is to create bounding boxes around objects we want to annotate, crop them, and annotate them one by one. This has mainly two advantages when visualizing in 3D:
- We don't have to load the whole data into memory
- The surrounding objects won't occlude the annotated ones, making it easier to check the annotation.
Bounding boxes can be created from the
Object list widget. The dimensionality of the bounding box layer will be determined from the image layer. As bounding boxes are created, a small thumbnail will be displayed.
The proposed pipeline goes as follows:
- Create a bounding box layer
- Select data parts using the bounding boxes
- Select an object from the object list
- Annotate the object
- Repeat from 3.
Interpolation tab contains tools for estimating missing annotation slices from existing ones. There are multiple options:
- Geometric: the interpolation will be determined by calculating the average of the corresponding contour points.
- RPSV: A more sophisticated average contour calculation, see the preprint here.
- Distance-based: a signed distance transform is applied to the annotations. The missing slices will be filled in using their weighted sum.
Note: Geometric and RPSV interpolation works only when there's a single connected mask on each slice. If you want to interpolate disjoint objects (e.g. dividing cells), use distance based interpolation instead.
Note: Distance-based interpolation might give bad results if some masks are too far away from each other on the same slice and there's a big offset compared to the other slice used in the interpolation. If you get unsatisfactory results, try annotating more slices (skip less frames).
This plugin can estimate a minimal contour, which is calculated from a point set on the edges of the object, which are provided by the user. This contour will follow some kind of image feature (pixels with high gradient or high/low intensity). Features:
- With a single click a new point can be added to the set. This will also extend the contour with the curve shown in red
- A double click will close the curve by adding both the red and gray curves to the minimal contour
- When holding
Shift, the gray and red highlight will be swapped, so the other curve can be added to the contour
- With the
Ctrlbutton down a straight line can be added instead of the minimal path
- If the anchor points were misplaced, the last point can be removed by right-clicking, or the whole point set can be cleared by pressing
Paramvalue at the widget will decide, how strongly should the contour follow edges on the image. Higher value means higher sensitivity to image data, while a lower value will be closer to straight lines.
- Different features can be used, like image gradient or pixel intensities, and also user-defined features (using Python)
- the image is accessed as the
imagevariable, and the features should be stored in the
featuresvariable in the small code editor widget
- the image is accessed as the
This functionality can be used by selecting the
Minimal Contour tab in the
Annotation Toolbox widget, which will create a new layer called
Warning: Do not remove the
Warning: Some utility layers appear in the layer list when using the plugin. These are marked with a lock (:lock:) symbol. Do not remove them or modify their data, as this will most probably break the plugin! However, you can change their appearance, e.g. their color settings.
|Increment selected label
Shift + Wheel ⬆️
|Decrement selected label
Shift + Wheel ⬇️
Ctrl + Wheel ⬆️*
Ctrl + Wheel ⬇️*
|Increase paint brush size of labels layer
Alt + Wheel ⬆️
|Decrease paint brush size of labels layer
Alt + Wheel ⬇️
|Change between 'Anchors' and the labels layer
|Jump to layer
*Built-in functionality of napari
Note: you can check the list of available shortcuts by clicking the
?button in the bottom right corner of the main widget.
Distributed under the terms of the BSD-3 license, "napari-nD-annotator" is free and open source software
If you encounter any problems, please file an issue along with a detailed description.
- 14 February 2024
- 01 June 2022
- Information not submitted
- Stars: 22
- Forks: 1
- Issues + PRs: 11