2. How to use

2.1. Before starting

2.1.1. Directory structure

Before starting ReNomTAG, we will introduce the directory structure.

Assuming that you run ReNomTAG from working_directory, image datasets must be aligned according to the following directory structure.

The directory names for the public, dataset and label directories must not be changed.

The role of each directory is described below.

  • public
    This is the root directory for datasets. The directory name public must not be changed.
  • user1, user2…
    These directories contain image data and user-created label data for each user. These directories’ names can be changed.
  • dataset
    This directory contains image data for tagging.
  • label
    User-created label data will be automatically saved into this directory.
working_directory # Current Working directory
    │
    └── public # This name must be `public`.
        │
        ├── user1 # Dataset for user1. You can use any name for this directory.
        │   ├── dataset # Directory in which image data is placed. This name must be `dataset`.
        │   │   ├── image1.jpg
        │   │   ├── image2.jpg
        │   │   ├── ...
        │   │   └── imageN.jpg
        │   └── label # Directory to which tag data will be output. This name must be `label`.
        │       ├── image1.xml
        │       ├── image2.xml
        │       ├── ...
        │       └── imageN.xml
        │
        ├── user2 # Dataset for user2
        │   │
       ...   ...
        │
        └── userN
            ├── dataset
            │   ├── image_car1.jpg
            │   └── image_car2.jpg
            └── label
                ├── image_car1.xml
                └── image_car2.xml

2.1.2. Provide image data

Please place the image data into the dataset directory.

ReNomTAG is only able to load file names with halfwidth-alphanumeric (0-9, a-z, A-Z) and under-bar (_) characters. Filenames with, for example, hyphen (-), asterisk(*), etc cannot be loaded.

ReNomTAG supports images with “.jpeg”, “.jpg”, “.png”, or “.bmp” file extensions.


2.2. Run server

For running ReNomTAG, please use following command in your working directory.

renom_tag

This command has the following options.

# Run with port 8081
renom_tag --port 8081

Then type the following URL into your web browser.

../_images/how_to_use02.png

The public directory will be loaded and following screen will be displayed.

../_images/how_to_use01.png

2.3. Add tags to images

2.3.1. Create tags (bounding boxes)

You can create a tag (bounding box) by dragging the cursor inside the image.

../_images/how_to_use08.png

Note

For saving the tag (a pair of bounding boxes and tag name), a class tag name is required.

2.3.2. Save tags

To save the tag, please click the save button. The Space key also acts as a shortcut for saving.

2.3.3. Hide all unselected tags

You can choose to hide unselected boxes by clicking the toggle button. Ctrl+d can also be used as a shortcut for this. New boxes can still be added in this mode. Return to the normal view by clicking the toggle button or using Ctrl+d again.

../_images/how_to_use13.png

2.3.4. Set shortcut keys for class tags

You can set a shortcut key for each class tag name.

2.3.5. Default shortcut keys for faster tagging

ReNomTAG provides the following default shortcuts for faster tagging.

  • Ctrl+b : Copy all boxes from previous image and paste on current image.
  • Ctrl+c, Ctrl+v : Copy currently selected box and paste on current image.
  • Ctrl+z : Undo previous change to box (shape, position, or class tag).

2.3.6. Full-screen tagging

Tag in full-screen mode with the Ctrl+w or clicking the third icon at the bottom of the current image. Return to normal mode by using the same shortcut or clicking the same icon.

../_images/how_to_use10.png

2.3.7. Expanding/shrinking images during tagging

Expand or shrink the active image by using the trackpad or the + or - buttons in the toolbar at the bottom of the image. Return to the original image size by clicking the second icon on the toolbar.

../_images/how_to_use11.png

2.3.8. Filter images

You can filter the images to be shown.

  • All : Show all images.
  • Need Review : Show images marked neither OK nor NG.
  • No Tags : Show images with no tags.
  • OK : Show images marked as OK by admin user.
  • NG : Show images marked as NG by admin user.
../_images/how_to_use07.png

2.4. Admin mode

Admin mode has the following functions.

  • Create new class tags.
  • Mark tagged images as OK or NG.
  • Add comments to tagged images.

2.4.1. Enter admin mode

To enter admin mode, please add admin to the URL as shown below.

../_images/how_to_use03.png

The title of the page should change to Admin.

../_images/how_to_use04.png

2.4.2. Add new class tags

If you are in admin mode, you can add new class tags. To do this, type the new class tag name into the form shown below.

Next, click the Add New Tag button.

You can also add a shortcut key. The shortcut key can be changed in either admin or normal mode.

../_images/how_to_use05.png

2.4.3. Delete class tags

If you are in admin mode, you can also delete existing class tags. To do this, click the Delete Tag List button shown in red below.

Next, select the individual tags you would like to delete, and click Delete.

../_images/how_to_use12.png

2.4.4. Apply marks to images

Admin mode also provides a marking function. You can mark tagged images as OK or NG.

To apply a mark, please click the OK or NG button.

../_images/how_to_use06.png

After clicking the save button, the mark will be saved.

2.4.5. Add comments to images

You can also add comments to images. Users in normal mode can view comments but they cannot edit or add them.

2.4.6. Return to normal mode

To return to normal mode, please remove admin from the URL.


2.5. Use ReNomTAG with multiple users

You can add multiple user directories under the public folder and then choose which directory you would like to work on.

../_images/how_to_use09.png

The image above represents the following directory structure. There are 4 user directories (Alice, Bob, user1 and user2).

working_directory # Current Working directory
    │
    └── public
        │
        ├── Alice
        │   ├── dataset
        │   │   ├── image1.jpg
        │   │   ├── ...
        │   │   └── imageN.jpg
        │   └── label
        │       ├── image1.xml
        │       ├── ...
        │       └── imageN.xml
        │
        ├── Bob
        │   ├── dataset
        │   │   ├── image_car1.jpg
        │   │   ├── ...
        │   │   └── image_carN.jpg
        │   └── label
        │       ├── image_car1.xml
        │       ├── ...
        │       └── image_carN.xml
        │
        ├── user1
        │   ├── dataset
        │   │   ├── image_person1.jpg
        │   │   ├── ...
        │   │   └── image_personN.jpg
        │   └── label
        │       ├── image_person1.xml
        │       ├── ...
        │       └── image_personN.xml
        │
        └── user2
            ├── dataset
            │   ├── image_bird1.jpg
            │   └── image_bird2.jpg
            └── label
                ├── image_bird1.xml
                └── image_bird2.xml

You can access and work in any user directory. The data in each directory is not shared with other directories.

Note

The user-separated directories are recognised by ReNomTAG if they contain the dataset and label sub-directories.

2.6. Supported Browsers

ReNomTAG currently supports Google Chrome. In some instances, default shortcut keys for Google Chrome may conflict with ReNomTAG shortcut keys. Please disable the browser shortcut key in order to use the corresponding shortcut in ReNomTAG.