ImageAnnotationToolApi¶

class ImageAnnotationToolApi[source]¶

Bases: supervisely.api.module_api.ModuleApiBase

Methods

`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
`info_sequence`	Get list of all class field names.
`info_tuple_name`	Get string name of NamedTuple.
`next_image`
`prev_image`
`set_figure`
`set_image`
`zoom_to_figure`

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.

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

static info_sequence()¶: Get list of all class field names.

static info_tuple_name()¶: Get string name of NamedTuple.

next_image(session_id, image_id)[source]¶

prev_image(session_id, image_id)[source]¶

set_figure(session_id, figure_id)[source]¶

set_image(session_id, image_id)[source]¶

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