daft.functions.image_mode#

def image_mode(image: Expression) -> Expression:
    """Gets the mode of an image.

    Args:
        image (Image Expression): image to retrieve the mode from.

    Returns:
        Expression (UInt32 Expression): An Expression representing the mode of the image.

    Example:
        >>> import daft
        >>> from daft.functions import image_mode
        >>> # Create a dataframe with an image column
        >>> df = ...  # doctest: +SKIP
        >>> df = df.with_column("mode", image_mode(df["images"]))  # doctest: +SKIP
    """
    return image_attribute(image, "mode")