Hire WorkforcePython SDKRequest Demo
Documentation

Image (Legacy) Project

Suggest Edits

When you export a Image (Legacy) Project, the download folder contains JSON files of your annotations. Each image has its own JSON file.

Annotation JSON in Image (Legacy) Projects is divided into 4 main fields:

{
	"metadata": {},
	"comments": [],
	"tags": [],
	"instances": []
}

Metadata

{
    "lastAction": {
      "email": "[email protected]",
      "timestamp": 1610614861660
    },
    "width": 1920,
    "height": 1280,
    "name": "en5Cuu0nbTo.jpg",
    "projectId": 8806,
    "qaEmail": [email protected],
    "annotatorEmail": [email protected],
    "status": "InProgress",
    "pinned": false
}

Description:

  • “lastAction”: The user who last edited the image. Edits include changing the class of an instance, adding or deleting attributes, adding point labels, approving or disapproving instances, and moving or scaling instances.
    • “email”: string - The email address of the last user who added or edited an instance.
    • “timestamp”: integer - The date and time when the last instance edit was made.
  • "width": integer - The image’s width.
  • "height": integer - The image’s height.
  • "name": string - The name of the image.
  • "projectId": integer - The project ID.
  • "qaEmail": string - The QA’s email address.
  • "annotatorEmail": string - The annotator's email address.
  • "status": string - The image status. It can be: NotStarted, InProgress, QualityCheck, Returned, Skipped, or Completed.
  • "pinned": boolean - If it’s true, then the image is pinned. If it’s false, then the image isn’t pinned.

Comments

[
  {
    "correspondence": [
      {
          "text": "Fix this",
          "email": "[email protected]"}
      ],
      "x": 987.98,
      "y": 722.87,
      "resolved": false,
      "createdAt": "2021-01-14T07:34:00.695Z",
      "createdBy": {
        "email": "[email protected]",
        "role": "Admin"
      },
      "creationType": "Manual",
      "updatedAt": "2021-01-14T07:34:04.783Z",
      "updatedBy": {
        "email": "[email protected]",
        "role": "Admin"
      }
}]

Description:

  • "correspondence": array of objects - List of messages in the comment.
    • "text": string - The comment.
    • "email": string - The email address of the user who wrote the comment.
  • “x”: number - X position of the comment on the image.
  • “y”: number - Y position of the comment on the image.
  • “resolved”: boolean - If it’s true, then the comment is resolved. If it’s false, then the comment isn't resolved.
  • “createdAt”: string - The date and time when the comment was created.
  • “createdBy”: The user who created the comment.
    • “email”: string - The email of the user who created the comment.
    • “role”: string - The role of the user who created the comment.
  • “creationtype”: string - The method that was used to create the instance. If it's manual, then the user created the instance in the editor. If it's pre-annotation, then the instance was uploaded with Python SDK.
  • “updatedAt”: string - The time the comment was updated.
  • “updatedBy”: The user who last updated the comment.
    • “email”: string - The email address of the user who last updated the comment.
    • “role”: string - The role of the user who last updated the comment.

Tags

[
    "Road",
    "Car"
  ]

Description:

  • “Road”: string - The tag name.

Instances

{
      "classId": 5005974,
      "className": "Car",
      "probability": 100,
      "visible": true,
      "attributes": [
        {
          "id": 275033,
          "groupId": 66874,
          "name":"Taxi",
          "groupName":"Type"
        }
      ],
      "parts": [
        {
          "color": "#00013b"
        }
      ],
      "error": null,
      "locked": false,
      "createdAt": "2021-01-14T07:33:51.370Z",
      "createdBy": {
        "email": "[email protected]",
        "role": "Annotator"
      },
      "creationType": "Manual",
      "updatedAt": "2021-01-14T10:21:08.010Z",
      "updatedBy": {
        "email": "[email protected]",
        "role": "QA"
      }
}

Description:

  • “classId”: integer - Class ID (one of the class IDs in ”classes.json” or -1 if the instance is not classified).
  • "className": string - Class name (one of the class names in “classes.json”, or an empty value if the instance is not classified).
  • “probability”: integer - If the instance was created manually, then the probability value is 100.
  • “visible”: boolean - If it’s true, you’ll be able to see the annotations on the canvas.
  • “attributes”: array of objects - List of attributes for this instance.
    • “id”: integer - Attribute ID (must be in “classes.json”)
    • “groupId”: integer - Group ID (must be in “classes.json”)
    • "name": string - Attribute name
    • "groupName": string - Group name
  • "parts": array of objects - The colors of the instance's segment in the mask PNG file.
    • "color": string - HEX color code of the instance
  • “error”: boolean - If the instance is approved, then it’s false. If it’s disapproved, then it’s true. If you approve or disapprove an instance then undo the action, then it’s null. If the instance is neither approved nor disapproved, then error won’t appear in JSON.
  • “locked”: boolean - If it’s true, you won't be able to move the instance. If it’s false, you'll be able to move the instance.
  • "createdAt": string - The time the instance was created.
  • "createdBy": objects - The user who created the instance.
    • "email": string - The email address of the user who created the instance.
    • "role": string - The role of the user who created the instance.
  • "creationType": string - The method that was used to create the instance. If it's manual, then the user created the instance in the editor. If it's pre-annotation, then the instance was uploaded with Python SDK.
  • "updatedAt": string - The time the instance was updated.
  • "updatedBy": objects - The user who updated the instance.
    • "email": string - The email address of the user who updated the instance.
    • "role": string - The role of the user who updated the instance.
export legacy image annotation

Instances in the Image (Legacy) Editor / Instances in the annotation mask

When you download the annotation data of a Image (Legacy) Project, you'll find JSON files and PNG images in your download folder. You can find the HEX color codes of the instance segments in the PNG images in the JSON files.

The image above (on the right) illustrates the PNG mask of two instances, one of which has multiple segments. You can find the HEX color code of the car in this JSON block.

The areas that aren't annotated will have all four channels (R,G,B,A) set to zero.

Updated 4 months ago