Skip to main content

FrameGroup

类 dataframe.FrameGroup(id=None, metadata=None, *args, **kwargs)​

表示一组帧，以字典的形式

使用SingleFrame列表和键名进行初始化

  • 参数

    • id (str ) – 设置帧组的唯一ID（字符串表示必须为字母数字）。 如果ID为None，将根据args/kwargs字典项生成一个唯一的UUID 如果没有提供args/kwargs，将为帧自动生成一个唯一的UUID

    • metadata (dict ) – 与帧组一起存储的通用字典（dict）。字典必须是可json化的。 注意：metadata的键不能与SingleFrames的源键相同

    • kwargs (SingleFrame) – 键/SingleFrame 集合（类似于字典初始化） image1=SingleFrame()

    • args (Union [ dict , * 单帧 ]* ) –

  • 返回类型

    无

id​

属性ID

  • 返回类型

    str

  • 返回

    表示整个系统中框架的UUID

元数据​

属性元数据

获取FrameGroup级别的元数据。

  • 返回类型

    dict

  • 返回

    通用字典（dict）与帧组一起存储。字典必须是可json化的。

起源​

属性 origin

返回框架的所有者数据集/版本信息（数据集是版本的集合）， 包括数据集ID、数据集名称、版本ID和版本名称。 注意：这是一个自动生成的只读属性。

  • 返回类型

    Dict[str, str]

数据集版本元数据​

属性 dataset_version_metadata

返回框架的所有者数据集版本元数据（只读）。

  • 返回类型

    dict

  • 返回

    字典

blob​

属性 blob

  • 返回类型

    str

  • 返回

    与框架组一起存储的非索引数据（字符串）

to_dict​

to_dict()

返回符合REST API规范的字典

  • 返回类型

    dict

  • 返回

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

复制​

copy()

返回此FrameGroup的副本，并带有新的随机UUID。

  • 返回类型

    FrameGroup

  • 返回

    框架组对象

获取全局注释​

get_global_annotations()

获取全局注释列表。 由于全局注释存在于该帧组的所有单帧中，此方法将返回其中一个单帧的全局注释列表。

添加全局注释​

add_global_annotation(annotation)

添加一个全局注释实例。该实例的副本将被添加到每一帧中。

  • 参数

    注释 (Annotation) – 一个注释实例

  • 返回类型

    None

remove_global_annotation​

remove_global_annotation(annotation)

移除一个全局注释实例。 该注释将从所有单帧中移除，并通过相等性测试进行定位。

  • 参数

    注释 (Annotation) – 一个注释实例

  • 返回类型

    bool

  • 返回

    如果注释成功从所有单帧中移除，则为True，否则为False。

清除​

clear() -> None. 从D中移除所有项目。

获取​

get(k, [d]) -> 如果k在D中，则返回D[k]，否则返回d。d默认为None。

项目​

items() -> 一个类似集合的对象，提供对D的项的视图

键​

keys() -> 一个类似集合的对象，提供对D的键的视图

弹出​

pop(k, [d]) -> v, 移除指定的键并返回对应的值。

如果未找到键，则返回给定的d，否则会引发KeyError。

popitem​

popitem() -> (k, v)，移除并返回某个（键，值）对

作为一个2元组；但如果D为空，则引发KeyError。

setdefault​

setdefault(k, [d]) -> D.get(k,d)，如果k不在D中，则设置D[k]=d

更新​

**update([E], F) -> None. 从映射/可迭代对象 E 和 F 更新 D。

如果 E 存在并且有 .keys() 方法，则执行： for k in E: D[k] = E[k] 如果 E 存在但没有 .keys() 方法，则执行： for (k, v) in E: D[k] = v 无论哪种情况，接下来都会执行： for k, v in F.items(): D[k] = v

值​

values() -> 一个提供D值视图的对象

FrameGroup.from_dict​

classmethod from_dict(framegroup_dict)

从符合REST API的字典构建FrameGroup

  • 参数

    framegroup_dict (dict ) – 从 FrameGroup.to_dict() 返回的字典

  • 返回类型

    FrameGroup

  • 返回

    从REST API字典构建的FrameGroup对象