注释

类 dataframe.Annotation(values=None, id=None, labels=None, confidence=None, metadata=None)​

注释对象，表示通用目的的注释数据。 应根据需要进行继承和扩展/指定

创建一个新的注释对象

• 参数

  • values (Union[Sequence[Union[int, float]], Sequence[Sequence[Union[int, float]]], None]) – 一系列数值或一系列数值序列的列表

  • id (Optional[str]) – 表示特定注释的字符串。用于跟踪对象。None 是一个有效的选项。

  • labels (Optional[Sequence[str]]) – 标签列表（字符串）

  • confidence (Optional[float]) – 注释的置信度

  • metadata (Optional[dict]) – 用于存储多个字段/值的通用字典

• 返回类型

  无

---

label_enum​

属性 label_enum

根据DataView映射返回枚举值（整数），这是一个只读字段

• 返回类型

  Optional[int]

• 返回

  (int)

---

Annotation.get_type​

classmethod get_type()

• 返回类型

  str

• 返回

  表示注释类型的唯一字符串。 可选值：“p2d”, “k2d”, “k3d”, “elp”, “b2d”, “b3d”, “im”, “mask”

---

值​

属性值

• 返回类型

  Union[Sequence[Union[int, float]], Sequence[Sequence[Union[int, float]]], None]

• 返回

  list(float), 或 list(list(float)), 与注释对象关联的值

---

id​

属性ID

返回与注释对象关联的ID（str），如果不适用则返回None。

• 返回类型

  Optional[str]

• 返回

  在帧上下文中的注释的唯一ID

---

标签​

属性标签

返回与注释对象关联的标签（字符串）列表

• 返回类型

  Optional[Sequence[str]]

• 返回

  列表（字符串）

---

元数据​

属性元数据

返回存储多个字段/值的通用字典

• 返回类型

  Optional[dict]

• 返回

  (字典)

---

置信度​

属性 confidence

返回与注释相关的置信度

• 返回类型

  Optional[float]

• 返回

  (浮点数)

---

to_dict​

to_dict()

返回符合REST API规范的字典

• 返回类型

  dict

• 返回

  API兼容的字典，可直接与REST-API一起使用

---

注册​

*静态注册(类型名称)

一个装饰器，用于为从Annotation派生的类注册注释类型名称

• 参数

  type_names (list ( str ) ) – 与类类型关联的注释类型列表。

• 返回类型

  Callable

---

复制​

copy()

返回此注释的副本。 :param id: 一个可选的ID值。如果为None，将创建一个新的随机UUID。

• 返回类型

  Annotation

• 返回

  注释对象

类 dataframe.Mask(mask_rgb=None, id=None, labels=None, confidence=None, metadata=None, mask_id=None)​

扩展Annotation类对象。

掩码对象，表示一个掩码注释。

创建一个新的注释对象

• 参数

  • values – 一系列数值或一系列数值序列的列表

  • id (可选 [ str ] ) – 表示特定注释的字符串。用于跟踪对象。None 是一个有效的选项。

  • labels (可选 [ 序列 [ 字符串 ] ] ) – 标签列表（字符串）

  • confidence (可选 [ float ] ) – 注释的置信度

  • metadata (可选 [ 字典 ] ) – 用于存储多个字段/值的通用字典

  • mask_rgb (可选 [ 序列 [ int *, * int *, * int ] ] ) –

  • mask_id (可选 [ str ] ) –

• 返回类型

  ()

---

mask_id​

属性 mask_id

• 返回类型

  str

• 返回

  掩码ID

---

mask_rgb​

属性 mask_rgb

• 返回类型

  序列[int, int, int]

• 返回

  RGB列表 [int, int, int]

类 dataframe.Polygon2D(polygon_xy=None, id=None, labels=None, confidence=None, metadata=None)​

扩展Annotation类对象。

Polygon2D 对象，表示一个2D多边形，将浮点值集合解析为x,y顶点对。

创建一个新的注释对象

• 参数

  • values – 一系列数值或一系列数值序列的列表

  • id (可选 [ str ] ) – 表示特定注释的字符串。用于跟踪对象。None 是一个有效的选项。

  • labels (可选 [ 序列 [ 字符串 ] ] ) – 标签列表（字符串）

  • confidence (可选 [ float ] ) – 注释的置信度

  • metadata (可选 [ 字典 ] ) – 用于存储多个字段/值的通用字典

  • polygon_xy (可选 [ 序列 [ 元组 [ 浮点数 *, * 浮点数 ] ] ] ) –

• 返回类型

  ()

---

获取边界框​

get_bounding_box()

获取这个2D多边形的边界框

• 返回类型

  序列[4, 浮点数]

• 返回

  [左x 上y 宽度 高度]

---

多边形_xy​

属性 polygon_xy

• 返回类型

  Sequence[Tuple[float, float]]

• 返回

  x,y对的列表 [(float, float), ]

class dataframe.ComplexPolygon2D(polygons_xy=None, id=None, labels=None, confidence=None, metadata=None)​

扩展Annotation类对象。

ComplexPolygon2D 对象，表示一组二维多边形， 将浮点值集合解析为多边形列表（每个多边形包含一对 x,y 顶点）。

创建一个新的注释对象

• 参数

  • values – 一系列数值或一系列数值序列的列表

  • id (可选 [ str ] ) – 表示特定注释的字符串。用于跟踪对象。None 是一个有效的选项。

  • labels (可选 [ 序列 [ 字符串 ] ] ) – 标签列表（字符串）

  • confidence (可选 [ float ] ) – 注释的置信度

  • metadata (可选 [ 字典 ] ) – 用于存储多个字段/值的通用字典

  • polygons_xy (可选 [ 序列 [ 序列 [ 元组 [ 浮点数 *, * 浮点数 ] ] ] ] ) –

• 返回类型

  ()

---

获取边界框​

get_bounding_box()

获取这个2D多边形的边界框

• 返回类型

  序列[4, 浮点数]

• 返回

  [左x 上y 宽度 高度]

---

多边形_xy​

属性 polygons_xy

• 返回类型

  Sequence[Sequence[Tuple[float, float]]]

• 返回

  x,y对的列表 [[(float, float), ], [(float, float), ], ]

类 dataframe.Polygon3D(polygon_xyz=None, id=None, labels=None, confidence=None, metadata=None)​

扩展Annotation类对象。

Polygon3D 对象，表示一个 3D 多边形，将浮点值集合解析为 x,y,z 顶点的三元组。

创建一个新的注释对象

• 参数

  • values – 一系列数值或一系列数值序列的列表

  • id (可选 [ str ] ) – 表示特定注释的字符串。用于跟踪对象。None 是一个有效的选项。

  • labels (可选 [ 序列 [ 字符串 ] ] ) – 标签列表（字符串）

  • confidence (可选 [ float ] ) – 注释的置信度

  • metadata (可选 [ 字典 ] ) – 用于存储多个字段/值的通用字典

  • polygon_xyz (可选 [ 序列 [ 元组 [ float *, * float *, * float ] ] ] ) –

• 返回类型

  ()

---

多边形_xyz​

属性 polygon_xyz

• 返回类型

  Sequence[Tuple[float, float, float]]

• 返回

  x, y, z 三元组列表 [(float, float, float), ]

class dataframe.ComplexPolygon3D(polygons_xyz=None, id=None, labels=None, confidence=None, metadata=None)​

扩展Annotation类对象。

ComplexPolygon3D 对象，表示一组 3D 多边形， 将一组浮点值解析为多边形列表（每个多边形由 x、y、z 顶点的三元组组成）。

创建一个新的注释对象

• 参数

  • values – 一系列数值或一系列数值序列的列表

  • id (Optional[str]) – 表示特定注释的字符串。用于跟踪对象。None 是一个有效的选项。

  • labels (Optional[Sequence[str]]) – 标签列表（字符串）

  • confidence (Optional[float]) – 注释的置信度

  • metadata (Optional[dict]) – 用于存储多个字段/值的通用字典

  • polygons_xyz (可选 [ 序列 [ 序列 [ 元组 [ float *, * float *, * float ] ] ] ] ) –

• 返回类型

  无

---

多边形_xyz​

属性 polygons_xyz

• 返回类型

  Sequence[Sequence[Tuple[float, float, float]]]

• 返回

  x, y, z 三元组的列表 [[(float, float, float), ], [(float, float, float), ], ]

类 dataframe.KeyPoints2D(keypoints_xy=None, id=None, labels=None, confidence=None, metadata=None)​

扩展Annotation类对象。

KeyPoints2D 对象，表示一组二维关键点，将浮点值集合解析为 x,y 点对。

创建一个新的注释对象

• 参数

  • values – 一系列数值或一系列数值序列的列表

  • id (可选 [ str ] ) – 表示特定注释的字符串。用于跟踪对象。None 是一个有效的选项。

  • labels (可选 [ 序列 [ 字符串 ] ] ) – 标签列表（字符串）

  • confidence (可选 [ float ] ) – 注释的置信度

  • metadata (可选 [ 字典 ] ) – 用于存储多个字段/值的通用字典

  • keypoints_xy (可选 [ 序列 [ 元组 [ 浮点数 *, * 浮点数 ] ] ] ) –

• 返回类型

  ()

---

获取边界框​

get_bounding_box()

获取此2D关键点对象的边界框

• 返回类型

  序列[4, 浮点数]

• 返回

  [左x 上y 宽度 高度]

---

关键点_xy​

属性 keypoints_xy

• 返回类型

  Sequence[Tuple[float, float]]

• 返回

  x,y对的列表 [(float, float), ]

class dataframe.KeyPoints3D(keypoints_xyz=None, id=None, labels=None, confidence=None, metadata=None)​

扩展Annotation类对象。

KeyPoints3D 对象，表示一组 3D 关键点，将浮点值集合解析为 x,y,z 点的三元组。

创建一个新的注释对象

• 参数

  • values – 一系列数值或一系列数值序列的列表

  • id (可选 [ str ] ) – 表示特定注释的字符串。用于跟踪对象。None 是一个有效的选项。

  • labels (可选 [ 序列 [ 字符串 ] ] ) – 标签列表（字符串）

  • confidence (可选 [ float ] ) – 注释的置信度

  • metadata (可选 [ 字典 ] ) – 用于存储多个字段/值的通用字典

  • keypoints_xyz (可选 [ 序列 [ 元组 [ 浮点数 *, * 浮点数 *, * 浮点数 ] ] ] ) –

• 返回类型

  ()

---

关键点_xyz​

属性 keypoints_xyz

• 返回类型

  Sequence[Tuple[float, float, float]]

• 返回

  x, y, z 三元组列表 [(float, float, float), ]

class dataframe.Ellipse2D(ellipse2d_xyrrt=None, id=None, labels=None, confidence=None, metadata=None)​

扩展Annotation类对象。

Ellipse2D 对象，表示一个二维椭圆，解析中心点，rx 和 ry 作为半径，theta 作为旋转角度（弧度）

创建一个新的注释对象

• 参数

  • values – 一系列数值或一系列数值序列的列表

  • id (可选 [ str ] ) – 表示特定注释的字符串。用于跟踪对象。None 是一个有效的选项。

  • labels (可选 [ 序列 [ 字符串 ] ] ) – 标签列表（字符串）

  • confidence (可选 [ float ] ) – 注释的置信度

  • metadata (可选 [ 字典 ] ) – 用于存储多个字段/值的通用字典

  • ellipse2d_xyrrt (可选 [ 序列 [ 5 *, * 浮点数 ] ] ) –

• 返回类型

  ()

---

角度​

属性 angle

返回椭圆的弧度角度

• 返回类型

  float

• 返回

  float 表示角度（弧度）

---

中心​

属性中心

返回椭圆的中心

• 返回类型

  Tuple[float, float]

• 返回

  (float, float) 表示中心 x, y 坐标

---

ellipse2d_xyrrt​

属性 ellipse2d_xyrrt

• 返回类型

  序列[浮点数, 浮点数, 浮点数, 浮点数, 浮点数]

• 返回

  x、y、rx、ry 和 theta 作为角度（弧度）的列表 [float, float, float, float, float]

---

获取边界框​

get_bounding_box()

获取此2D椭圆的边界框（角度以弧度表示）

• 返回类型

  序列[5, 浮点数]

• 返回

  [左x 上y 宽度 高度 角度]

---

获取多边形​

get_polygon(num_point=4)

获取一个包裹椭圆的点集

• 参数

  num_point (int) – 多边形的点数。

• 返回类型

  Sequence[Tuple[float, float]]

• 返回

  x,y对的列表 [(float, float), (float, float), …]

---

半径​

属性半径

返回椭圆的半径

• 返回类型

  Tuple[float, float]

• 返回

  (float, float) 表示 (rx, ry)

class dataframe.BoundingBox2D(bounding_box_xywh=None, id=None, labels=None, confidence=None, metadata=None)​

扩展Annotation类对象。

BoundingBox2D 对象，表示一个二维边界框，将一组浮点值解析为顶部、左侧、宽度、高度、角度（弧度）五个值。

创建一个新的注释对象

• 参数

  • values – 一系列数值或一系列数值序列的列表

  • id (可选 [ str ] ) – 表示特定注释的字符串。用于跟踪对象。None 是一个有效的选项。

  • labels (可选 [ 序列 [ 字符串 ] ] ) – 标签列表（字符串）

  • confidence (可选 [ float ] ) – 注释的置信度

  • metadata (可选 [ 字典 ] ) – 用于存储多个字段/值的通用字典

  • bounding_box_xywh (可选 [ 序列 [ 5 *, * 浮点数 ] ] ) –

• 返回类型

  ()

---

角度​

属性 angle

• 返回类型

  float

• 返回

  边界框的角度（弧度）

---

bounding_box_xywh​

属性 bounding_box_xywh

• 返回类型

  序列[4, 浮点数]

• 返回

  边界框的顶部x、左侧y、宽度、高度列表（浮点数，浮点数，浮点数，浮点数）

---

bounding_box_xywha​

属性 bounding_box_xywha

• 返回类型

  序列[5, 浮点数]

• 返回

  边界框的顶部x、左侧y、宽度、高度、角度（弧度）列表 (float, float, float, float, float)

---

获取边界框​

get_bounding_box()

获取此2D边界框的边界框（角度以弧度表示）

• 返回类型

  序列[4, 浮点数]

• 返回

  [左x 上y 宽度 高度]

类 dataframe.BoundingBox3D(bounding_box_3d_xyzwhxyzwh=None, id=None, labels=None, confidence=None, metadata=None)​

扩展Annotation类对象。

BoundingBox3D 对象，表示一个3D边界框，解析一组浮点值如下： 前-上-左角（三元组 x,y,z），前-宽度，前-高度， 后-上-左角（三元组 x,y,z），后-宽度，后-高度

创建一个新的注释对象

• 参数

  • values – 一系列数值或一系列数值序列的列表

  • id (可选 [ str ] ) – 表示特定注释的字符串。用于跟踪对象。None 是一个有效的选项。

  • labels (可选 [ 序列 [ 字符串 ] ] ) – 标签列表（字符串）

  • confidence (可选 [ float ] ) – 注释的置信度

  • metadata (可选 [ 字典 ] ) – 用于存储多个字段/值的通用字典

  • bounding_box_3d_xyzwhxyzwh (可选 [ 序列 [ 10 *, * 浮点数 ] ] ) –

• 返回类型

  ()

---

bounding_box_3d_xyzwhxyzwh​

属性 bounding_box_3d_xyzwhxyzwh

• 返回类型

  序列[10, 浮点数]

• 返回

  10个浮点数的列表：前-顶-左角（三元组 x,y,z），前宽度，前高度， 后-顶-左角（三元组 x,y,z），后宽度，后高度

class dataframe.ImageAnnotation(image_classes=None, id=None, labels=None, confidence=None, metadata=None)​

扩展Annotation类对象。

ImageAnnotation 注释对象，表示图像级别的注释（适用于整个图像）

创建一个新的注释对象

• 参数

  • values – 一系列数值或一系列数值序列的列表

  • id (可选 [ str ] ) – 表示特定注释的字符串。用于跟踪对象。None 是一个有效的选项。

  • labels (可选 [ 序列 [ 字符串 ] ] ) – 标签列表（字符串）

  • confidence (可选 [ float ] ) – 注释的置信度

  • metadata (可选 [ 字典 ] ) – 用于存储多个字段/值的通用字典

  • image_classes (可选 [ 序列 [ 字符串 ] ] ) –

• 返回类型

  ()