Source code for supervisely.api.volume.volume_object_api

# coding: utf-8
"""Work with volume objects via the Supervisely API."""

from supervisely.api.entity_annotation.object_api import ObjectApi
from supervisely.video_annotation.key_id_map import KeyIdMap
from supervisely.volume_annotation.volume_object_collection import (
    VolumeObjectCollection,
)



[docs]
class VolumeObjectApi(ObjectApi):
    """
    API for working with :class:`~supervisely.volume_annotation.volume_object.VolumeObject` in
    :class:`~supervisely.volume_annotation.volume_annotation.VolumeAnnotation`.
    :class:`~supervisely.api.volume.volume_object_api.VolumeObjectApi` object is immutable.
    """


[docs]
    def append_bulk(
        self, volume_id: int, objects: VolumeObjectCollection, key_id_map: KeyIdMap = None
    ):
        """
        Add objects to VolumeAnnotation.

        :param volume_id: Volume ID in Supervidely.
        :type volume_id: int
        :param objects: VolumeAnnotation objects.
        :type objects: :class:`~supervisely.volume_annotation.volume_object_collection.VolumeObjectCollection`
        :param key_id_map: KeyIdMap object.
        :type key_id_map: :class:`~supervisely.video_annotation.key_id_map.KeyIdMap`, optional
        :returns: List of objects IDs
        :rtype: List[int]

        :Usage Example:

            .. code-block:: python

                import os
                from dotenv import load_dotenv

                import supervisely as sly

                from supervisely.volume_annotation.volume_tag import VolumeTag
                from supervisely.video_annotation.key_id_map import KeyIdMap

                # Load secrets and create API object from .env file (recommended)
                # Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
                if sly.is_development():
                    load_dotenv(os.path.expanduser("~/supervisely.env"))

                api = sly.Api.from_env()

                project_id = 17209
                volume_id = 19402023

                meta_json = api.project.get_meta(project_id)
                project_meta = sly.ProjectMeta.from_json(meta_json)

                key_id_map = KeyIdMap()
                ann_info = api.volume.annotation.download(volume_id)
                ann = sly.VolumeAnnotation.from_json(ann_info, project_meta, key_id_map)

                api.volume.object.append_bulk(volume_id, ann.objects, key_id_map)
        """

        info = self._api.volume.get_info_by_id(volume_id)
        return self._append_bulk(
            self._api.volume.tag,
            volume_id,
            info.project_id,
            info.dataset_id,
            objects,
            key_id_map,
        )