Points

Given a point entry in params.geometries, Scale will annotate your image or video with points and return the vertices of the points.

Request Parameters

Key	Type	Default	Description
objects_to_annotate*	String or LabelDescription Array	[]	A list of `string` or LabelDescription objects.
connections	Object Array	[]	An array of Connection objects, used as a visual aid during annotation to easily see the relationships between keypoints.

Connection

Key	Type	Description
pair*	array	A pair of labels which should be visually connected with a line.
connection_attribute	string	Linked attribute name to filter the pairs which should be linked. This is used to disambiguate in case there are multiple humans, hands, etc. in a scene each with their own set of keypoints.

844 — Visualization of keypoint connections

{
    ...
    "geometries": {
        "box": {
            "objects_to_annotate": ["person"]
        },
        "point": {
            "objects_to_annotate": ["hand", "elbow", "knee", "heel"],
            "connections": [
                {"pair": ["hand", "elbow"], "connection_attribute": "linked_person"},
                {"pair": ["knee", "heel"], "connection_attribute": "linked_person"}
            ]
        }
    },
    "annotation_attributes": {
        "linked_person": {
            "type": "linked",
            "description": "What person is this keypoint associated with?",
            "allowed_labels": ["person"],
            "required": true
        }
    },
    ...
}

Response Fields

Key	Type	Description
uuid	string	A computer-generated unique identifier for this annotation. In video annotation tasks, this can be used to track the same object across frames.
type	string	String to indicate geometry type: `point`
label	string	The label of this annotation, chosen from the `objects_to_annotate` array for its geometry. In video annotation tasks, any annotation objects with the same `uuid` will have the same `label` across all frames.
attributes	object	See the Annotation Attributes section for more details about the `attributes` response field.
x	number	The distance, in pixels, between the point and the left border of the image.
y	number	The distance, in pixels, between the point and the top border of the image

{
  "response": {
    "annotations": [
      {
        "type": "point",
        "label": "headlight",
        "x": 123,
        "y": 10,
        "uuid": "65ec1f52-5902-4b39-bea9-ab6b4d58ef42"
      },
      {
        "type": "point",
        "label": "headlight",
        "x": 140,
        "y": 49,
        "uuid": "0a6cd019-a014-4c67-bd49-c269ba08028a"
      },
      {
        "type": "point",
        "label": "brakelight",
        "x": 67,
        "y": 34,
        "uuid": "8564e046-752e-4af9-ad9d-76dcf8ecd4df"
      }
    ]
  },
  "task_id": "5774cc78b01249ab09f089dd",
  "task": {
    // task inlined for convenience
    ...
  }
}