Skip to content

util

visualize.util

add_opacity_to_color_tuple 

add_opacity_to_color_tuple(color: Optional[Tuple[int, int, int]] = None, opacity: float = 1.0) -> Optional[Tuple[int, int, int, int]]

Convert RGB color tuple to RGBA with specific opacity.

Parameters:

  • color (Tuple[int, int, int], default: None ) –

    Tuple of RGB color, each value has the range [0, 255]. Defaults to None.

  • opacity (float, default: 1.0 ) –

    Opacity value. Expected range is [0., 1.]. Defaults to 1..

Returns:

  • Optional[Tuple[int, int, int, int]] –

    Tuple[int, int, int, int]: Converted RGBA color tuple.

Note

Since the PIL can handle outliers, this function does not separately check for outliers for RGBA tuple.

It is correct not to consider the case where color is None, (if it is None, should not to call this function), but in this function, It is more efficient to assume that color is None rather than handling all exceptions for None in the Visualize implementation. (By keeping the color Tuple as None, PIL can handle it automatically.)

Source code in SaigeToolkit/visualize/util.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
def add_opacity_to_color_tuple(
    color: Optional[Tuple[int, int, int]] = None,
    opacity: float = 1.0,
) -> Optional[Tuple[int, int, int, int]]:
    """Convert RGB color tuple to RGBA with specific opacity.

    Args:
        color (Tuple[int, int, int], optional): Tuple of RGB color,
            each value has the range [0, 255]. Defaults to None.
        opacity (float, optional): Opacity value.
            Expected range is [0., 1.]. Defaults to 1..

    Returns:
        Tuple[int, int, int, int]: Converted RGBA color tuple.

    Note:
        Since the `PIL` can handle outliers,
        this function does not separately check for outliers for RGBA tuple.

        It is correct not to consider the case where `color` is None,
        (if it is `None`, should not to call this function),
        but in this function, It is more efficient to assume that `color` is `None`
        rather than handling all exceptions for `None` in the `Visualize` implementation.
        (By keeping the `color` Tuple as None, `PIL` can handle it automatically.)

    """
    if color is None:
        return None

    return (*color, int(opacity * 255))

blend_layers 

blend_layers(layers: List[Image]) -> Image

Blend multiple layers into one layer respect alpha channel.

Parameters:

  • layers (List[Image]) –

    Layers to blend. First element will place to bottom, and last one to top. If layer's mode is not 'RGBA', it will convert to 'RGBA' with opacity 1.0.

Returns:

  • Image –

    Image.Image: Blended image.

Source code in SaigeToolkit/visualize/util.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
def blend_layers(
    layers: List[Image.Image],
) -> Image.Image:
    """Blend multiple layers into one layer respect alpha channel.

    Args:
        layers (List[Image.Image]): Layers to blend.
            First element will place to bottom, and last one to top.
            If layer's mode is not 'RGBA', it will convert to 'RGBA' with opacity 1.0.

    Returns:
        Image.Image: Blended image.

    """
    base_layer = get_empty_layer(layers[0].size)

    for layer in layers:
        if layer.mode != "RGBA":
            layer = layer.convert("RGBA")
        base_layer.paste(Image.alpha_composite(base_layer, layer))

    return base_layer

get_empty_layer 

get_empty_layer(size: Tuple[int, int], color: Tuple[int, int, int] = (0, 0, 0), opacity: float = 0.0) -> Image

Create empty layer.

Parameters:

  • size (Tuple[int, int]) –

    (width, height) in pixels.

  • color (Tuple[int, int, int], default: (0, 0, 0) ) –

    Layer's base color (Background). Defaults to (0, 0, 0) (black).

  • opacity (float, default: 0.0 ) –

    Opacity value. Defaults to 0..

Returns:

  • Image –

    Image.Image: Empty layer.

Source code in SaigeToolkit/visualize/util.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
def get_empty_layer(
    size: Tuple[int, int],
    color: Tuple[int, int, int] = (0, 0, 0),
    opacity: float = 0.0,
) -> Image.Image:
    """Create empty layer.

    Args:
        size (Tuple[int, int]): (width, height) in pixels.
        color (Tuple[int, int, int], optional): Layer's base color (Background).
            Defaults to (0, 0, 0) (black).
        opacity (float, optional): Opacity value. Defaults to 0..

    Returns:
        Image.Image: Empty layer.

    """
    return Image.new(mode="RGBA", size=size, color=(*color, int(opacity * 255)))

concatenate_images 

concatenate_images(images: List[Image], mode: str = 'RGBA', orientation: str = 'horizontal') -> Image

Concatenates all images in a line.

Parameters:

  • images (List[Image]) –

    List of images to concatenate.

  • mode (str, default: 'RGBA' ) –

    Result image's mode. Defaults to "RGBA".

  • orientation (str, default: 'horizontal' ) –

    Determines the direction of concatenate. When orientation == "horizontal", all images must have the same height and when orientation == "vertical", all images must have the same width. Defaults to 'horizontal'.

Returns:

  • Image –

    Image.Image: Concatenated image.

Source code in SaigeToolkit/visualize/util.py 
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
def concatenate_images(
    images: List[Image.Image],
    mode: str = "RGBA",
    orientation: str = "horizontal",
) -> Image.Image:
    """Concatenates all images in a line.

    Args:
        images (List[Image.Image]): List of images to concatenate.
        mode (str, optional): Result image's mode. Defaults to "RGBA".
        orientation (str, optional): Determines the direction of concatenate.
            When `orientation == "horizontal"`, all images must have the same height
            and when `orientation == "vertical"`, all images must have the same width.
            Defaults to 'horizontal'.

    Returns:
        Image.Image: Concatenated image.

    """
    src = None
    for image in images:
        if src is None:
            src = image

        else:
            if orientation.lower() == "horizontal":
                dst = Image.new(mode, (src.width + image.width, max(src.height, image.height)))
                dst.paste(image, (src.width, 0))

            if orientation.lower() == "vertical":
                dst = Image.new(mode, (max(src.width, image.width), src.height + image.height))
                dst.paste(image, (0, src.height))

            dst.paste(src, (0, 0))
            src = dst

    return src

safety_visualize 

safety_visualize(original_fn: callable) -> callable

Decorator for stable visualization.

Temporarily convert the canvas image mode to RGBA for visualize operation. After visualize is completed, converted back to the original image mode and returned.

Source code in SaigeToolkit/visualize/util.py 
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
def safety_visualize(original_fn: callable) -> callable:
    """Decorator for stable visualization.

    Temporarily convert the canvas image mode to RGBA for visualize operation.
    After visualize is completed, converted back to the original image mode and returned."""

    def wrapper(canvas: Image.Image, *args, **kwargs):
        canvas_mode = canvas.mode

        if canvas_mode != "RGBA":
            canvas = canvas.convert("RGBA")

        return original_fn(canvas, *args, **kwargs).convert(canvas_mode)

    return wrapper