napari-allencell-annotator

A plugin that enables annotations provided by Allen Institute for Cell Science


License
BSD-3-Clause
Install
pip install napari-allencell-annotator==0.0.5

Documentation

napari-allencell-annotator

License BSD-3 PyPI Python Version tests codecov napari hub

A plugin that enables image annotation/scoring and writes annotations to a .csv file. Plugin provided by the Allen Institute for Cell Science.

The Allen Cell Image Annotator plugin for napari provides an intuitive graphical user interface to create annotation templates, annotate large image sets using these templates, and save image annotations to a csv file. The Allen Cell Image Annotator is a Python-based open source toolkit developed at the Allen Institute for Cell Science for both blind, unbiased and un-blind microscope image annotating. This toolkit supports easy image set selection from a file finder and creation of annotation templates (text, checkbox, drop-down, and spinbox). With napari's multi-dimensional image viewing capabilities, the plugin seamlessly allows users to view each image and write annotations into the custom template. Annotation templates can be written to a json file for sharing or re-using. After annotating, the annotation template, image file list, and the annotation values are conveniently saved to csv file, which can be re-opened for further annotating.

  • Supports the following image types:
    • OME-TIFF
    • TIFF
    • CZI
    • PNG
    • JPEG

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

Installation

1. Prerequisites

The plugin requires Conda.

2. Install the plugin

Click the link corresponding to your OS.

Windows

  • From the link above, click the three dots on the top menu bar and select download.
  • Open a file explorer and go to the Downloads folder. Use Option 1 below. A prompt window should open and start installing. If this fails use Option 2.
    • Option 1: Double-click the file install_napari.sh
    • Option 2: Search the file finder for Anaconda Prompt. Open version 3. Run the following commands one line at a time.
      • conda create -n napari_annotator python=3.9 anaconda
      • conda activate napari_annotator
      • python -m pip install --upgrade pip
      • python -m pip install "napari[all]"
      • python -m pip install napari-allencell-annotator
      • napari
    • Still not working? Try using conda forge instead of pip.
      • Ex: conda install -c conda-forge napari instead of python -m pip install "napari[all]"

MacOS/Unix

  • From the link above, download the file.
  • Open terminal.
  • Run chmod +x ./Downloads/install_napari.command
    • If you get a file not found error try adjusting the path to match where install_napari.command was downloaded.
  • Open finder, navigate to the file, double-click install_napari.command .
    • A terminal window should open and start installing.

3. Launch the Plugin

Once the napari window opens, go to Plugins.

  • If napari-allencell-annotator: Annotator is listed click it to launch.
  • If it is not listed
  • Install/Uninstall Plugins ⇨ check the box next to napari-allencell-annotatorclosePluginsnapari-allencell-annotator: Annotator .

4. Re-opening the Plugin After Installing

  • Windows
    • Search for anaconda navigator in file finder
    • Click on navigator version 3
    • Once the navigator opens, click Environments on the left side
    • Click on the annotator environment and wait for it to load
    • Press the play button
    • Type napari in the prompt that opens
    • Click Pluginsnapari-allencell-annotator: Annotator
  • MacOS
    • Open terminal
    • Run these commands one line at a time
      • conda activate napari_annotator
      • napari
    • Click Pluginsnapari-allencell-annotator: Annotator

Quick Start

  1. Open napari
  2. Start the plugin
    • Open napari, go to "Plugins" ⇨ "napari-allencell-annotator".
  3. Create or import annotations and add images to annotate.

For more detailed usage instructions, check out this document

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-allencell-annotator" is free and open source software

Issues

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