Brush

The Brush tag is used for image segmentation tasks where you want to apply a mask or use a brush to draw a region on the image.

Use with the following data types: image.

Parameters

Param	Type	Default	Description
name	string		Name of the element
toName	string		Name of the image to label
[choice]	single | multiple	single	Configure whether the data labeler can select one or multiple labels
[maxUsages]	number		Maximum number of times a label can be used per task
[showInline]	boolean	true	Show labels in the same visual line
[smart]	boolean		Show smart tool for interactive pre-annotations
[smartOnly]	boolean		Only show smart tool for interactive pre-annotations

Result parameters

Name	Type	Description
original_width	number	Width of the original image (px)
original_height	number	Height of the original image (px)
image_rotation	number	Rotation degree of the image (deg)
value	Object
value.format	"rle"	Format of the masks, only RLE is supported for now
value.rle	Array.<number>	RLE-encoded image

Example JSON

{
  "original_width": 1920,
  "original_height": 1280,
  "image_rotation": 0,
  "value": {
    "format": "rle",
    "rle": [0, 1, 1, 2, 3],
    "brushlabels": ["Car"]
  }
}

Example

Basic image segmentation labeling configuration:

<View>
  <Brush name="brush" toName="image" />
  <Labels name="labels" toName="image">
    <Label value="Person" />
    <Label value="Animal" />
  </Labels>
  <Image name="image" value="$image" />
</View>