daft.functions.image_height#

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

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

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

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