Skip to content

adalib.pictures

The images sub-package exposes the core integrations of the image database connected to AdaLab.

Functions

get_picture 

get_picture(picture_id, output_file_path)

Get a picture from the picture database.

Use the example Jupyter Notebook to test this function or build upon it.

Parameters:

Name Type Description Default
picture_id int

ID of the picture

 required
output_file_path str

path to save the picture

 required

Returns:

Type Description
None

None
Source code in adalib/pictures/pictures.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
def get_picture(picture_id: int, output_file_path: str) -> None:
    """
    Get a picture from the picture database.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/user/pictures/get_picture.ipynb) to test this function or build upon it.

    :param picture_id: ID of the picture
    :type picture_id: int
    :param output_file_path: path to save the picture
    :type output_file_path: str
    :return: None
    :rtype: None
    """

    response = adaboard.request_adaboard(
        path=f"image/{picture_id}",
        method=requests.get,
    )

    content_type = response.headers.get("Content-Type")
    # Ensure that the content type matches the extension of the output file
    if content_type in ["image/jpeg", "image/jpg"]:
        ext = ".jpg"
    elif content_type == "image/png":
        ext = ".png"
    elif content_type == "image/svg+xml":
        ext = ".svg"
    else:
        raise ValueError(
            f"Unsupported content type '{content_type}' for picture with ID {picture_id}."
        )

    with open(output_file_path + ext, "wb") as f:
        f.write(response.content)

    return None

post_picture 

post_picture(input_file_path)

Post an picture to the picture database.

Use the example Jupyter Notebook to test this function or build upon it.

Parameters:

Name Type Description Default
input_file_path str

path to the picture file

 required

Returns:

Type Description
int

ID of the posted picture
Source code in adalib/pictures/pictures.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
def post_picture(input_file_path: str) -> int:
    """
    Post an picture to the picture database.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/user/pictures/post_picture.ipynb) to test this function or build upon it.

    :param input_file_path: path to the picture file
    :type input_file_path: str
    :return: ID of the posted picture
    :rtype: int
    """

    filename = input_file_path.split("/")[-1]
    content_type = infer_type_from_extension(filename)
    with open(input_file_path, "rb") as image_file:
        files = {"image_file": (filename, image_file, content_type)}

        response = adaboard.request_adaboard(
            path="image",
            method=requests.post,
            omit_content_type=True,
            files=files,
        ).json()

    return response["id"]

post_picture_url 

post_picture_url(picture_url)

Post a picture to the picture database using a URL.

Use the example Jupyter Notebook to test this function or build upon it.

Parameters:

Name Type Description Default
picture_url str

URL of the picture to be uploaded

 required

Returns:

Type Description
int

ID of the posted picture
Source code in adalib/pictures/pictures.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
def post_picture_url(picture_url: str) -> int:
    """
    Post a picture to the picture database using a URL.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/user/picutres/post_picture_url.ipynb) to test this function or build upon it.

    :param picture_url: URL of the picture to be uploaded
    :type picture_url: str
    :return: ID of the posted picture
    :rtype: int
    """

    # Prepare the payload for the POST request
    payload = {"image_url": picture_url}

    # Send the request to the FastAPI endpoint
    response = adaboard.request_adaboard(
        path="image_url",  # The endpoint defined in your FastAPI application
        method=requests.post,
        json=payload,  # Use json parameter to send the payload as JSON
    ).json()

    # Return the ID of the newly created image
    return response["id"]