ImageAnnotationToolApi¶

class ImageAnnotationToolApi[source]¶

Bases: supervisely.api.module_api.ModuleApiBase

Methods

convert_info_to_json	_convert_info_to_json
get_info_by_id	Get information about an entity by its ID from the Supervisely server.
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.
next_image	Changes the current image in the annotation tool to the next image.
prev_image	Changes the current image in the annotation tool to the previous image.
set_figure	Sets the figure as the current figure (selected figure) in the annotation tool.
set_image	Sets the image as the current image in the annotation tool.
show_notification	Shows a notification in the annotation tool.
zoom_to_figure	Zooms the scene to the figure with the given id and zoom factor.

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_info_to_json

Return type

Dict

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_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

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 : asyncio.Semaphore, optional

Semaphore for limiting the number of simultaneous requests.

kwargs

Additional arguments.

Returns

List of images in dataset.

Return type

AsyncGenerator[List[ImageInfo]]

Usage example

import supervisely as sly
import asyncio

os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com'
os.environ['API_TOKEN'] = 'Your Supervisely API Token'
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))

static info_sequence()¶

Get list of all class field names.

static info_tuple_name()¶

Get string name of NamedTuple.

next_image(session_id, *args, **kwargs)[source]¶

Changes the current image in the annotation tool to the next image.

Parameters

session_id : str

Annotation tool session id.

prev_image(session_id, *args, **kwargs)[source]¶

Changes the current image in the annotation tool to the previous image.

Parameters

session_id : str

Annotation tool session id.

set_figure(session_id, figure_id)[source]¶

Sets the figure as the current figure (selected figure) in the annotation tool.

Parameters

session_id : str

Annotation tool session id.

figure_id : int

Figure id.

set_image(session_id, image_id)[source]¶

Sets the image as the current image in the annotation tool. NOTE: The image must be in the same dataset as the current image.

Parameters

session_id : str

Annotation tool session id.

image_id : int

Image id in the same dataset as the current image.

show_notification(session_id, message, notification_type, duration=None)[source]¶

Shows a notification in the annotation tool.

Parameters

session_id : str

Annotation tool session id.

message : str

Notification message.

notification_type : Literal["success", "warning", "error"]

Notification type. One of “success”, “warning”, “error”.

duration : int, optional

Notification duration in milliseconds. Default is None.

Raises

ValueError – If notification_type is invalid.

zoom_to_figure(session_id, figure_id, zoom_factor=1)[source]¶

Zooms the scene to the figure with the given id and zoom factor.

Parameters

session_id : str

Annotation tool session id.

figure_id : int

Figure id.

zoom_factor : float, optional

Zoom factor. Default is 1.