{"name":"napari-annotatorj","display_name":"napari-annotatorj","visibility":"public","icon":"","categories":[],"schema_version":"0.1.0","on_activate":null,"on_deactivate":null,"contributions":{"commands":[{"id":"napari-annotatorj.AnnotatorJ","title":"Create AnnotatorJ","python_name":"napari_annotatorj._dock_widget:AnnotatorJ","short_title":null,"category":null,"icon":null,"enablement":null},{"id":"napari-annotatorj.get_reader","title":"Get Reader","python_name":"napari_annotatorj._reader:napari_get_reader","short_title":null,"category":null,"icon":null,"enablement":null},{"id":"napari-annotatorj.write_labels","title":"Write Labels","python_name":"napari_annotatorj._writer:napari_write_labels","short_title":null,"category":null,"icon":null,"enablement":null},{"id":"napari-annotatorj.ExportFrame","title":"Create Export widget","python_name":"napari_annotatorj._dock_widget:ExportFrame","short_title":null,"category":null,"icon":null,"enablement":null}],"readers":[{"command":"napari-annotatorj.get_reader","filename_patterns":["<EDIT_ME>"],"accepts_directories":true}],"writers":[{"command":"napari-annotatorj.write_labels","layer_types":["labels"],"filename_extensions":[".tiff"],"display_name":"labels"}],"widgets":[{"command":"napari-annotatorj.AnnotatorJ","display_name":"AnnotatorJ","autogenerate":false},{"command":"napari-annotatorj.ExportFrame","display_name":"AnnotatorJExport","autogenerate":false}],"sample_data":null,"themes":null,"menus":{},"submenus":null,"keybindings":null,"configuration":[]},"package_metadata":{"metadata_version":"2.1","name":"napari-annotatorj","version":"0.0.7","dynamic":null,"platform":null,"supported_platform":null,"summary":"The napari adaptation of the ImageJ/Fiji plugin AnnotatorJ for easy image annotation.","description":"# napari-annotatorj\n\n[![License](https://img.shields.io/pypi/l/napari-annotatorj.svg?color=green)](https://github.com/spreka/napari-annotatorj/raw/main/LICENSE)\n[![PyPI](https://img.shields.io/pypi/v/napari-annotatorj.svg?color=green)](https://pypi.org/project/napari-annotatorj)\n[![Python Version](https://img.shields.io/pypi/pyversions/napari-annotatorj.svg?color=green)](https://python.org)\n[![tests](https://github.com/spreka/napari-annotatorj/workflows/tests/badge.svg)](https://github.com/spreka/napari-annotatorj/actions)\n[![codecov](https://codecov.io/gh/spreka/napari-annotatorj/branch/main/graph/badge.svg)](https://codecov.io/gh/spreka/napari-annotatorj)\n[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-annotatorj)](https://napari-hub.org/plugins/napari-annotatorj)\n\nThe napari adaptation of the ImageJ/Fiji plugin [AnnotatorJ](https://github.com/spreka/annotatorj) for easy image annotation.\n\n![image](https://drive.google.com/uc?export=view&id=1fVfvanffTdrXvLE0m1Yo6FV5TAjh6sb2)\n\n----------------------------------\n\nThis [napari] plugin was generated with [Cookiecutter] using with [@napari]'s [cookiecutter-napari-plugin] template.\n\n<!--\nDon't miss the full getting started guide to set up your new package:\nhttps://github.com/napari/cookiecutter-napari-plugin#getting-started\n\nand review the napari docs for plugin developers:\nhttps://napari.org/docs/plugins/index.html\n-->\n\n## Installation\n\nInstallation is possible with [pip](#pip), [napari](#bundled-napari-app) or [scripts](#script).\n### Pip\nYou can install `napari-annotatorj` via [pip]:\n\n    pip install napari[all]\n\tpip install napari-annotatorj\n\n\n\nTo install latest development version :\n\n    pip install git+https://github.com/spreka/napari-annotatorj.git\n\n\nOn Linux distributions, the following error may arise upon napari startup after the installation of the plugin: `Could not load the Qt platform plugin “xcb” in “” even though it was found`. In this case, the manual install of `libxcb-xinerama0` for Qt is required:\n\n\tsudo apt install libxcb-xinerama0\n\n### Bundled napari app\nThe bundled application version of [napari](https://github.com/napari/napari/releases) allows the pip install of plugins in the .zip distribution. After installation of this release, napari-annotatorj can be installed from the `Plugins --> Install/Uninstall plugins...` menu by searching for its name and clicking on the `Install` button next to it.\n\n### Script\nSingle-file install is supported on [**Windows**](#windows) and [Linux](#linux) (currently). It will create a virtual environment named `napariAnnotatorjEnv` in the parent folder of the cloned repository, install the package via pip and start napari. It requires a valid Python install.\n\n#### Windows\nTo start it, run in the Command prompt\n\n\tgit clone https://github.com/spreka/napari-annotatorj.git\n\tcd napari-annotatorj\n\tinstall.bat\n\nOr download [install.bat](https://github.com/spreka/napari-annotatorj/blob/main/install.bat) and run it from the Command prompt.\n\nAfter install, you can use [startup_napari.bat](https://github.com/spreka/napari-annotatorj/blob/main/startup_napari.bat) to activate your installed virtual environment and run napari. Run it from the Command prompt with:\n\n\tstartup_napari.bat\n\n\n#### Linux\nTo start it, run in the Terminal\n\n\tgit clone https://github.com/spreka/napari-annotatorj.git\n\tcd napari-annotatorj\n\tinstall.sh\n\nOr download [install.sh](https://github.com/spreka/napari-annotatorj/blob/main/install.sh) and run it from the Terminal.\n\nAfter install, you can use [startup_napari.sh](https://github.com/spreka/napari-annotatorj/blob/main/startup_napari.sh) to activate your installed virtual environment and run napari. Run it from the Terminal with:\n\n\tstartup_napari.sh\n\n***\n## Intro\n\nnapari-annotatorj has several convenient functions to speed up the annotation process, make it easier and more fun. These *modes* can be activated by their corresponding checkboxes on the left side of the main AnnotatorJ widget.\n\n- [Contour assist mode](#contour-assist-mode)\n- [Edit mode](#edit-mode)\n- [Class mode](#class-mode)\n- [Overlay](#overlay)\n\nFreehand drawing is enabled in the plugin. The \"Add polygon\" tool is selected by default upon startup. To draw a freehand object (shape) simply hold the mouse and drag it around the object. The contour is visualized when the mouse button is released.\n\nSee the [guide](#how-to-annotate) below for a quick start or a [demo](#demo).\n\n***\n## How to annotate\n\n1. Open --> opens an image\n2. (Optionally) \n\t- ... --> Select annotation type --> Ok --> a default tool is selected from the toolbar that fits the selected annotation type\n\t- The default annotation type is instance\n\t- Selected annotation type is saved to a config file\n3. Start annotating objects\n\t- [instance](#instance-annotation): draw contours around objects\n\t- [semantic](#semantic-annotation): paint the objects' area\n\t- [bounding box](#bounding-box-annotation): draw rectangles around the objects\n4. Save --> Select class --> saves the annotation to a file in a sub-folder of the original image folder with the name of the selected class\n\n5. (Optionally)\n\t- Load --> continue a previous annotation\n\t- Overlay --> display a different annotation as overlay (semi-transparent) on the currently opened image\n\t- Colours --> select annotation and overlay colours\n\t- ... (coming soon) --> set options for semantic segmentation and *Contour assist* mode\n\t- checkboxes --> Various options\n\t\t- (default) Add automatically --> adds the most recent annotation to the ROI list automatically when releasing the left mouse button\n\t\t- Smooth (coming soon) --> smooths the contour (in instance annotation type only)\n\t\t- Show contours --> displays all the contours in the ROI list\n\t\t- Contours assist --> suggests a contour in the region of an initial, lazily drawn contour using the deep learning method U-Net\n\t\t- Show overlay --> displays the overlayed annotation if loaded with the Overlay button\n\t\t- Edit mode --> edits a selected, already saved contour in the ROI list by clicking on it on the image\n\t\t- Class mode --> assigns the selected class to the selected contour in the ROI list by clicking on it on the image and displays its contour in the class's colour (can be set in the Class window); clicking on the object a second time unclassifies it\n\t- [^] --> quick export in 16-bit multi-labelled .tiff format; if classified, also exports by classes\n\n***\n## Instance annotation\nAllows freehand drawing of object contours (shapes) with the mouse as in ImageJ.\n\nShape contour points are tracked automatically when the left mouse button is held and dragged to draw a shape. The shape is closed when the mouse button is released, automatically, and added to the default shapes layer (named \"ROI\"). In direct selection mode (from the layer controls panel), you can see the saved contour points. The slower you drag the mouse, the more contour points saved, i.e. the more refined your contour will be.\n\nClick to watch demo video below.\n\n[![instance-annot-demo](https://drive.google.com/uc?export=view&id=1sBg19d_hqGH-UI8irkrwame7ZjrldwHr)](https://drive.google.com/uc?export=view&id=1wELreE9MdCZq4Kf4oCWdxIw4e5o05XzK \"Click to watch instance annotation demo\")\n\n***\n## Semantic annotation\nAllows painting with the brush tool (labels).\n\nUseful for semantic (e.g. scene) annotation. Currently saves all labels to binary mask only (foreground-background).\n\n***\n## Bounding box annotation\nAllows drawing bounding boxes (shapes, rectangles) around objects with the mouse.\n\nUseful for object detection annotation.\n\n***\n## Contour assist mode\nAssisted annotation via a pre-trained deep learning model's suggested contour.\n\n1. initialize a contour with mouse drag around an object\n2. the suggested contour is displayed automatically\n3. modify the contour:\n    - edit with mouse drag or \n    - erase holding \"Alt\" or\n\t- invert with pressing \"u\"\n4. finalize it\n    - accept with pressing \"q\" or\n    - reject with pressing \"Ctrl\" + \"Del\"\n\n- if the suggested contour is a merge of multiple objects, you can erase the dividing line around the object you wish to keep, and keep erasing (or splitting with the eraser) until the object you wish to keep is the largest, then press \"q\" to accept it\n- this mode requires a Keras model to be present in the [model folder](#configure-model-folder)\n\nClick to watch demo video below\n\n[![contour-assist-demo](https://drive.google.com/uc?export=view&id=1Mw2fCPdm5WHBVRgNnp8fGNmqxI84F_9I)](https://drive.google.com/uc?export=view&id=1VTd6RScjNfAwi3vMk-bU87U4ucPmOO_M \"Click to watch contour assist demo\")\n\n***\n## Edit mode\nAllows to modify created objects with a brush tool.\n\n1. select an object (shape) to modify by clicking on it\n2. an editing layer (labels layer) is created for painting automatically\n3. modify the contour:\n    - edit with mouse drag or \n    - erase holding \"Alt\"\n4. finalize it\n    - accept with pressing \"q\" or\n    - delete with pressing \"Ctrl\" + \"Del\" or\n    - revert changes with pressing \"Esc\" (to the state before editing)\n\n- if the edited contour is a merge of multiple objects, you can erase the dividing line around the object you wish to keep, and keep erasing (or splitting with the eraser) until the object you wish to keep is the largest, then press \"q\" to accept it\n\nClick to watch demo video below\n\n[![edit-mode-demo](https://drive.google.com/uc?export=view&id=1M-XdEWPXMsIOtO0ncyUtvGACS0SRX-3K)](https://drive.google.com/uc?export=view&id=10MQm53hblLKQlfBNrfUsi1vxvIdTbzCZ \"Click to watch edit mode demo\")\n\n***\n## Class mode\nAllows to assign class labels to objects by clicking on shapes.\n\n1. select a class from the class list to assign\n2. click on an object (shape) to assign the selected class label to it\n3. the contour colour of the clicked object will be updated to the selected class colour, plus the class label is updated in the text properties of object (turn on \"display text\" on the layer control panel to see the text properties as `objectID:(classLabel)` e.g. 1:(0) for the first object)\n\n- optionally, you can set a default class for all currently unlabelled objects on the ROI (shapes) layer by selecting a class from the drop-down menu on the right to the text label \"Default class\"\n- class colours can be changed with the drop-down menu right to the class list; upon selection, all objects whose class label is the currently selected class will have their contour colour updated to the selected colour\n- clicking on an object that has already been assigned a class label will unclassify it: assign the label *0* to it\n\nClick to watch demo video below\n\n[![class-mode-demo](https://drive.google.com/uc?export=view&id=1EV1cn_mySO11S_ZDFv6Dl1laAk30jGJk)](https://drive.google.com/uc?export=view&id=1uOmznUvfHEFvviWTtOnUHty8rkKyWR7Q \"Click to watch class mode demo\")\n\n***\n## Export\nSee also: [Quick export](#quick-export)\n\nThe exporter plugin AnnotatorJExport can be invoked from the Plugins menu under the plugin name `napari-annotatorj`. It is used for batch export of annotations to various formats directly suitable to train different types of deep learning models. See a [demonstrative figure](https://raw.githubusercontent.com/spreka/annotatorj/master/demos/annotation_and_export_types.png) in the [AnnotatorJ repository](https://github.com/spreka/annotatorj) and further description in its [README](https://github.com/spreka/annotatorj#export) or [documentation](https://github.com/spreka/annotatorj/blob/master/AnnotatorJ_documentation.pdf).\n\n1. browse original image folder with either the\n    - \"Browse original...\" button or\n    - text input field next to it\n2. browse annotation folder with either the\n    - \"Browse annot...\" button or\n    - text input field next to it\n3. select the export options you wish to export the annotations to (see tooltips on hover for help)\n    - at least one export option must be selected to start export\n    - (optional) right click on the checkbox \"Coordinates\" to switch between the default COCO format and YOLO format; see [explanation](#coordinate-formats)\n4. click on \"Export masks\" to start the export\n    - this will open a progress bar in the napari window and close it upon finish\n\nThe folder structure required by the exporter is as follows:\n\n```\nimage_folder\n\t|--- image1.png\n\t|--- another_image.png\n\t|--- something.png\n\t|--- ...\n\nannotation_folder\n\t|--- image1_ROIs.zip\n\t|--- another_image_ROIs.zip\n\t|--- something_ROIs.zip\n\t|--- ...\n```\n\nMultiple export options can be selected at once, any selected will create a subfolder in the folder where the annotations are saved.\n\n\nClick to watch demo video below\n\n[![exporter-demo](https://drive.google.com/uc?export=view&id=1QoaJrI9pKziUzYwiZNdWlfRD7PcvJB9U)](https://drive.google.com/uc?export=view&id=1uJz-x_ypEOjc7SYPUTqrEt0ieyNLFy6u \"Click to watch exporter demo\")\n\n***\n## Quick export\nClick on the \"[^]\" button to quickly save annotations and export to mask image. It saves the current annotations (shapes) to an ImageJ-compatible roi.zip file and a generated a 16-bit multi-labelled mask image to the subfolder \"masks\" under the current original image's folder.\n\n\n***\n## Coordinate formats\nIn the AnnotatorJExport plugin 2 coordinates formats can be selecting by right clicking on the Coordinates checkbox: COCO or YOLO. The default is COCO.\n\n*COCO format*:\n- `[x, y, width, height]` based on the top-left corner of the bounding box around the object\n- coordinates are not normalized\n- annotations are saved with header to \n    - .csv file\n    - tab delimeted\n\n*YOLO format*:\n- `[class, x, y, width, height]` based on the center point of the bounding box around the object\n- coordinates are normalized to the image size as floating point values between 0 and 1\n- annotations are saved with header to\n    - .txt file\n    - whitespace delimeted\n    - class is saved as the 1st column\n\n***\n## Overlay\nA separate annotation file can be loaded as overlay for convenience, e.g. to compare annotations.\n\n1. load another annotation file with the \"Overlay\" button\n\n- (optional) switch its visibility with the \"Show overlay\" checkbox\n- (optional) change the contour colour of the overlay shapes with the [\"Colours\" button](#change-colours)\n\n***\n## Change colours\nClicking on the \"Colours\" button opens the Colours widget where you can set the annotation and overlay colours.\n\n1. select a colour from the drop-down list either next to the text label \"overlay\" or \"annotation\"\n2. click the \"Ok\" button to apply changes\n\n- contour colour of shapes on the annotation shapes layer (named \"ROI\") that already have a class label assigned to them will **not** be updated to the new annotation colour, only those not having a class label (the class label can be displayed with the \"display text\" checkbox on the layer controls panel as `objectID:(classLabel)` e.g. 1:(0) for the first object)\n- contour colour of shapes on the overlay shapes layer (named \"overlay\") will all have the overlay colour set, regardless of any existing class information saved to the annotation file loaded as overlay\n\n***\n## Configure model folder\nThe Contour assist mode imports a pre-trained Keras model from a folder named *models* under exactly the path *napari_annotatorj*. This is automatically created on the first startup in your user folder:\n- `C:\\Users\\Username\\.napari_annotatorj` on Windows\n- `\\home\\username\\.napari_annotatorj` on Linux\n\nA pre-trained model for nucleus segmentation is automatically downloaded from the GitHub repository of the [ImageJ version of AnnotatorJ](https://github.com/spreka/annotatorj/releases/tag/v0.0.2-model). The model will be saved to `[your user folder]\\.napari_annotatorj\\models\\model_real.h5`. This location is printed to the console (command prompt or powershell on Windows, terminal on Linux).\n\n(deprecated) When bulding from source the model folder is located at *path\\to\\napari-annotatorj\\src\\napari_annotatorj\\models* whereas installing from pypi it is located at *path\\to\\virtualenv\\Lib\\site-packages\\napari_annotatorj\\models*.\n\nThe model must be in either of these file formats:\n- config .json file + weights file: *model_real.json* and *model_real_weights.h5*\n- combined weights file: *model_real.hdf5*\n\nYou can also train a new model on your own data in e.g. Python and save it with this code block:\n\n```python\n\t# save model as json\n\tmodel_json=model.to_json()\n\twith open(‘model_real.json’, ‘w’) as f:\n\t\tf.write(model_json)\n\t\n\t# save weights too\n\tmodel.save_weights(‘model_real_weights.h5’)\n\n```\nThis configuration will change in the next release to allow model browse and custom model name in an options widget.\n\n***\n## Demo\nRun a demo of napari-annotatorj with sample data: a small 3-channel RGB image as original image and an ImageJ roi.zip file as annotations loaded.\n\n```shell\n    # from the napari-annotatorj folder\n\tpython src/napari_annotatorj/load_imagej_roi.py\n```\nAlternatively, you can startup the napari-annotatorj plugin by running\n\n```shell\n    # from the napari-annotatorj folder\n\tpython src/napari_annotatorj/startup_annotatorj.py\n```\n\n***\n## Setting device for deep learning model prediction\nThe [Contour assist](#contour-assist-mode) mode uses a pre-trained U-Net model for suggesting contours based on a lazily initialized contour drawn by the user. The default configuration loads and runs the model on the CPU so all users can run it. It is possible to switch to GPU if you have:\n- a CUDA-capable GPU in your computer\n- nVidia's CUDA toolkit + cuDNN installed\n\nSee installation guide on [nVidia's website](https://developer.nvidia.com/cuda-downloads) according to your system.\n\nTo switch to GPU utilization, edit [_dock_widget.py](https://github.com/spreka/napari-annotatorj/blob/main/src/napari_annotatorj/_dock_widget.py#L112) and set to the device you would like to use. Valid values are `'cpu','0','1','2',...`. The default value is `cpu`. The default GPU device is `0` if your system has any CUDA-capable GPU. If the device you set cannot be found or utilized by the code, it will fall back to `cpu`. An informative message is printed to the console upon plugin startup.\n\n***\n## Contributing\n\nContributions are very welcome. Tests can be run with [tox], please ensure\nthe coverage at least stays the same before you submit a pull request.\n\n## License\n\nDistributed under the terms of the [BSD-3] license,\n\"napari-annotatorj\" is free and open source software\n\n## Issues\n\nIf you encounter any problems, please [file an issue] along with a detailed description.\n\n[napari]: https://github.com/napari/napari\n[Cookiecutter]: https://github.com/audreyr/cookiecutter\n[@napari]: https://github.com/napari\n[MIT]: http://opensource.org/licenses/MIT\n[BSD-3]: http://opensource.org/licenses/BSD-3-Clause\n[GNU GPL v3.0]: http://www.gnu.org/licenses/gpl-3.0.txt\n[GNU LGPL v3.0]: http://www.gnu.org/licenses/lgpl-3.0.txt\n[Apache Software License 2.0]: http://www.apache.org/licenses/LICENSE-2.0\n[Mozilla Public License 2.0]: https://www.mozilla.org/media/MPL/2.0/index.txt\n[cookiecutter-napari-plugin]: https://github.com/napari/cookiecutter-napari-plugin\n\n[file an issue]: https://github.com/spreka/napari-annotatorj/issues\n\n[napari]: https://github.com/napari/napari\n[tox]: https://tox.readthedocs.io/en/latest/\n[pip]: https://pypi.org/project/pip/\n[PyPI]: https://pypi.org/\n","description_content_type":"text/markdown","keywords":null,"home_page":"https://github.com/spreka/napari-annotatorj","download_url":null,"author":"Reka Hollandi","author_email":"reka.hollandi@gmail.com","maintainer":null,"maintainer_email":null,"license":"BSD-3-Clause","classifier":["Development Status :: 3 - Alpha","Intended Audience :: Developers","Framework :: napari","Topic :: Software Development :: Testing","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3.7","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Operating System :: OS Independent","License :: OSI Approved :: BSD License"],"requires_dist":["napari","napari-plugin-engine (>=0.1.4)","numpy","roifile","scikit-image","opencv-python (>=4.5.5)","keras","tensorflow (>=2.5.0)","tifffile","imagecodecs"],"requires_python":">=3.7","requires_external":null,"project_url":["Bug Tracker, https://github.com/spreka/napari-annotatorj/issues","Documentation, https://github.com/spreka/napari-annotatorj#README.md","Source Code, https://github.com/spreka/napari-annotatorj","User Support, https://github.com/spreka/napari-annotatorj/issues"],"provides_extra":null,"provides_dist":null,"obsoletes_dist":null},"npe1_shim":false}