Objects.types - Encord

CircleDict Objects

class CircleDict(TypedDict)

x

normalized center x [0, 1]

y

normalized center y [0, 1]

r

primary semi-axis radius, normalized to image width

stretch

ratio of secondary semi-axis to primary (1.0 = circle, !=1 = ellipse)

theta

rotation in degrees, clockwise in screen space (matches RBB convention)

EllipseDict Objects

class EllipseDict(TypedDict)

x

normalized center x [0, 1]

y

normalized center y [0, 1]

rx

horizontal semi-axis, normalized to image width

ry

vertical semi-axis, normalized to image height

theta

rotation in degrees, clockwise in screen space

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

event

Only present on event-based (continuous scene) label rows, where an entry is a sparse event on a continuous timeline rather than a label on a frame. Missing reads as "upsert".

interpolate

Reserved per-keyframe field on continuous scenes, in practice unset. Unset, null and "hold" all mean no interpolation; every other mode is refused, as the SDK would have to interpolate to read it correctly.

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.

DynamicAttributeObject Objects

class DynamicAttributeObject(DynamicAttributeObjectRequired)

All fields for dynamic attribute object in object_actions.

ClassificationAnswer Objects

class ClassificationAnswer(ClassificationAnswerRequired)

Classification answer that contains attributes for the classification

reviews

TODO: Remove this as its deprecated

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

​CircleDict Objects

​x

​y

​r

​stretch

​theta

​EllipseDict Objects

​x

​y

​rx

​ry

​theta

​PointFrameCoordinatesDict Objects

​point

​Point3DFrameCoordinatesDict Objects

​point

​PolygonDict

​PolygonFrameCoordinatesDict Objects

​polygons

​Cuboid2DPerspectiveDict Objects

​front

​Cuboid2DIsometricDict Objects

​front

​Cuboid2DDict

​AnswerDict Objects

​BaseFrameObjectRequired Objects

​BaseFrameObject Objects

​createdBy

​lastEditedBy

​reviews

​isDeleted

​event

​interpolate

​SegmentationObject Objects

​segmentation

​FrameObject

​FrameClassification Objects

​createdBy

​AttributeDict Objects

​DynamicAttributeObjectRequired Objects

​DynamicAttributeObject Objects

​ClassificationAnswer Objects

​reviews

​ObjectAnswerForNonGeometric Objects

​spaces

​LabelRowDict Objects

CircleDict Objects

x

y

r

stretch

theta

EllipseDict Objects

x

y

rx

ry

theta

PointFrameCoordinatesDict Objects

point

Point3DFrameCoordinatesDict Objects

point

PolygonDict

PolygonFrameCoordinatesDict Objects

polygons

Cuboid2DPerspectiveDict Objects

front

Cuboid2DIsometricDict Objects

front

Cuboid2DDict

AnswerDict Objects

BaseFrameObjectRequired Objects

BaseFrameObject Objects

createdBy

lastEditedBy

reviews

isDeleted

event

interpolate

SegmentationObject Objects

segmentation

FrameObject

FrameClassification Objects

createdBy

AttributeDict Objects

DynamicAttributeObjectRequired Objects

DynamicAttributeObject Objects

ClassificationAnswer Objects

reviews

ObjectAnswerForNonGeometric Objects

spaces

LabelRowDict Objects