Annotation with brushing tools (#5269)

main
Mariia Acoca 3 years ago committed by GitHub
parent 2125666be1
commit 7944ef8b52
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -0,0 +1,131 @@
---
title: 'Annotation with brush tool'
linkTitle: 'Annotation with brush tool'
weight: 13
description: 'Guide to annotating tasks using brush tools.'
---
With a brush tool, you can create masks for disjoint objects, that have multiple parts,
such as a house hiding behind trees, a car behind a pedestrian, or a pillar behind a
traffic sign.
The brush tool has several modes, for example: erase pixels, change brush shapes, and polygon-to-mask mode.
Use brush tool for Semantic (Panoptic) and Instance Image Segmentation tasks. <br>For more information about segmentation masks in CVAT, see [Creating masks](/docs/manual/advanced/annotation-with-polygons/creating-mask/).
See:
- [Brush tool menu](#brush-tool-menu)
- [Annotation with brush](#annotation-with-brush)
- [Annotation with polygon-to-mask](#annotation-with-polygon-to-mask)
- [Remove underlying pixels](#remove-underlying-pixels)
- [AI Tools](#ai-tools)
- [Import and export](#import-and-export)
## Brush tool menu
The brush tool menu appears on the top of the screen after you click **Shape**:
![BT Menu](/images/brushing_tool_menu.png)
It has the following elements:
|Element|Description|
|----|-----|
|![Tick icon](/images/tick_icon.png)| **Save mask** saves the created mask. The saved mask will appear on the object sidebar|
|![Save mask and continue](/images/brushing_tools_add_label.png)| **Save mask and continue** adds a new mask to the object sidebar and allows you to draw a new one immediately.|
|![Brush](/images/brushing_tools_icon.png)| **Brush** adds new mask/ new regions to the previously added mask).|
|![Eraser](/images/brushing_tools_erase.png)|**Eraser** removes part of the mask.|
|![Add poly](/images/brushing_tools_add_poly.png)|**Polygon** selection tool. Selection will become a mask.|
|![Remove poly](/images/brushing_tools_remove_poly.png)|**Remove polygon selection** substracts part of the polygon selection.|
|![Brush size](/images/brushing_tools_brush_size.png)|**Brush size** in pixels. <br>**Note:** Visible only when **Brush** or **Eraser** are selected.|
|![Brush shape](/images/brushing_tools_brush_shape.png)|**Brush shape** with two options: circle and square. <br>**Note:** Visible only when **Brush** or **Eraser** are selected.|
|![Pixel remove](/images/brushing_tools_pixels.png)|**Remove underlying pixels**. When you are drawing or editing a mask with this tool, <br>pixels on other masks that are located at the same positions as the pixels of the <br>current mask are deleted.|
|![Label](/images/brushing_tools_label_drop.png)|**Label** that will be assigned to the newly created mask||
|![Move](/images/brushing_tools_brush_move.png)|**Move**. Click and hold to move the menu bar to the other place on the screen|
## Annotation with brush
Prerequisites: [Create task](/docs/manual/basics/creating_an_annotation_task/), upload the image, add labels,
and open the workspace.
Do the following:
1. From the [controls sidebar](/docs/manual/basics/controls-sidebar/), select **Brush** ![Brush icon](/images/brushing_tools_icon.png).
2. In the **Draw new mask** menu, select label for your mask, and click **Shape**. <br>The **Brush**![Brush](/images/brushing_tools_icon.png) tool will be selected by default.
![BT context menu](/images/brushing_tools_context_menu.png)
3. With the brush, draw a mask on the object you want to label. <br>To erase selection, use **Eraser** ![Eraser](/images/brushing_tools_erase.png)
![Brushing](/images/brushing_tools.gif)
4. After you applied the mask, on the top menu bar click **Save mask** ![Tick icon](/images/tick_icon.png) <br>to finish the process (or **N** on the keyboard).
5. Added object will appear on the [objects sidebar](/docs/manual/basics/objects-sidebar/).
To add the next object, repeat steps 1 to 5.
All added objects will be visible on the image and the [objects sidebar](/docs/manual/basics/objects-sidebar/).
To save the job with all added objects, on the top menu click **Save** ![Save](/images/brushing_tools_save.png).
## Annotation with polygon-to-mask
Prerequisites: [Create task](/docs/manual/basics/creating_an_annotation_task/), upload the image, <br>add labels, and open the workspace.
Do the following:
1. From the [controls sidebar](/docs/manual/basics/controls-sidebar/), select **Brush** ![Brush icon](/images/brushing_tools_icon.png).
2. In the **Draw new mask** menu, select label for your mask, and click **Shape**.
![BT context menu](/images/brushing_tools_context_menu.png)
3. In the brush tool menu, select **Polygon** ![Add poly](/images/brushing_tools_add_poly.png).
4. With the **Polygon**![Add poly](/images/brushing_tools_add_poly.png) tool, draw a mask for the object you want to label. <br>To correct selection, use **Remove polygon selection** ![Remove poly](/images/brushing_tools_remove_poly.png).
5. Use **Save mask** ![Tick icon](/images/tick_icon.png) (or **N** on the keyboard) <br>to switch between add/remove polygon tools:
![Brushing](/images/brushing_tools_polygon.gif)
6. After you added the polygon selection, on the top menu bar click **Save mask** ![Tick icon](/images/tick_icon.png) <br>to finish the process (or **N** on the keyboard).
7. Click **Save mask** ![Tick icon](/images/tick_icon.png) again (or **N** on the keyboard). <br>The added object will appear on the [objects sidebar](/docs/manual/basics/objects-sidebar/).
To add the next object, repeat steps 1 to 5.
All added objects will be visible on the image and the [objects sidebar](/docs/manual/basics/objects-sidebar/).
To save the job with all added objects, on the top menu click **Save** ![Save](/images/brushing_tools_save.png).
## Remove underlying pixels
Use **Remove underlying pixels** tool when you want to add a mask and simultaneously delete the pixels of <br>other masks that are located at the same positions. It is a highly useful feature to avoid meticulous drawing edges twice between two different objects.
![Remove pixel](/images/brushing_tools_pixel_underlying.gif)
## AI Tools
You can convert [AI tool](/docs/manual/advanced/ai-tools/) masks to polygons.
To do this, use the following [AI tool](/docs/manual/advanced/ai-tools/) menu:
![Save](/images/brushing_tool_ai.jpg)
1. Go to the **Detectors** tab.
2. Switch toggle **Masks to polygons** to the right.
3. Add source and destination labels from the drop-down lists.
4. Click **Annotate**.
## Import and export
For export, see [Export dataset](/docs/manual/advanced/export-import-datasets/)
Import follows the general [import dataset](/docs/manual/advanced/export-import-datasets/) procedure,
with the additional option of converting masks to polygons.
>**Note:** This option is available for formats that work with masks only.
To use it, when uploading the dataset, switch the **Convert masks to polygon** toggle to the right:
![Remove pixel](/images/brushing_tools_import.png)

@ -39,6 +39,7 @@ description: 'Overview of available functions on the controls sidebar of the ann
|![](/images/image170.jpg)|`Points`|[Annotation with points](/docs/manual/advanced/annotation-with-points/)|
|![](/images/image241.jpg)|`Ellipses`|[Annotation with ellipses](/docs/manual/advanced/annotation-with-ellipses/)|
|![](/images/image176.jpg)|`Cuboid`|[Annotation with cuboids](/docs/manual/advanced/annotation-with-cuboids/)|
|![](/images/brushing_tools_icon.png)|`Brushing tools`|[Annotation with brushing](/docs/manual/advanced/annotation-with-brushing-tools/)|
|![](/images/image171.jpg)|`Tag`|[Annotation with tags](/docs/manual/advanced/annotation-with-tags/)|
|![](/images/image195.jpg)|`Open an issue`|[Review](/docs/manual/advanced/review/) (available only in review mode)|

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 483 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 236 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 570 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 431 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 835 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 463 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 433 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 728 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.6 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 256 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.0 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 537 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 810 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 256 B

Loading…
Cancel
Save