For the complete documentation index, see llms.txt. This page is also available as Markdown.

Tools

Tools fields in Ango Annotation Format exports.

The tools object is part of the task object in the Ango Annotation Format. It contains all annotation data pertaining to labels created with tools, e.g. not classifications, relations, or brushes.

Annotations created with the following annotation tools will appear in the tools object:

General Structure

"tools" : [{
    bounding-box OR rotated-bounding-box OR polygon OR polyline OR segmentation OR ner OR point OR pdf OR spline// object, tool coordinate info
    objectId // string, ID of the object
    schemaId, // string, ID of the labeling tool in the project
    classifications, // list, nested classifications
    title // string, title of the tool
    page // int, page where the object is located (only multi-page, non-video assets)
    medical-brush, // bool, true if the current tool is a medical brush
    },
    { ... }
]

Common Properties

Property
Type
Description

objectId

String

Object ID of the tools. Unique in the asset.

classifications

List

List of nested classifications (if any). May contain further nested classifications in its own classifications property. Each object in the list is of the classification format. See its docs page for more information.

schemaId

String

ID of the class to which the object belongs.

title

String

Name of the class to which the object belongs.

metadata

Dict

Only appears if the Annotation Metadata toggle has been turned on before export. createdAt: int, Time of creation in Unix epoch time in milliseconds. GMT. createdBy: string, email of user creating the object updatedAt: int, optional. Time of last object update in Unix millisecond epoch time. GMT. Only appears if object has been updated. updatedBy: string, optional. email of user last updating the object. Only appears if object has been updated.

Medical Reformat Metadata

In the Medical Labeling Editor, Point, Polygon, and Polyline annotations can be created on a reformatted oblique plane. When this happens, the export includes an nrrdReformat object on the annotation:

activePlane is the original view used as the reformat plane, angle is the reformat angle, and centerVoxel is the voxel used as the center of the oblique view. These values describe the reformatted view used when the annotation was created or last edited. The annotation coordinates themselves are still exported as 3D voxel coordinates, with patient-space coordinates where available.

Voxel Brush annotations do not include per-annotation nrrdReformat metadata. They are exported as the final 3D segmentation volume through medicalBrushDataUrl in the task object. 3D Bounding Box annotations are exported as their normal 3D coordinates and do not include nrrdReformat.

Coordinates in the Ango Annotation Format

This is the coordinate system used when determining the position of points in the Ango export.

The origin point lies at the top left corner, and each point has a (X, Y) coordinate pair determining its position, in pixels, on the image.

Changes in Video Assets

Video assets have a slightly different format for the "tools" property:

We recommend examining a sample export from Ango Hub to better understand how it fits together, such as the following:

Sample Video Export

Angle

Property
Type
Description

vertex

List

The 0-indexed coordinates of the slice where the angle vertex is located, in this order: - Coronal - Sagittal - Axial

p1

List

0-indexed coordinates of the slice where one of the two angle extremities is located.

p2

List

0-indexed coordinates of the slice where one of the two angle extremities is located.

angle

Float

Degrees of the angle.

See also

Angle

Bounding Box

Property
Type
Description

bounding-box

Object

Object containing details about the bounding box.

x - The X coordinate of the top-left point y - The Y coordinate of the top-left point height - The height, in pixels, of the bounding box width - The width, in pixels, of the bounding box

3D Medical Labeling Editor Sample

Circle

Property
Type
Description

circle

List

X, Y coordinates of the points used to create the circle.

See also

Circle

Entity

The Entity tool is used in both audio and text to select a portion of the asset.

Audio

Text

Property
Type
Description

ner

Object

Object containing start/end details about the entity selected.

  • start

    • In text, int, 0-indexed index of the first character in the entity.

    • In audio, float, value in seconds where the entity starts.

  • end

    • In text, int, 0-indexed index of the last character in the entity.

    • In audio, float, value in seconds where the entity stops.

  • selection (text only): Text content of the entity.

See also

Entity

PDF

Property
Type
Description

pdf

Object

Object containing coordinate, size, and content details about the PDF area.

  • position: dict, positional information regarding the object

    • boundingRect: dict, positional information regarding the object

      • x1 and y1 X, Y coordinates of the top left point of the PDF area

      • x2 and y2 X, Y coordinates of the bottom right point of the PDF area

    • rects: list, deprecated.

    • pageNumber: int, the number of the PDF page where the object is found. 1-indexed.

  • content: dict, information regarding the content of the object

    • text: string, if OCR was run for the object, the OCR result.

    • confidence: int, range: 0-100, if OCR was run for the object, the confidence in the OCR result as returned by Hub.

See also

PDF Tool

Point

Property
Type
Description

point

Object

Object containing coordinate details about the point. The X, Y coordinates of the point.

3D Medical Labeling Editor Sample

In the 3D Medical labeling editor, points created or edited on a reformatted oblique plane include nrrdReformat. See Medical Reformat Metadata.

See also

Point

Polygon

Property
Type
Description

polygon

List

List of lists containing X, Y coordinates of each polygon point. List may contain any number of x, y coordinate pairs.

In the 3D Medical labeling editor, polygons created or edited on a reformatted oblique plane include nrrdReformat. See Medical Reformat Metadata.

Polyline

Property
Type
Description

polyline

Object

Object containing coordinate details about the points making up the polyline. A list of X, Y coordinates of its points. Points are represented consecutively. The first point in the list is the first point that was clicked when creating the polyline.

Medical Line Tool

In the 3D Medical labeling editor, line annotations created or edited on a reformatted oblique plane include nrrdReformat. See Medical Reformat Metadata.

Property
Type
Description

polyline

Object

Object containing coordinate details about the points making up the line. A dict containing 3D coordinates, in pixels, of its points, as well as its length. (Length is only available for lines created or modified after the Ango Hub 3.21 update.)

Rotated Bounding Box

Rotated Bounding Box Angles

Property
Type
Description

rotated-bounding-box

Object

Object containing coordinate and dimension details about the rotated bounding box. x - The X coordinate of the origin point (i.e. where the user first clicked) of the rotated bounding box

y - The Y coordinate of the origin point (i.e. where the user first clicked) of the rotated bounding box

width - The width of the rotated bounding box, in pixels

height - the height of the rotated bounding box, in pixels

rotation - the angle of rotation of the rotated bounding box, in degrees. Range: -180|+180

corners - A list of X, Y coordinate pairs pertaining to the location of the four corners of the rotated bounding box.

Segmentation

Metadata for segmentations will not appear even when enabling the Annotation Metadata toggle in the export settings.

Segmentations are composed of instances, zones, regions, and holes.

An instance may contain more than one zone. One zone contains exactly one region. A region can contain more than one hole.

Each of the points composing the segmentation is represented as an X/Y coordinate pair.

Properties of the Segmentation Tool
Property
Type
Description

segmentation

Object

Object containing details about a segmentation instance. A segmentation instance can be composed of multiple zones. Each zone contains at least one region and may optionally contain a hole, which is always included, coordinate wise, within the region. More details in the segmentation section above.

Skeleton

Property
Type
Description

skeleton

Object

Object containing coordinate and dimension details about the skeleton tool. nodes - A list of keypoints that define the skeleton structure. Each node represents a point with a position in the asset.

edges - A list of connections between nodes that define the relationships or bones of the skeleton.

See also

Skeleton

PCT

See also

PCT

Last updated