daft.functions.decode_image#

def decode_image(
    bytes: Expression,
    on_error: Literal["raise", "null"] = "raise",
    mode: str | ImageMode | None = ImageMode.RGB,
) -> Expression:
    """Decodes the binary data in this column into images.

    This can only be applied to binary columns that contain encoded images (e.g. PNG, JPEG, etc.)

    Args:
        bytes (Binary Expression): image to decode.
        on_error (str, default="raise"):
            Whether to raise when encountering an error, or log a warning and return a null
        mode (str | ImageMode | None, default=ImageMode.RGB):
            What mode to convert the images into before storing it in the column. By default, images are decoded as RGB. If this is set to None, the mode will be inferred from the underlying data.

    Returns:
        Expression (Image Expression): An expression representing the decoded image.
    """
    return Expression._call_builtin_scalar_fn("image_decode", bytes, on_error=on_error, mode=mode)