Skip to main content

PointFrameCoordinatesDict Objects

class PointFrameCoordinatesDict(TypedDict)

point

Actually the key here is always ‘0’, but no way to type that.

Point3DFrameCoordinatesDict Objects

class Point3DFrameCoordinatesDict(TypedDict)

point

Actually the key here is always ‘0’, but no way to type that.

PolygonDict

Introduced to support complex polygons

PolygonFrameCoordinatesDict Objects

class PolygonFrameCoordinatesDict(PolygonFrameCoordinatesDictRequired)

polygons

This was introduced to support complex polygons.

Cuboid2DPerspectiveDict Objects

class Cuboid2DPerspectiveDict(TypedDict)
Perspective projection cuboid dict with vanishing point and scale ratio.

front

Flat array of coordinates [x1, y1, x2, y2, …]

Cuboid2DIsometricDict Objects

class Cuboid2DIsometricDict(TypedDict)
Isometric projection cuboid dict with offset.

front

Flat array of coordinates [x1, y1, x2, y2, …]

Cuboid2DDict

Union type for 2D cuboid dict - either perspective or isometric projection.

AnswerDict Objects

class AnswerDict(TypedDict)
Answer for attributes/classifications.

BaseFrameObjectRequired Objects

class BaseFrameObjectRequired(TypedDict)
Required fields for frame object in label blob.

BaseFrameObject Objects

class BaseFrameObject(BaseFrameObjectRequired)
All fields for base frame object in label blob. Shape data is not included here.

createdBy

This is optional because we set the default to the current user on the BE

lastEditedBy

This is optional because we set the default to the current user on the BE

reviews

TODO: Remove this as its deprecated

isDeleted

TODO: Remove this as its deprecated, although its still being sent out

SegmentationObject Objects

class SegmentationObject(BaseFrameObject)

segmentation

RLE encoded segmentation string

FrameObject

Frame object in the label blob. Contains shape data, and is differentiated by the ‘shape’ field.

FrameClassification Objects

class FrameClassification(FrameClassificationRequired)
Frame classification in label blob. No answers here, they are in the ClassificationAnswer

createdBy

This can be optional because we set the default to current the user at the BE

AttributeDict Objects

class AttributeDict(TypedDict)
Attribute for a classification OR an object. Note that these are inappropriately called “classifications” in ObjectAnswer and ClassificationAnswer.

DynamicAttributeObjectRequired Objects

class DynamicAttributeObjectRequired(AttributeDict)
Required fields for dynamic attribute object in object_actions.

trackHash

See if we can remove this

DynamicAttributeObject Objects

class DynamicAttributeObject(DynamicAttributeObjectRequired)
All fields for dynamic attribute object in object_actions.

ClassificationAnswer Objects

class ClassificationAnswer(ClassificationAnswerRequired)
Classification answer that contains attributes (sadly here its called classifications too) for the classification

reviews

TODO: Remove this as its deprecated

spaces

Empty dict if no spaces

ObjectAnswerForNonGeometric Objects

class ObjectAnswerForNonGeometric(BaseFrameObject)
For non-geometric modalities, metadata is contained in object answers, instead of frame

spaces

Important for non-geometric shapes, where space info must live on ObjectAnswer

LabelRowDict Objects

class LabelRowDict(TypedDict)
Work in progress type definition of a label row