Skip to content

GUI Help

DONGFENG GU edited this page Jun 21, 2016 · 7 revisions

The GUI help menu is displayed at the top left corner. Pressing the key 'h' toggles between showing and hiding the help menu.

Help Menu

GUI Information Overview

The following information explains the meaning of keywords shown on top of the help bar.

Frame Number

This keyword shows the current frame you are annotating and the total frame of the sequence (video or image list). (Remark: if the sequence is live sequence, the total frame number will be 0)

Annotation Number

This keyword shows the number of annotation box in the current frame.

GUI Options Overview

The following keyboard keys and mouse actions define an action while using the Annotate tool.

'm' key

The m key switches between the three different annotation modes: axis align rectangle, rotated rectangle and polygon.

'-' key

It's used to reduce by 0.1 the aspect ratio of rectangles while in axis align and rotated mode. The ratio is ignored when defining a free polygon. If your ratio cannot be defined by the 0.1 increments/decrements refer to the command line arguments options for more options.

The aspect radio defines the ratio between height/weight of the annotation.

When decreasing the ratio, it becomes 0, the ratio constraint is removed. You can see the currently selected ratio next to the name of the selected mode.

'+' key

It's used to increment the aspect ratio by 0.1. Refer to '-' for more details

'h' key

Hides and show the help menu

'n' key

Advances to the next frame in the sequence.

'l' key

Open the GUI action help menu

'a' key

Accepts a new annotation, changing its status from drawing to added (i.e. red color to yellow color with numbering). This command is called automatically called in the modes: axis align rectangle and rotated rectangle.

In mode polygon, a new annotation needs to be accepted by inputting the key 'a'.

'd' key

Deletes the currently selected annotation. It must be in drawing mode (i.e., red color).

'b' key

It removes the last point in the current annotation. It acts as a 'back' button. Once there are no more points to remove from the current drawing, it will start deleting previous annotations.

'c' key

Clear all annotations in the frame.

'SPACE' key

Pause/play video sequence.

'SHIFT + Mouse Left Click'

Allows you the select any annotation. You could also drag the annotation for reposition.

'ESC' key

Exits the Annotate tool

GUI Action Information Overivew

Action Help Menu

The following information explains the meaning of keywords shown on top of the help bar.

Frame Number

link

Annotation Number

link

GUI Action Options Overview

The following keyboard keys and mouse actions define an action while using the Annotate tool.

Usage

If you want to use the action annotation function, you need to import the actionType.txt file first. Check the Command Line Options WIKI page (the 'a' option).

In the actionType.txt file, you can define up to 10 actions for action annotation, each action keyword is separated by a line break.

'Number' key

You can use number key to select the corresponding action. The default number key '0' which is the first line in the actionType.txt file.

Clone this wiki locally