2. 使い方

2.1. ReNomTAGを起動する前に

2.1.1. ディレクトリ構造

ReNomTAGを起動する前に、画像ファイルを設置するディレクトリ構造について説明します。

ここからは、 working_directory という名前のディレクトリで作業を行っていることを想定します。その場合、以下に示すようなディレクトリ構造が定義されている必要があります。

特に、 public dataset label ディレクトリについては名前を変更しないでください。

それぞれのディレクトリは以下の様な役割を担います。

  • public

    データセットのルートとなるディレクトリです。 ディレクトリ名は public となっている必要があります。

  • user1, user2...

    これらのディレクトリは、タグ付け対象の画像データと作成されたタグデータが含まれます。こちらのディレクトリ名は変更可能です。

  • dataset

    このディレクトリには、タグ付け対象の画像データを設置してください。ディレクトリ名は、 dataset となっている必要があります。

  • label

    作成したタグデータはこのディレクトリに保存されます。ディレクトリ名は、 label となっている必要があります。

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. 画像データの設置

画像データは dataset ディレクトリに設置してください。

また、画像データのファイル名には半角英数及びアンダーバーのみが使えます。(0-9, a-z, A-Z, _)それ以外のハイフンやアスタリスク(-, * )などが含まれる名前の画像データをReNomTAGに読み込むことはできないので注意してください。

ファイルの種類については、拡張子が".jpg"、".jpeg"、".png"、".bmp"であるファイルを読み込むことが可能です。


2.2. ReNomTAGの起動

ReNomTAGを起動するには、以下のコマンドを使用します。作業ディレクトリ(ここでは working_directory )にて起動コマンドを実行してください。

renom_tag

こちらの起動コマンドには、以下のオプションがあります。

# Run with port 8081
renom_tag --port 8081

ReNomTAGを起動したら、以下のURLをウェブブラウザに入力してください。

../_images/how_to_use02.png

public ディレクトリ以下が読み込まれ、以下の様な画面が表示されます。

../_images/how_to_use01.png

2.3. 画像にタグを設置する

2.3.1. タグ(バウンディングボックス)を設置する

表示されている画像をドラッグすることで、タグ(バウンディングボックス)を設置することができます。

../_images/how_to_use08.png

注釈

画像につけたタグ(バウンディングボックスとタグ名の組)を保存するためには、バウンディングボックスに class tag name が付いている必要があります。

2.3.2. タグを保存する

タグを保存するには、 save ボタンを押してください。もしくはキーボードのSpaceキーを save ボタンのショートカットとして使用することができます。

2.3.3. 非選択のタグを非表示にする

ひとつのバウンディングボックスのみを表示したい場合、そのボックスを選択した後にトグルボタンをクリックしてください。もしくはキーボードの Ctrl+d をショートカットとして使用することができます。このモード中でも通常と同じように新しいボックスを追加することができます。トグルボタンを再度クリックすると通常モードに戻り、全てのボックスが表示されます。

../_images/how_to_use13.png

2.3.4. Class Tagに対してショートカットキーを設定する

Class tag nameに対してショートカットキーを設定することができます。

2.3.5. タグ付けのデフォルトショートカットキー

タグ付け作業の効率化のため、ReNomTAGは下記のデフォルトショートカットを提供します。

  • Ctrl+b : 直近でアノテーションした画像のボックスを全てコピーし、作業中の画像にペースト

  • Ctrl+c, Ctrl+v : 作業中の画像において、選択したボックスをコピー・ペースト

  • Ctrl+z : ボックスに対して、直近の操作(形・位置・クラスタグ)を取り消す

2.3.6. 全画面モード

Ctrl+w を押すと全画面モードに入ります。もう一度、 Ctrl+w を押すと通常モードに戻ります。画像下部のツールバーにある左から3番目のボタンをクリックすることで同じモードの切り替えが可能です。

../_images/how_to_use10.png

2.3.7. 画像の拡大・縮小

画像下部のツールバーの + 及び - ボタンで画像の拡大・縮小も可能です。ツールバーの左から二つ目のボタンをクリックすることで本来の画像サイズに戻ります。

../_images/how_to_use11.png

2.3.8. 画像をフィルタリングする

リストとして表示する画像をフィルタリング可能です。

  • All : すべての画像を表示します。

  • Need Review : タグ付け済みで、管理者によるレビューが必要な画像のみを表示します。

  • No Tags : タグがつけられていない画像のみを表示します。

  • OK : 管理者によって OK マークがつけられた画像のみを表示します。

  • OK : 管理者によって OK マークがつけられた画像のみを表示します。

../_images/how_to_use07.png

2.4. 管理者モード

管理者モードは以下の機能を提供します。

  • あらたなClass Tagの定義。

  • タグ付け済み画像に対し、 OK NG マークをつける。

  • タグ付け済み画像に対してコメントをつける。

2.4.1. 管理者モードに入る

管理者モードに入るためには、ウェブブラウザのURLフォームにadminをつけたURLを入力してください。

../_images/how_to_use03.png

管理者モードに入った場合、以下の様にReNomTAGのタイトルがAdminへと変わります。

../_images/how_to_use04.png

2.4.2. 新たな Class Tag を定義する

管理者モードでは、新たなClass Tagを定義することができます。そのためには、以下の画像に示す入力フォームに、新たなタグ名を入力してください。

そして、 Add New Tag ボタンを押してください。

また、Class Tagに対してショートカットキーを設定することもできます。ショートカットキーは管理者モードでなくとも変更可能です。

../_images/how_to_use05.png

2.4.3. Class Tagの削除

管理者モードでは、Class Tagを削除することができます。Tagを削除するためにまず Delete Tag List ボタンをクリックしてください。そして、削除対象を個別に選択してください。

選択後に、 Delete ボタンを押すとタグが削除されます。

../_images/how_to_use12.png

2.4.4. 画像にタグを設置する

管理者モードでは、タグ付け済み画像に対してOK、NGマークをつけることが可能です。

以下の画像に示すように、OK、NGボタンを選択し

../_images/how_to_use06.png

save ボタンを押すことでマークをつけることができます。

2.4.5. タグ付け済み画像に対し、コメントをつける

画像に対してコメントをつけることができます。管理者モードに入っていない時(通常モード)はコメントの編集はできませんがコメントを確認することができます。

2.4.6. 通常モードへ戻る

通常モードへ戻る場合は、URLにつけた admin という文字を削除してください。直ちに通常モードへ戻ることができます。


2.5. 複数人ユーザでReNomTAGを使う

public ディレクトリ以下にあるユーザディレクトリを選択することができます。

../_images/how_to_use09.png

上の画像では、下のようなディレクトリ構造を定義した場合のReNomTAGから選択可能なユーザデイレクトリを表示しています。

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

作業者は、どのユーザディレクトリでもタグ付け作業を行うことが可能です別々のディレクトリで作業を行う場合、同じファイルに対して同時に書き込み処理が行われることはありません。

注釈

ユーザごとに、分割されたディレクトリには、 dataset label ディレクトリが存在する必要があります。もしこれらのディレクトリが存在しない場合、ReNomTAGはユーザディレクトリを認識しません。

2.6. 対応ブラウザ

ReNomTAGは最新のGoogle Chromeに対応しています。また、ReNomTAGとブラウザのショートカットキーが衝突した場合は、ブラウザのショートカットキーを無効化したのちReNomTAGのショートカットキーをご利用ください。