ImageInfo¶

class ImageInfo[source]¶

Bases: tuple

Object with image parameters from Supervisely.

Example

ImageInfo(
    id=770915,
    name='IMG_3861.jpeg',
    link=None,
    hash='ZdpMD+ZMJx0R8BgsCzJcqM7qP4M8f1AEtoYc87xZmyQ=',
    mime='image/jpeg',
    ext='jpeg',
    size=148388,
    width=1067,
    height=800,
    labels_count=4,
    dataset_id=2532,
    created_at='2021-03-02T10:04:33.973Z',
    updated_at='2021-03-02T10:04:33.973Z',
    meta={},
    path_original='/h5un6l2bnaz1vj8a9qgms4-public/images/original/7/h/Vo/...jpg',
    full_storage_url='http://app.supervise.ly/h5un6l2bnaz1vj8a9qgms4-public/images/original/7/h/Vo/...jpg'),
    tags=[],
    created_by='admin'
)

Methods

`count`	Return number of occurrences of value.
`index`	Return first index of value.

Attributes

`created_at`	`str`: Image creation time.
`created_by`	`str`: Id of a user who created the image.
`dataset_id`	`int`: `Dataset` ID in Supervisely.
`ext`	`str`: Image file extension.
`full_storage_url`	`str`: Full storage URL to image.
`hash`	`str`: Image hash obtained by base64(sha256(file_content)).
`height`	`int`: Image height.
`id`	`int`: Image ID in Supervisely.
`labels_count`	`int`: Number of `Labels` in the Image.
`link`	`str`: Use link as ID for images that are expected to be stored at remote server.
`meta`	`dict`: Custom additional image info that contain image technical and/or user-generated data.
`mime`	`str`: Image MIME type.
`name`	`str`: Image filename.
`path_original`	`str`: Relative storage URL to image.
`preview_url`	Get Image preview URL.
`size`	`int`: Image size (in bytes).
`tags`	`str`: Image `Tags` list.
`updated_at`	`str`: Time of last image update.
`width`	`int`: Image width.

__add__(value, /)¶: Return self+value.

__mul__(value, /)¶: Return self*value.

count(value, /)¶: Return number of occurrences of value.

index(value, start=0, stop=9223372036854775807, /)¶

Return first index of value.

Raises ValueError if the value is not present.

created_at¶: str: Image creation time. e.g. “2019-02-22T14:59:53.381Z”.

created_by¶: str: Id of a user who created the image.

dataset_id¶: int: Dataset ID in Supervisely.

ext¶: str: Image file extension.

full_storage_url¶: str: Full storage URL to image. e.g. “http://app.supervise.ly/h5un6l2bnaz1vj8a9qgms4-public/images/original/7/h/Vo/…jpg”.

hash¶: str: Image hash obtained by base64(sha256(file_content)). Use hash for files that are expected to be stored at Supervisely or your deployed agent.

height¶: int: Image height.

id¶: int: Image ID in Supervisely.

labels_count¶: int: Number of Labels in the Image.

link¶: str: Use link as ID for images that are expected to be stored at remote server. e.g. “http://your-server/image1.jpg”.

meta¶: dict: Custom additional image info that contain image technical and/or user-generated data. To set custom sort parameter for image, you can do the follwoing: 1. With the uploading use add_custom_sort context manager to set the key name of meta object that will be used for custom sorting. 2. Before uploading add value to meta dict with method update_custom_sort 3. Before uploading add key-value pair with key customSort to meta dict, image info file or meta file. 4. After uploading set_custom_sort method to set custom sort value for image. e.g. {‘my-key’:’a’, ‘my-key: “b”, “customSort”: “c”}.

mime¶: str: Image MIME type.

name¶: str: Image filename.

path_original¶: str: Relative storage URL to image. e.g. “/h5un6l2bnaz1vj8a9qgms4-public/images/original/7/h/Vo/…jpg”.

property preview_url¶

Get Image preview URL.

Returns: Image preview URL.
Return type: str

size¶: int: Image size (in bytes).

tags¶: str: Image Tags list. e.g. “[{‘entityId’: 2836466, ‘tagId’: 345022, ‘id’: 2224609, ‘labelerLogin’: ‘admin’, ‘createdAt’: ‘2021-03-05T14:15:39.923Z’, ‘updatedAt’: ‘2021-03-05T14:15:39.923Z’}, {…}]”.

updated_at¶: str: Time of last image update. e.g. “2019-02-22T14:59:53.381Z”.

width¶: int: Image width.