PointcloudTagApi¶
- class PointcloudTagApi[source]¶
Bases:
supervisely.api.entity_annotation.tag_api.TagApi
PointcloudTag
for point clouds.PointcloudTagApi
object is immutable.Methods
Add tag to point cloud.
Add tags to entity in project with given ID.
Add Tags to Annotation Objects.
Add Tags to Annotation Objects.
Checks if an entity with the given parent_id and name exists
Generates a free name for an entity with the given parent_id and name.
Get information about an entity by its ID from the Supervisely server.
Get information about an entity by its name from the Supervisely server.
Get list of tags for a given project ID.
Get list of all or limited quantity entities from the Supervisely server.
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 dictionary with mapping tag name to tag ID for a given project ID.
NamedTuple TagInfo information about Tag.
Get string name of NamedTuple for class.
Remove tag from point cloud.
Update tag value for point cloud.
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.
- InfoType¶
alias of
supervisely.api.module_api.TagInfo
-
append_to_entity(entity_id, project_id, tags, key_id_map=
None
)¶ Add tags to entity in project with given ID.
- Parameters
- entity_id : int
ID of the entity in Supervisely to add a tag to
- project_id : int
Project ID in Supervisely.
- tags : KeyIndexedCollection
Collection of tags
- key_id_map : KeyIdMap, optional
KeyIdMap object.
- Returns
List of tags IDs
- Return type
- append_to_objects(entity_id, project_id, objects, key_id_map)¶
Add Tags to Annotation Objects.
- Parameters
- entity_id : int
ID of the entity in Supervisely to add a tag to
- project_id : int
Project ID in Supervisely.
- tags_json : KeyIndexedCollection
Collection of tags
- Returns
List of tags IDs
- Return type
- Usage example
import supervisely as sly os.environ['SERVER_ADDRESS'] = 'https://app.supervise.ly' os.environ['API_TOKEN'] = 'Your Supervisely API Token' api = sly.Api.from_env() pointcloud_id = 19373170 pcd_info = api.
- append_to_objects_json(entity_id, tags_json)¶
Add Tags to Annotation Objects.
- exists(parent_id, name)¶
Checks if an entity with the given parent_id and name exists
- Parameters
- Returns
Returns True if entity exists, and False if not
- Return type
- Usage example
import supervisely as sly # You can connect to API directly address = 'https://app.supervise.ly/' token = 'Your Supervisely API Token' api = sly.Api(address, token) # Or you can use API from environment os.environ['SERVER_ADDRESS'] = 'https://app.supervise.ly' os.environ['API_TOKEN'] = 'Your Supervisely API Token' 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
- Returns
Returns free name.
- Return type
- Usage example
import supervisely as sly # You can connect to API directly address = 'https://app.supervise.ly/' token = 'Your Supervisely API Token' api = sly.Api(address, token) # Or you can use API from environment os.environ['SERVER_ADDRESS'] = 'https://app.supervise.ly' os.environ['API_TOKEN'] = 'Your Supervisely API Token' 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)¶
Get information about an entity by its name from the Supervisely server.
- Parameters
- Usage example
import supervisely as sly # You can connect to API directly address = 'https://app.supervise.ly/' token = 'Your Supervisely API Token' api = sly.Api(address, token) # Or you can use API from environment os.environ['SERVER_ADDRESS'] = 'https://app.supervise.ly' os.environ['API_TOKEN'] = 'Your Supervisely API Token' 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(project_id, filters=
None
)¶ Get list of tags for a given project ID.
-
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
- get_name_to_id_map(project_id)¶
Get dictionary with mapping tag name to tag ID for a given project ID.
- static info_sequence()¶
NamedTuple TagInfo information about Tag.
- Usage example
import supervisely as sly os.environ['SERVER_ADDRESS'] = 'https://app.supervise.ly' os.environ['API_TOKEN'] = 'Your Supervisely API Token' api = sly.Api.from_env() info_sequence = api.video.tag.info_sequence()
- static info_tuple_name()¶
Get string name of NamedTuple for class.
- Returns
NamedTuple name.
- Return type
- Usage example
import supervisely as sly os.environ['SERVER_ADDRESS'] = 'https://app.supervise.ly' os.environ['API_TOKEN'] = 'Your Supervisely API Token' api = sly.Api.from_env() tuple_name = api.video.tag.info_tuple_name() print(tuple_name) # TagInfo
- update(tag_id, value)[source]¶
Update tag value for point cloud. You could use only those values, which are correspond to TagMeta
value_type
andpossible_values