Skip to content

Image annotation with ImJoy

This is performed with the Annotator plugin running in ImJoy.

Note that annotation can only be performed on 2D images. If your images are 3D, please convert them first to 2D images, e.g. with a maximum intensity projection.

To annotate your images, follow these steps

  1. Open the annotation plugin by clicking on the plugin name ImageAnnotator
  2. The plugin will open with a default image and you have to load your own data.

    1. Press on the File dropdown menu in the upper right corner
    2. Select Import Samples
    3. In the new dialog press Choose Files and then Select Local Files. In case your files are on a different drive, you can specify the drive from Options and Go to folder.
    4. In the dialog, select the parental folder containing all sample folders.
    5. ImJoy will display a dialog saying "This will upload ....", confirm. Your data only be "uploaded" to your local browser BUT not on an external website.
    6. This will populate the interface with all sample folders. For each folder, you see a little icon representing a file being present in the folder. You then have to set a filter on the file-name for the channel which will be read into the Annotator plugin. For this you set a name for the channel, e.g. FISH, and the identifier of this image, e.g. green.tif. Press Add Channel to add this channel. You then see this channel as an additional entry in the interface.
    7. Press Import to open the Annotator with the specified files.
    8. You then specify your annotation: from the Annotation dropdown menu, you can specify which annotations you want to perform.
    9. By pressing New Marker you can specify an new annotation type. You can define its name, the colour in which it will show, and what type (use Polygon).
    10. Once you defined the annotation types, you can annotate your image.
  3. Then select which file you want to annotate (from the File dropdown menu), and annotate the two different regions. To annotate, press on one of the annotation types, go to the image, and start annotating. For a polygon, simply press the mouse button, draw your region and release once your are done. The example below shows two annotation types, CV and PL.

  1. Once you are done, you can export the annotations from the Exports dropdown menu and selecting the All annotations option.
    1. The annotations will be saved in the default download folder of your browser as a zip file.
    2. You can then unzip this file. It contains the same folder structure as your original parental folder. Each sample folder contains a file annotation.json with the annotations that your created for this sample.
    3. You can then simply copy the sample folders and paste them in the parental folder containing your data (with Windows explorer or Mac OS finder). When asked if you want to merge the folders, confirm.