📘
Click for Python SDK
Dataset.annotate(
annotations: List[Union[BoxAnnotation, PolygonAnnotation, LineAnnotation, CuboidAnnotation]],
update: bool,
asynchronous: bool
) -> Union[dict, AsyncJob]
This endpoint allows you to add box, polygon, cuboid, or category annotations to a Nucleus Dataset.
| Key | Type | Description |
|---|
x | float (required) | The distance, in pixels, between the left border of the bounding box and the left border of the image. |
y | float (required) | The distance, in pixels, between the top border of the bounding box and the top border of the image. |
width | float (required) | The width in pixels of the annotation. |
height | float (required) | The height in pixels of the annotation. |
| Key | Type | Description |
|---|
x | float (required) | The distance, in pixels, between the left border of the bounding box and the left border of the image. |
y | float (required) | The distance, in pixels, between the top border of the bounding box and the top border of the image. |
| Key | Type | Description |
|---|
vertices | array of Point2D | Array of Point objects that represent vertices of the polygon. |
| Key | Type | Description |
|---|
x | float (required) | The x coordinate of the point. |
y | float (required) | The y coordinate of the point. |
z | float (required) | The z coordinate of the point. |
| Key | Type | Description |
|---|
position | Point3D (required) | The center of the cuboid. |
dimensions | Point3D (required) | The length, width, and height of the cuboid. |
yaw | float (required) | The rotation, in radians, about the z axis of the cuboid. |
