Image
The Image class allows operations at a single image level.
Use Image to retrieve and handle information about an individual image (e.g. filename, size, resolution, etc)
class remo.Image¶
Remo image
documentation
class remo.Image(id: int = None, name: str = None, dataset_id: int = None, path: str = None, url: str = None, size: int = None, width: int = None, height: int = None, upload_date: str = None, \*\*kwargs)
-
Parameters
-
id – image id
-
name – image file name
-
dataset_id – dataset id
-
path – local path, if available
-
url – image remo internal URL
-
size – file size in bytes
-
width – image width in pixels
-
height – image height in pixels
-
upload_date – upload date
-
add_annotation¶
Adds new annotation to the image
documentation
add_annotation(annotation: Annotation, annotation_set_id: int = None)
-
Parameters
-
annotation_set_id – annotation set id
-
annotation – annotation data
-
fetch_details¶
Fetch the latest image details from the database and updating all fields
documentation
fetch_details()
get_annotation_set¶
documentation
get_annotation_set(annotation_set_id: int = None)
get_content¶
Retrieves image file content
documentation
get_content()
-
Returns
image binary data
list_annotation_sets¶
Lists annotations sets
documentation
list_annotation_sets()
-
Returns
List[
remo.AnnotationSet]
list_annotations¶
Retrieves image annotations from giving annotation set
documentation
list_annotations(annotation_set_id: int)
-
Parameters
annotation_set_id – annotation set id
-
Returns
List[
remo.Annotation]
save_to¶
Save image to giving directory
documentation
save_to(dir_path: str)
-
Parameters
dir_path – path to the directory
update_fields¶
Update all fields of the image based on the passed Image instamce
documentation
update_fields(img)
view¶
Opens browser on image view for the image
documentation
view()
view_annotate¶
Opens browser on the annotation tool for giving annotation set
documentation
view_annotate(annotation_set_id: int)
-
Parameters
annotation_set_id – annotation set id