diff --git a/cvat/apps/documentation/static/documentation/images/gif005.gif b/cvat/apps/documentation/static/documentation/images/gif005.gif deleted file mode 100644 index 0f28ab624849..000000000000 Binary files a/cvat/apps/documentation/static/documentation/images/gif005.gif and /dev/null differ diff --git a/cvat/apps/documentation/static/documentation/images/gif005_detrac.gif b/cvat/apps/documentation/static/documentation/images/gif005_detrac.gif new file mode 100644 index 000000000000..819e97c895fb Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/gif005_detrac.gif differ diff --git a/cvat/apps/documentation/static/documentation/images/gif006.gif b/cvat/apps/documentation/static/documentation/images/gif006.gif deleted file mode 100644 index c973c81faf00..000000000000 Binary files a/cvat/apps/documentation/static/documentation/images/gif006.gif and /dev/null differ diff --git a/cvat/apps/documentation/static/documentation/images/gif006_detrac.gif b/cvat/apps/documentation/static/documentation/images/gif006_detrac.gif new file mode 100644 index 000000000000..30209e98aef0 Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/gif006_detrac.gif differ diff --git a/cvat/apps/documentation/static/documentation/images/gif007.gif b/cvat/apps/documentation/static/documentation/images/gif007.gif deleted file mode 100644 index ed02475e3215..000000000000 Binary files a/cvat/apps/documentation/static/documentation/images/gif007.gif and /dev/null differ diff --git a/cvat/apps/documentation/static/documentation/images/gif007_mapillary_vistas.gif b/cvat/apps/documentation/static/documentation/images/gif007_mapillary_vistas.gif new file mode 100644 index 000000000000..6bd4057a06aa Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/gif007_mapillary_vistas.gif differ diff --git a/cvat/apps/documentation/static/documentation/images/gif009_DETRAC.gif b/cvat/apps/documentation/static/documentation/images/gif009_DETRAC.gif deleted file mode 100644 index 518d5a626fbc..000000000000 Binary files a/cvat/apps/documentation/static/documentation/images/gif009_DETRAC.gif and /dev/null differ diff --git a/cvat/apps/documentation/static/documentation/images/gif009_detrac.gif b/cvat/apps/documentation/static/documentation/images/gif009_detrac.gif new file mode 100644 index 000000000000..b3a77f8767ef Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/gif009_detrac.gif differ diff --git a/cvat/apps/documentation/static/documentation/images/gif025_mapillary_vistas.gif b/cvat/apps/documentation/static/documentation/images/gif025_mapillary_vistas.gif new file mode 100644 index 000000000000..9adba66ca48e Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/gif025_mapillary_vistas.gif differ diff --git a/cvat/apps/documentation/static/documentation/images/image064.jpg b/cvat/apps/documentation/static/documentation/images/image064.jpg deleted file mode 100644 index db531f5ba2de..000000000000 Binary files a/cvat/apps/documentation/static/documentation/images/image064.jpg and /dev/null differ diff --git a/cvat/apps/documentation/static/documentation/images/image064_mapillary_vistas.jpg b/cvat/apps/documentation/static/documentation/images/image064_mapillary_vistas.jpg new file mode 100644 index 000000000000..ba4eca6eaa3c Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/image064_mapillary_vistas.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image074.jpg b/cvat/apps/documentation/static/documentation/images/image074.jpg index f2fd7228af82..dd5fb225fdeb 100644 Binary files a/cvat/apps/documentation/static/documentation/images/image074.jpg and b/cvat/apps/documentation/static/documentation/images/image074.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image084.jpg b/cvat/apps/documentation/static/documentation/images/image084.jpg index 6ea0a7e2f321..10e101d4b89d 100644 Binary files a/cvat/apps/documentation/static/documentation/images/image084.jpg and b/cvat/apps/documentation/static/documentation/images/image084.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image114.jpg b/cvat/apps/documentation/static/documentation/images/image114.jpg index 63f480917daf..8d5388eed1b9 100644 Binary files a/cvat/apps/documentation/static/documentation/images/image114.jpg and b/cvat/apps/documentation/static/documentation/images/image114.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image157_mapillary_vistas.jpg b/cvat/apps/documentation/static/documentation/images/image157_mapillary_vistas.jpg new file mode 100644 index 000000000000..3ed2e5cf2c38 Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/image157_mapillary_vistas.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image158_mapillary_vistas.jpg b/cvat/apps/documentation/static/documentation/images/image158_mapillary_vistas.jpg new file mode 100644 index 000000000000..a3fbe906b72e Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/image158_mapillary_vistas.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image159_mapillary_vistas.jpg b/cvat/apps/documentation/static/documentation/images/image159_mapillary_vistas.jpg new file mode 100644 index 000000000000..87705c6edaca Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/image159_mapillary_vistas.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image160_mapillary_vistas.jpg b/cvat/apps/documentation/static/documentation/images/image160_mapillary_vistas.jpg new file mode 100644 index 000000000000..3ac3d62a74cd Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/image160_mapillary_vistas.jpg differ diff --git a/cvat/apps/documentation/user_guide.md b/cvat/apps/documentation/user_guide.md index 8e6fe0913354..a58c4cee344b 100644 --- a/cvat/apps/documentation/user_guide.md +++ b/cvat/apps/documentation/user_guide.md @@ -33,7 +33,6 @@ - [Annotation with points](#annotation-with-points) - [Points in annotation mode](#points-in-annotation-mode) - [Linear interpolation with one point](#linear-interpolation-with-one-point) - - [Annotation with Auto Segmentation](#annotation-with-auto-segmentation) - [Automatic annotation](#automatic-annotation) - [Shape grouping](#shape-grouping) - [Filter](#filter) @@ -999,48 +998,100 @@ Press ``Esc`` to cancel editing. ## Annotation with polygons +### Manual drawing + It is used for semantic / instance segmentation. -Be sure ``Z-Order`` flag in ``Create new task`` dialog is enabled if you want to -annotate polygons. Z-Order flag defines order of drawing. It is necessary to -get right annotation mask without extra work (additional drawing of borders). -Z-Order can be changed by ``+``/``-`` which set maximum/minimum z-order +If you want to annotate polygons, make sure the ``Z-Order`` flag in ``Create new task`` dialog is enabled. +The Z-Order flag defines the order of drawing. It is necessary to +get the right annotation mask without extra work (additional drawing of borders). +Z-Order can be changed by pressing ``+``/``-`` which set maximum/minimum z-order accordingly. ![](static/documentation/images/image074.jpg) -Before starting, you need to be sure that ``Polygon`` is selected. +Before starting, you need to select ``Polygon`` on the controls sidebar and choose the correct Label. ![](static/documentation/images/image084.jpg) -Press ``N`` for entering drawing mode. There are two ways to draw a polygon -— you either create points by clicking or by dragging mouse on the screen -holding ``Shift``. +- Click ``Shape`` to enter drawing mode. + There are two ways to draw a polygon: either create points by clicking or + by dragging the mouse on the screen while holding ``Shift``. + +| Clicking points | Holding Shift+Dragging | +| -- | -- | +| ![](static/documentation/images/gif005_detrac.gif)| ![](static/documentation/images/gif006_detrac.gif)| + +- When ``Shift`` isn't pressed, you can zoom in/out (when scrolling the mouse + wheel) and move (when clicking the mouse wheel and moving the mouse), you can also + delete the previous point by right-clicking on it. +- Press ``N`` again for completing the shape. +- After creating the polygon, you can move the points or delete them by right-clicking and selecting ``Delete point`` + or double-clicking with pressed ``Ctrl`` key in the context menu. + +### Drawing using automatic borders + +![](static/documentation/images/gif025_mapillary_vistas.gif) + +You can use auto borders when drawing a polygon. Using automatic borders allows you to automatically trace +the outline of polygons existing in the annotation. +- To do this, go to settings -> workspace tab and enable ``Automatic Bordering`` + or press ``Ctrl`` while drawing a polygon. + + ![](static/documentation/images/image161.jpg) -| Clicking points | Holding Shift+Dragging | -| -- | -- | -| ![](static/documentation/images/gif005.gif) | ![](static/documentation/images/gif006.gif) | +- Start drawing / editing a polygon. +- Points of other shapes will be highlighted, which means that the polygon can be attached to them. +- Define the part of the polygon path that you want to repeat. -When ``Shift`` isn't pressed, you can zoom in/out (when scrolling the mouse -wheel) and move (when clicking the mouse wheel and moving the mouse), you can -delete the previous point clicking right mouse button. Press ``N`` again for -completing the shape. You can move points or delete them by double-clicking. -Double-click with pressed ``Shift`` will open a polygon editor. There you can -create new points (clicking or dragging) or delete part of a polygon closing -the red line on another point. Press ``Esc`` to cancel editing. + ![](static/documentation/images/image157_mapillary_vistas.jpg) -![](static/documentation/images/gif007.gif) +- Click on the first point of the contour part. -Also, you can set fixed number of points in the "poly shape size" field, then -drawing will be stopped automatically. To enable dragging, you should right-click -inside polygon and choose ``Enable Dragging``. + ![](static/documentation/images/image158_mapillary_vistas.jpg) + +- Then click on any point located on part of the path. The selected point will be highlighted in purple. + + ![](static/documentation/images/image159_mapillary_vistas.jpg) + +- Сlick on the last point and the outline to this point will be built automatically. + + ![](static/documentation/images/image160_mapillary_vistas.jpg) + +Besides, you can set a fixed number of points in the ``Number of points`` field, then +drawing will be stopped automatically. To enable dragging you should right-click +inside the polygon and choose ``Switch pinned property``. Below you can see results with opacity and black stroke: -![](static/documentation/images/image064.jpg) +![](static/documentation/images/image064_mapillary_vistas.jpg) + +If you need to annotate small objects, increase ``Image Quality`` to +``95`` in ``Create task`` dialog for your convenience. + +### Make AI polygon -Also, if you need to annotate small objects, increase ``Image Quality`` to -``95`` in ``Create task`` dialog for annotator's convenience. +Used to create a polygon semi-automatically. +- Before starting, you have to make sure that the ``Make AI polygon`` is selected. + + ![](static/documentation/images/image114.jpg) + +- Click ``Shape`` to enter drawing mode. Now you can start annotating the necessary area. + A shape must consist of 4 points minimum. You can set a fixed number of points in the ``Number of points`` field, + then drawing will be stopped automatically. You can zoom in/out and move while drawing. +- Press ``N`` again to finish marking the area. At the end of Auto Segmentation, + a shape is created and you can work with it as a polygon. + + ![](static/documentation/images/gif009_detrac.gif) + +### Edit polygon + +To edit a polygon you have to double-click with pressed ``Shift``, it will open the polygon editor. +- There you can create new points or delete part of a polygon closing the line on another point. +- After closing the polygon, you can select the part of the polygon that you want to leave. +- You can press ``Esc`` to cancel editing. + + ![](static/documentation/images/gif007_mapillary_vistas.gif) ## Annotation with polylines @@ -1171,23 +1222,6 @@ You can use linear interpolation for points to annotate a moving object: ![](static/documentation/images/gif013_DETRAC.gif) -## Annotation with Auto Segmentation - -Used to create a polygon semi-automatically. Before starting, you have to be -sure that ``Auto Segmentation`` is selected. - -![](static/documentation/images/image114.jpg) - -Press ``N`` for entering drawing mode. Now you can start annotating the necessary area. -Press ``N`` again for finishing marking an area. A shape must consist of 4 -points minimum. You can set a fixed number of points in the field -"poly shape size", then drawing will be stopped automatically. You can zoom -in/out (when scrolling the mouse wheel) and move (when clicking the mouse -wheel and moving the mouse) while drawing. At the end of Auto Segmentation, -a shape is created and you can work with it as a polygon. - -![](static/documentation/images/gif009_DETRAC.gif) - ## Automatic annotation Automatic Annotation is used for creating preliminary annotations.