daft.functions.convert_image#

def convert_image(image: Expression, mode: str | ImageMode) -> Expression:
    """Convert an image expression to the specified mode.

    Args:
        image (Image Expression): image to convert.
        mode (str | ImageMode): The mode to convert the image into.

    Returns:
        Expression (Image Expression): An expression representing the converted image.

    """
    if isinstance(mode, str):
        mode = ImageMode.from_mode_string(mode.upper())
    if not isinstance(mode, ImageMode):
        raise ValueError(f"mode must be a string or ImageMode variant, but got: {mode}")
    return Expression._call_builtin_scalar_fn("to_mode", image, mode=mode)