KeyPointLabels

The KeyPointLabels tag creates labeled keypoints. Use to apply labels to identified key points, such as identifying facial features for a facial recognition labeling project.

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 you 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
[opacity]	float	0.9	Opacity of the keypoint
[strokeWidth]	number	1	Width of the stroke
[snap]	pixel | none	none	Snap keypoint to image pixels

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.x	number	x coordinate by percentage of the image size (0-100)
value.y	number	y coordinate by percentage of the image size (0-100)
value.width	number	point size by percentage of the image size (0-100)

Example JSON

{
  "original_width": 1920,
  "original_height": 1280,
  "image_rotation": 0,
  "value": {
    "x": 3.1,
    "y": 8.2,
    "width": 2,
    "keypointlabels": ["Car"]
  }
}

Example

Basic keypoint image labeling configuration for multiple regions

<View>
  <KeyPointLabels name="kp-1" toName="img-1">
    <Label value="Face" />
    <Label value="Nose" />
  </KeyPointLabels>
  <Image name="img-1" value="$img" />
</View>