PointcloudAnnotationAPI¶

class PointcloudAnnotationAPI(api)[source]¶

Bases: EntityAnnotationAPI

API for working with PointcloudAnnotation.

Parameters:

api¶

Api object to use for API connection.

Usage Example:

import supervisely as sly
api = sly.Api.from_env()
ann_info = api.pointcloud.annotation.download(pointcloud_id)

Methods

append	Loads an PointcloudAnnotation to a given point cloud ID in the API.
convert_info_to_json	Convert information about an entity to a dictionary.
download	Download information about PointcloudAnnotation by point cloud ID from the Supervisely instance.
download_async	Download information about PointcloudAnnotation by Point Cloud ID from API asynchronously.
download_bulk	Download a list of content (annotations with given ids from dataset with given id).
download_bulk_async	Download information about PointcloudAnnotation in bulk by Point Cloud IDs from API asynchronously.
exists	Checks if an entity with the given parent_id and name exists
get_free_name	Generates a free name for an entity with the given parent_id and name.
get_info_by_id	Get information about an entity by its ID from the Supervisely server.
get_info_by_name	Get information about an entity by its name from the Supervisely server.
get_list	Get list of entities in parent entity with given parent ID.
get_list_all_pages	Get list of all or limited quantity entities from the Supervisely server.
get_list_all_pages_generator	This generator function retrieves a list of all or a limited quantity of entities from the Supervisely server, yielding batches of entities as they are retrieved
get_list_idx_page_async	Get the list of items for a given page number.
get_list_page_generator_async	Yields list of images in dataset asynchronously page by page.
info_sequence	Get list of all class field names.
info_tuple_name	Get string name of NamedTuple.

Attributes

MAX_WAIT_ATTEMPTS	Maximum number of attempts that will be made to wait for a certain condition to be met.
WAIT_ATTEMPT_TIMEOUT_SEC	Number of seconds for intervals between attempts.

classmethod convert_info_to_json(info)¶

Convert information about an entity to a dictionary.

Parameters:

info : NamedTuple¶

Information about the entity.

Returns:

Dictionary with information about the entity.

Return type:

dict

static info_sequence()¶

Get list of all class field names.

static info_tuple_name()¶

Get string name of NamedTuple.

append(pointcloud_id, ann, key_id_map=None)[source]¶

Loads an PointcloudAnnotation to a given point cloud ID in the API.

Parameters:

pointcloud_id : int¶

Point cloud ID in Supervisely.

ann¶

PointcloudAnnotation object.

key_id_map=None¶

KeyIdMap object.

Returns:

None

Return type:

None

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# 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()

pointcloud_id = 198704259
api.pointcloud.annotation.append(pointcloud_id, pointcloud_ann)

download(pointcloud_id)[source]¶

Download information about PointcloudAnnotation by point cloud ID from the Supervisely instance.

Parameters:

pointcloud_id : int¶

Point cloud ID in Supervisely.

Returns:

Information about PointcloudAnnotation in JSON format

Return type:

dict

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# 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()

pointcloud_id = 19618685
ann_info = api.pointcloud.annotation.download(src_pointcloud_id)
print(ann_info)

# Output: {
#     'datasetId': 62664,
#     'description': '',
#     'frames': [{'figures': [{'classId': None,
#                             'createdAt': '2023-04-05T08:55:52.526Z',
#                             'description': '',
#                             'geometry': {'dimensions': {'x': 1.6056261,
#                                                         'y': 3.8312221,
#                                                         'z': 1.8019634},
#                                         'position': {'x': 10.181290418102629,
#                                                     'y': 9.033275311626847,
#                                                     'z': -0.9065660704238034},
#                                         'rotation': {'x': 0,
#                                                     'y': 0,
#                                                     'z': 1.5985649758590998}},
#                             'geometryType': 'cuboid_3d',
#                             'id': 87830573,
#                             'labelerLogin': 'almaz',
#                             'objectId': 5565738,
#                             'updatedAt': '2023-04-05T08:55:52.526Z'},
#                             {'classId': None,
#                             'createdAt': '2023-04-05T08:55:52.526Z',
#                             'description': '',
#                             'geometry': {'dimensions': {'x': 2.3652234,
#                                                         'y': 23.291742,
#                                                         'z': 3.326648},
#                                         'position': {'x': 77.40255111910977,
#                                                     'y': -9.582723835261527,
#                                                     'z': 1.0131292020311293},
#                                         'rotation': {'x': 0,
#                                                     'y': 0,
#                                                     'z': -1.5823898471886868}},
#                             'geometryType': 'cuboid_3d',
#                             'id': 87830574,
#                             'labelerLogin': 'almaz',
#                             'objectId': 5565741,
#                             'updatedAt': '2023-04-05T08:55:52.526Z'}],
#                 'index': 0,
#                 'pointCloudId': 19618685}],
#     'framesCount': 1,
#     'objects': [{'classId': 683259,
#                 'classTitle': 'Car',
#                 'createdAt': '2023-04-05T08:55:52.384Z',
#                 'datasetId': 62664,
#                 'entityId': None,
#                 'id': 5565737,
#                 'labelerLogin': 'almaz',
#                 'tags': [],
#                 'updatedAt': '2023-04-05T08:55:52.384Z'}],
#     'tags': []
# }

async download_async(pointcloud_id, semaphore=None, progress_cb=None)[source]¶

Download information about PointcloudAnnotation by Point Cloud ID from API asynchronously.

Parameters:

pointcloud_id : int¶

Point Cloud ID in Supervisely.

semaphore : asyncio.Semaphore, optional¶

Semaphore to limit the number of parallel downloads.

progress_cb : Union[tqdm, Callable], optional¶

Progress callback to track download progress.

Returns:

Information about PointcloudAnnotation in json format

Return type:

dict

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# 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()

pointcloud_id = 198702499
loop = sly.utils.get_or_create_event_loop()
ann_info = loop.run_until_complete(api.pointcloud.annotation.download_async(pointcloud_id))

download_bulk(dataset_id, entity_ids)¶

Download a list of content (annotations with given ids from dataset with given id).

Parameters:

dataset_id¶

int

entity_ids¶

list of integers

Returns:

list of content(annotations with given ids from dataset with given id), received after execution post request

async download_bulk_async(pointcloud_ids, semaphore=None, progress_cb=None)[source]¶

Download information about PointcloudAnnotation in bulk by Point Cloud IDs from API asynchronously.

Parameters:

pointcloud_ids : List[int]¶

Point Cloud IDs in Supervisely.

semaphore : asyncio.Semaphore, optional¶

Semaphore to limit the number of parallel downloads.

progress_cb : Union[tqdm, Callable], optional¶

Progress callback to track download progress.

Returns:

Information about PointcloudAnnotations in json format

Return type:

list

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# 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()

pointcloud_ids = [198702499, 198702500, 198702501]
loop = sly.utils.get_or_create_event_loop()
ann_infos = loop.run_until_complete(api.pointcloud.annotation.download_bulk_async(pointcloud_ids))

exists(parent_id, name)¶

Checks if an entity with the given parent_id and name exists

Parameters:

parent_id : int¶

ID of the parent entity.

name : str¶

Name of the entity.

Returns:

Returns True if entity exists, and False if not

Return type:

bool

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# 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()

name = "IMG_0315.jpeg"
dataset_id = 55832
exists = api.image.exists(dataset_id, name)
print(exists) # True

get_free_name(parent_id, name)¶

Generates a free name for an entity with the given parent_id and name. Adds an increasing suffix to original name until a unique name is found.

Parameters:

parent_id : int¶

ID of the parent entity.

name : str¶

Name of the entity.

Returns:

Returns free name.

Return type:

str

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# 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()

name = "IMG_0315.jpeg"
dataset_id = 55832
free_name = api.image.get_free_name(dataset_id, name)
print(free_name) # IMG_0315_001.jpeg

get_info_by_id(id)¶

Get information about an entity by its ID from the Supervisely server.

Parameters:

id : int¶

ID of the entity.

get_info_by_name(parent_id, name, fields=[])¶

Get information about an entity by its name from the Supervisely server.

Parameters:

parent_id : int¶

ID of the parent entity.

name : str¶

Name of the entity for which the information is being retrieved.

fields : List[str]¶

The list of api fields which will be returned with the response.

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# 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()

dataset_id = 55832
name = "IMG_0315.jpeg"
info = api.image.get_info_by_name(dataset_id, name)
print(info)
# Output: ImageInfo(id=19369643, name='IMG_0315.jpeg', ...)

get_list(parent_id, filters=None)¶

Get list of entities in parent entity with given parent ID.

Parameters:

parent_id : int¶

parent ID in Supervisely.

filters : List[Dict[str, str]], optional¶

List of parameters to sort output entities.

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# 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()

dataset_id = 55832
images = api.image.get_list(dataset_id)
print(images)
# Output: [
    ImageInfo(id=19369642, ...)
    ImageInfo(id=19369643, ...)
    ImageInfo(id=19369644, ...)
]

get_list_all_pages(method, data, progress_cb=None, convert_json_info_cb=None, limit=None, return_first_response=False)¶

Get list of all or limited quantity entities from the Supervisely server.

Parameters:

method : str¶

Request method name

data : dict¶

Dictionary with request body info

progress_cb : Progress, optional¶

Function for tracking download progress.

convert_json_info_cb : Callable, optional¶

Function for convert json info

limit : int, optional¶

Number of entity to retrieve

return_first_response : bool, optional¶

Specify if return first response

Returns:

List of entities.

Return type:

List[dict]

get_list_all_pages_generator(method, data, progress_cb=None, convert_json_info_cb=None, limit=None, return_first_response=False)¶

This generator function retrieves a list of all or a limited quantity of entities from the Supervisely server, yielding batches of entities as they are retrieved

Parameters:

method : str¶

Request method name

data : dict¶

Dictionary with request body info

progress_cb : Progress, optional¶

Function for tracking download progress.

convert_json_info_cb : Callable, optional¶

Function for convert json info

limit : int, optional¶

Number of entity to retrieve

return_first_response : bool, optional¶

Specify if return first response

async get_list_idx_page_async(method, data)¶

Get the list of items for a given page number. Page number is specified in the data dictionary.

Parameters:

method : str¶

Method to call for listing items.

data : dict¶

Data to pass to the API method.

Returns:

List of items.

Return type:

Tuple[int, List[NamedTuple]]

async get_list_page_generator_async(method, data, pages_count=None, semaphore=None)¶

Yields list of images in dataset asynchronously page by page.

Parameters:

method : str¶

Method to call for listing items.

data : dict¶

Data to pass to the API method.

pages_count : int, optional¶

Preferred number of pages to retrieve if used with a per_page limit. Will be automatically adjusted if the pagesCount differs from the requested number.

semaphore=None¶

Semaphore for limiting the number of simultaneous requests.

Returns:

List of images in dataset.

Return type:

AsyncGenerator[List[ImageInfo]]

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# 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()

method = 'images.list'
data = {'datasetId': 123456}

loop = sly.utils.get_or_create_event_loop()
images = loop.run_until_complete(api.image.get_list_generator_async(method, data))