Objects.coordinates

​

BoundingBoxCoordinates Objects

@dataclass(frozen=True)
class BoundingBoxCoordinates()

• height float - The height of the bounding box.
• width float - The width of the bounding box.
• top_left_x float - The x-coordinate of the top-left corner.
• top_left_y float - The y-coordinate of the top-left corner.

​

from_dict

@staticmethod
def from_dict(d: BoundingBoxFrameCoordinatesDict) -> BoundingBoxCoordinates

• d dict - A dictionary containing bounding box information.

• BoundingBoxCoordinates - An instance of BoundingBoxCoordinates.

​

to_dict

def to_dict() -> BoundingBoxDict

• dict - A dictionary representation of the bounding box coordinates.

​

RotatableBoundingBoxCoordinates Objects

@dataclass(frozen=True)
class RotatableBoundingBoxCoordinates()

• height float - The height of the bounding box.
• width float - The width of the bounding box.
• top_left_x float - The x-coordinate of the top-left corner.
• top_left_y float - The y-coordinate of the top-left corner.
• theta float - The angle of rotation originating at the center of the box.

​

theta

​

from_dict

@staticmethod
def from_dict(
    d: RotatableBoundingBoxFrameCoordinatesDict
) -> RotatableBoundingBoxCoordinates

• d dict - A dictionary containing rotatable bounding box information.

• RotatableBoundingBoxCoordinates - An instance of RotatableBoundingBoxCoordinates.

​

to_dict

def to_dict() -> RotatableBoundingBoxDict

• dict - A dictionary representation of the rotatable bounding box coordinates.

​

CuboidCoordinates Objects

@dataclass(frozen=True)
class CuboidCoordinates()

• position tuple[float, float, float] - The (x, y, z) coordinates of the center of the cuboid in the 3D space.
• orientation tuple[float, float, float] - The (alpha, beta, gamma) Euler angles of the cuboid, in radians.
• size tuple[float, float, float] - The size of the cuboid along its (x, y, z) axes.

​

Cuboid2DPerspectiveCoordinates Objects

@dataclass(frozen=True)
class Cuboid2DPerspectiveCoordinates()

• front List[PointCoordinate] - The vertices of the front face as a list of PointCoordinate objects.
• vanishing_point PointCoordinate - The point where parallel lines appear to converge.
• scale_ratio float - The size of the back face relative to the front face (0.0 to N).
  • 2.0: Back face is twice the size.
  • 1.0: No depth (back matches front).
  • 0.5: Back face is half the size.
  • 0.0: Back face recedes infinitely to the vanishing point.

cuboid = Cuboid2DPerspectiveCoordinates( … front=[PointCoordinate(x=0, y=0), PointCoordinate(x=0.1, y=0), … PointCoordinate(x=0.1, y=0.1), PointCoordinate(x=0, y=0.1)], … vanishing_point=PointCoordinate(x=0.4, y=0.3), … scale_ratio=0.75 … )

​

to_dict

def to_dict() -> Dict

• dict - A dictionary representation of the cuboid 2D coordinates.

​

Cuboid2DIsometricCoordinates Objects

@dataclass(frozen=True)
class Cuboid2DIsometricCoordinates()

• front List[PointCoordinate] - The vertices of the front face as a list of PointCoordinate objects.
• offset PointCoordinate - The translation vector to shift the back face.

cuboid = Cuboid2DIsometricCoordinates( … front=[PointCoordinate(x=0, y=0), PointCoordinate(x=0.1, y=0), … PointCoordinate(x=0.1, y=0.1), PointCoordinate(x=0, y=0.1)], … offset=PointCoordinate(x=0.05, y=-0.05) … )

​

to_dict

def to_dict() -> Dict

• dict - A dictionary representation of the cuboid 2D coordinates.

​

Cuboid2DCoordinates

​

cuboid_2d_coordinates_from_dict

def cuboid_2d_coordinates_from_dict(
        d: Cuboid2DFrameCoordinatesDict) -> Cuboid2DCoordinates

• d dict - A dictionary containing cuboid_2d coordinates information.

• Cuboid2DCoordinates - Either Cuboid2DPerspectiveCoordinates or Cuboid2DIsometricCoordinates.

​

PointCoordinate Objects

@dataclass(frozen=True)
class PointCoordinate()

• x float - The x-coordinate of the point.
• y float - The y-coordinate of the point.

​

from_dict

@staticmethod
def from_dict(d: PointFrameCoordinatesDict) -> PointCoordinate

• d dict - A dictionary containing point coordinate information.

• PointCoordinate - An instance of PointCoordinate.

​

to_dict

def to_dict() -> Dict[str, PointDict]

• dict - A dictionary representation of the point coordinate.

​

PointCoordinate3D Objects

@dataclass(frozen=True)
class PointCoordinate3D()

• x float - The x-coordinate of the point.
• y float - The y-coordinate of the point.
• z float - The z-coordinate of the point.

​

from_dict

@staticmethod
def from_dict(d: Point3DFrameCoordinatesDict) -> PointCoordinate3D

• d dict - A dictionary containing point coordinate information.

• PointCoordinate3D - An instance of PointCoordinate3D.

​

to_dict

def to_dict() -> dict[str, PointDict3D]

• dict - A dictionary representation of the point coordinate.

​

PolygonCoordinates Objects

class PolygonCoordinates()

​

__init__

def __init__(values: Optional[List[PointCoordinate]] = None,
             polygons: Optional[List[List[List[PointCoordinate]]]] = None)

• values List[PointCoordinate] - A list of PointCoordinate objects defining the polygon.
• polygons List[List[List[PointCoordinate]]] - A list of polygons, where each polygon is a list of contours, where each contour is a list of points.

​

from_dict

@staticmethod
def from_dict(d: PolygonFrameCoordinatesDict) -> "PolygonCoordinates"

• d dict - Dictionary containing polygon coordinates information.

• PolygonCoordinates - A PolygonCoordinates instance.

{
  "polygon": {
    "0": {"x": 12.3, "y": 45.6},
    "1": {"x": 78.9, "y": 12.3}
  }
}

{
  "polygon": [
    {"x": 12.3, "y": 45.6},
    {"x": 78.9, "y": 12.3}
  ]
}

{
  "polygons": [
    [
      [
        {"x": 12.3, "y": 45.6},
        {"x": 78.9, "y": 12.3}
      ]
    ]
  ]
}

​

to_dict

def to_dict(
    kind: Union[PolygonCoordsToDict, str] = PolygonCoordsToDict.single_polygon
) -> Union[Dict, List[List[List[float]]]]

• dict - A dictionary representation of the polygon coordinates.

​

PolylineCoordinates Objects

@dataclass(frozen=True)
class PolylineCoordinates()

• values Union[List[PointCoordinate], List[PointCoordinate3D]] - A list of (3D) PointCoordinate objects defining the polyline.

​

from_dict

@staticmethod
def from_dict(d: PolylineFrameCoordinatesDict) -> PolylineCoordinates

• d dict - A dictionary containing polyline coordinates information.

• PolylineCoordinates - An instance of PolylineCoordinates.

​

to_dict

def to_dict() -> Dict

• dict - A dictionary representation of the polyline coordinates.

​

Visibility Objects

class Visibility(CamelStrEnum)

• VISIBLE - The item is visible within the frame.
• INVISIBLE - The item is outside the frame and thus invisible.
• OCCLUDED - The item is within the frame but occluded by something else.
• SELF_OCCLUDED - The item is occluded by itself.

​

SkeletonCoordinate Objects

class SkeletonCoordinate(BaseDTO)

• x float - The x-coordinate of the skeleton point.
• y float - The y-coordinate of the skeleton point.
• name str - The name of the skeleton point.
• color Optional[str] - The color associated with the skeleton point.
• feature_hash Optional[str] - A unique hash for the feature.
• value Optional[str] - An optional value associated with the skeleton point.
• visibility Optional[Visibility] - The visibility state of the skeleton point.

​

SkeletonCoordinates Objects

class SkeletonCoordinates(BaseDTO)

• values List[SkeletonCoordinate] - A list of SkeletonCoordinate objects.
• name str - The name of the skeleton structure.

​

to_dict

def to_dict(by_alias=True, exclude_none=True) -> Dict[str, Any]

• by_alias bool - Whether to use alias for the field names.
• exclude_none bool - Whether to exclude fields with None values.

​

AudioCoordinates Objects

class AudioCoordinates(BaseDTO)

• range Ranges - Ranges in milliseconds for audio files

​

TextCoordinates Objects

class TextCoordinates(BaseDTO)

• range Ranges - Ranges of chars for simple text files

​

HtmlCoordinates Objects

class HtmlCoordinates(BaseDTO)

• range List[HtmlRange] - A list of HtmlRange objects