rectangle

rectangle defines a BoundingBox by its upper-left pixel coordinates, width, and height.

Field

Type / required

Behavior

x

integer / required

Required nonnegative x coordinate of the upper-left corner. Must fit a signed 32-bit integer.

y

integer / required

Required nonnegative y coordinate of the upper-left corner. Must fit a signed 32-bit integer.

width

integer / required

Required positive width in pixels. Must fit a signed 32-bit integer.

height

integer / required

Required positive height in pixels. Must fit a signed 32-bit integer.

The following request adds a bounding box to an image:

[{
    "AddImage": {
        "class": "Images",
        "_ref": 1,
        "format": "png",
        "properties": {
            "description": "dog playing in a park"
        }
    }
}, {
    "AddBoundingBox": {
        "class": "Annotations",
        "image_ref": 1,
        "label": "Dog",
        "rectangle": {
            "x": 200,
            "y": 100,
            "width": 300,
            "height": 300
        },
        "properties": {
            "label_id": 32
        }
    }
}]

Here, x and y locate the upper-left corner; width and height define the box’s dimensions.