FigureInfo¶

class FigureInfo(id, class_id, updated_at, created_at, entity_id, object_id, project_id, dataset_id, frame_index, geometry_type, geometry, geometry_meta, tags, meta, area, priority=None, custom_data=None)[source]¶

Bases: NamedTuple

Represents detailed information about a figure in a scene within the labeling tool. It is designed to handle multimodal data.

Attributes:: id (int): Unique identifier for the figure. class_id (int): Identifier for the class of the figure. updated_at (str): Timestamp of the last update. created_at (str): Timestamp of creation. entity_id (int): Identifier for the entity. Possible entities: image, video, volume, pointcloud, etc. object_id (int): Identifier for the object (applicable to videos, volumes, pointclouds). project_id (int): Identifier for the project. dataset_id (int): Identifier for the dataset. frame_index (int): Index of the frame (applicable to videos, volumes (as a slice_index), pointclouds). geometry_type (str): Type of geometry. geometry (dict): Geometry data. geometry_meta (dict): Metadata for the geometry. tags (list): List of tags associated with the figure. meta (dict): Additional metadata. area (str): Area information. priority (int): Position of the figure relative to other overlapping or underlying figures.

Create new instance of FigureInfo(id, class_id, updated_at, created_at, entity_id, object_id, project_id, dataset_id, frame_index, geometry_type, geometry, geometry_meta, tags, meta, area, priority, custom_data)

Methods

`count`	Return number of occurrences of value.
`index`	Return first index of value.
`to_json`

Attributes

`area`	Alias for field number 14
`bbox`	Get Figure's bounding box.
`class_id`	Alias for field number 1
`created_at`	Alias for field number 3
`custom_data`	Alias for field number 16
`dataset_id`	Alias for field number 7
`entity_id`	Alias for field number 4
`frame_index`	Alias for field number 8
`geometry`	Alias for field number 10
`geometry_meta`	Alias for field number 11
`geometry_type`	Alias for field number 9
`id`	Alias for field number 0
`meta`	Alias for field number 13
`object_id`	Alias for field number 5
`priority`	Alias for field number 15
`project_id`	Alias for field number 6
`tags`	Alias for field number 12
`updated_at`	Alias for field number 2

count(value, /)¶: Return number of occurrences of value.

index(value, start=0, stop=9223372036854775807, /)¶

Return first index of value.

Raises ValueError if the value is not present.

area¶: Alias for field number 14

property bbox : supervisely.geometry.rectangle.Rectangle | None¶

Get Figure’s bounding box.

Returns:: Rectangle in supervisely format.
Return type:: Rectangle

class_id¶: Alias for field number 1

created_at¶: Alias for field number 3

custom_data¶: Alias for field number 16

dataset_id¶: Alias for field number 7

entity_id¶: Alias for field number 4

frame_index¶: Alias for field number 8

geometry¶: Alias for field number 10

geometry_meta¶: Alias for field number 11

geometry_type¶: Alias for field number 9

id¶: Alias for field number 0

meta¶: Alias for field number 13

object_id¶: Alias for field number 5

priority¶: Alias for field number 15

project_id¶: Alias for field number 6

tags¶: Alias for field number 12

updated_at¶: Alias for field number 2