BoundingBox (v1)

Warning

This is not the latest version. The latest version is v5.

• Previous Version: none (this is the oldest version)

• URI: http://clams.ai/vocabulary/type/BoundingBox/v1

• Shortname: BoundingBox

• Inherits from: Polygon (v1)

• Included in: 1.0.0, 1.0.1

• Also Known As: This type is also accessible at the following legacy URLs for backward compatibility:

  • http://mmif.clams.ai/vocabulary/BoundingBox/v1

  • http://mmif.clams.ai/0.4.0/vocabulary/BoundingBox/

  • http://mmif.clams.ai/0.4.1/vocabulary/BoundingBox/

  • http://mmif.clams.ai/0.4.2/vocabulary/BoundingBox/

Description

A rectangular object in an image or video. At the moment it does not have features that would not make any sense on its parent type Polygon so technically we can do without BoundingBox, but it was introduced because the term is in widespread use.

Properties

Synopsis

Properties marked with * are required.

Property	Type	Origin
boxType	string	native
coordinates *	array of array	Polygon (v1)
timePoint	integer	Polygon (v1)
timeUnit	string	Region (v1)
document	string	Annotation (v2)
id *	string	Thing (v1)

Native

boxType

• type: string

• required: no

The type of BoundingBox. Mostly used for text boxes where we use the value text.

---

Inherited from Polygon (v1)

coordinates

• type: array of array

• required: yes

The coordinates of the polygon, taking the top-left of the image as the origin (0,0). Unit used to measure the distance is the number of pixels.

---

timePoint

• type: integer

• required: no

If on a video stream, the TimePoint that the BoundingBox occurs in.

---

Inherited from Region (v1)

timeUnit

• type: string

• required: no

Specifies which unit of time the measurement is based. Can be seconds or milliseconds, or in case of annotations on a VideoDocument, frames.

---

Inherited from Annotation (v2)

document

• type: string

• required: no

The identifier of the document that the annotation is over.

---

Inherited from Thing (v1)

id

• type: string

• required: yes

A unique identifier for the annotation or document. Uniqueness is relative to the view the annotation is in or the list of documents at the top level of a MMIF file.

---

JSON Schema

{
  "additionalProperties": true,
  "properties": {
    "id": {
      "description": "A unique identifier for the annotation or document. Uniqueness is relative to the view the annotation is in or the list of documents at the top level of a MMIF file.",
      "type": "string"
    },
    "document": {
      "type": "string",
      "description": "The identifier of the document that the annotation is over."
    },
    "timeUnit": {
      "type": "string",
      "description": "Specifies which unit of time the measurement is based. Can be *seconds* or *milliseconds*, or in case of annotations on a VideoDocument, *frames*."
    },
    "coordinates": {
      "description": "The coordinates of the polygon, taking the top-left of the image as the origin (0,0). Unit used to measure the distance is the number of pixels.",
      "items": {
        "items": {
          "type": "integer"
        },
        "type": "array"
      },
      "type": "array"
    },
    "timePoint": {
      "type": "integer",
      "description": "If on a video stream, the TimePoint that the BoundingBox occurs in."
    },
    "boxType": {
      "type": "string",
      "description": "The type of BoundingBox. Mostly used for text boxes where we use the value text."
    }
  },
  "required": [
    "coordinates",
    "id"
  ],
  "type": "object"
}