Image vector interface

When creating a dataset through the Python SDK, choose vector or image-vector-sequence as the task_type to use this labeling interface.

Add a new object

To add a new object:

1. Select an annotation type (see Annotation types)

2. Label the object by drawing on the image

Select an object

1. Press Space or Escape or click the button in the left toolbar to enter view-and-select mode

2. Click on a labeled object to select it. You can also select an object by selecting it in the right sidebar

Remove an object

Select an object and press Backspace to remove it. You can also click the icon in the sidebar to remove an object.

Change the category of an object

Select an object and click on its name in the sidebar to select a different category. You can also use hotkey c to change the category of the active object.

Intersect bounding boxes / polygons

To make it easy to draw shapes closely together you can just draw overlapping bounding boxes and polygons. If you then select one of the overlapping shapes you can press the hotkey (default r ) to intersect the active shape with the other shapes it overlaps with.

Annotation types

Bounding box

Click thebutton in the left toolbar to draw a bounding box. Click and drag to draw the box.

Polygon

Click thebutton in the left toolbar to draw a polygon. Click on the image to draw polygon points. Double click or click the first point of the polygon to finish it.

After finishing a polygon, you can add a point to it with Shift + left click. This will add a point to the edge closest of the cursor. You will see a preview of where the point will be added as soon as you press Shift. You can add points to a selected polygon in view-and-select mode, or while still in draw polygon mode after finishing it. You can remove a point by Shift + left click. A polygon needs at least 3 points.

When holding Shift + Fnode snapping is activated. This will snap the point you want to add to the nearest handle of an existing vector, within a certain distance threshold.

Polyline

Click thebutton in the left toolbar to draw a polyline. Click on the image to draw polyline points. Double click to finish it.

After finishing a polyline, you can add a point to it with Shift + left click. This will add a point to the edge closest of the cursor. You will see a preview of where the point will be added as soon as you press Shift. You can add points to a selected polyline in view-and-select mode, or while still in draw polygon mode after finishing it. You can remove a point by Shift + left click. A polyline needs at least 2 points.

When holding Shift + Fnode snapping is activated. This will snap the point you want to add to the nearest handle of an existing vector, within a certain distance threshold.

Keypoint

Click thebutton in the left toolbar to draw a keypoint.

Ruler mode

1. Click the button in the right toolbar or press hotkey z to toggle the ruler mode
2. Click in the interface to set the first point

3. Move your cursor to another point and it will display the measurement in pixels

4. Click again to go back to select-and-view mode or press esc