daft.functions.image_width#

def image_width(image: Expression) -> Expression:
    """Gets the width of an image in pixels.

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

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

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