module pixeltable.functions.image

Pixeltable UDFs for ImageType. Example:

import pixeltable as pxt

t = pxt.get_table(...)
t.select(t.img_col.convert('L')).collect()

iterator tile_iterator()

Signature

tile_iterator(
    image: Any,
    tile_size: tuple[int, int],
    *,
    overlap: tuple[int, int] = (0, 0)
) 

Iterator over tiles of an image. Each image will be divided into tiles of size tile_size, and the tiles will be iterated over in row-major order (left-to-right, then top-to-bottom). An optional overlap parameter may be specified. If the tiles do not exactly cover the image, then the rightmost and bottommost tiles will be padded with blackspace, so that the output images all have the exact size tile_size. Parameters:

image (typing.Any): Image to split into tiles.
tile_size (tuple[int, int]): Size of each tile, as a pair of integers [width, height].
overlap (tuple[int, int], default: (0, 0)): Amount of overlap between adjacent tiles, as a pair of integers [width, height].

Examples: This example assumes an existing table tbl with a column img of type pxt.Image. Create a view that splits all images into 256x256 tiles with 32 pixels of overlap:

pxt.create_view(
    'image_tiles',
    tbl,
    iterator=image_tile_iterator(
        tbl.img, tile_size=(256, 256), overlap=(32, 32)
    ),
)

udf alpha_composite()

Signature

@pxt.udf
alpha_composite(im1: pxt.Image, im2: pxt.Image) -> pxt.Image

Alpha composite im2 over im1. Equivalent to PIL.Image.alpha_composite()

udf b64_encode()

Signature

@pxt.udf
b64_encode(
    img: pxt.Image,
    image_format: pxt.String = 'png'
) -> pxt.String

Convert image to a base64-encoded string. Parameters:

img (pxt.Image): image
image_format (pxt.String): image format supported by PIL

udf blend()

Signature

@pxt.udf
blend(
    im1: pxt.Image,
    im2: pxt.Image,
    alpha: pxt.Float
) -> pxt.Image

Return a new image by interpolating between two input images, using a constant alpha. Equivalent to PIL.Image.blend()

udf composite()

Signature

@pxt.udf
composite(
    image1: pxt.Image,
    image2: pxt.Image,
    mask: pxt.Image
) -> pxt.Image

Return a composite image by blending two images using a mask. Equivalent to PIL.Image.composite()

udf convert()

Signature

@pxt.udf
convert(self: pxt.Image, mode: pxt.String) -> pxt.Image

Convert the image to a different mode. Equivalent to PIL.Image.Image.convert(). Parameters:

mode (pxt.String): The mode to convert to. See the Pillow documentation for a list of supported modes.

udf crop()

Signature

@pxt.udf
crop(self: pxt.Image, box: pxt.Json) -> pxt.Image

Return a rectangular region from the image. The box is a 4-tuple defining the left, upper, right, and lower pixel coordinates. Equivalent to PIL.Image.Image.crop()

udf effect_spread()

Signature

@pxt.udf
effect_spread(self: pxt.Image, distance: pxt.Int) -> pxt.Image

Randomly spread pixels in an image. Equivalent to PIL.Image.Image.effect_spread() Parameters:

distance (pxt.Int): The distance to spread pixels.

udf entropy()

Signature

@pxt.udf
entropy(
    self: pxt.Image,
    mask: pxt.Image | None = None,
    extrema: pxt.Json | None = None
) -> pxt.Float

Returns the entropy of the image, optionally using a mask and extrema. Equivalent to PIL.Image.Image.entropy() Parameters:

mask (pxt.Image | None): An optional mask image.
extrema (pxt.Json | None): An optional list of extrema.

udf get_metadata()

Signature

@pxt.udf
get_metadata(self: pxt.Image) -> pxt.Json

Return metadata for the image.

udf getbands()

Signature

@pxt.udf
getbands(self: pxt.Image) -> pxt.Json

Return a tuple containing the names of the image bands. Equivalent to PIL.Image.Image.getbands()

udf getbbox()

Signature

@pxt.udf
getbbox(
    self: pxt.Image,
    *,
    alpha_only: pxt.Bool = True
) -> pxt.Json | None

Return a bounding box for the non-zero regions of the image. Equivalent to PIL.Image.Image.getbbox() Parameters:

alpha_only (pxt.Bool): If True, and the image has an alpha channel, trim transparent pixels. Otherwise, trim pixels when all channels are zero.

udf getchannel()

Signature

@pxt.udf
getchannel(self: pxt.Image, channel: pxt.Int) -> pxt.Image

Return an L-mode image containing a single channel of the original image. Equivalent to PIL.Image.Image.getchannel() Parameters:

channel (pxt.Int): The channel to extract. This is a 0-based index.

udf getcolors()

Signature

@pxt.udf
getcolors(self: pxt.Image, maxcolors: pxt.Int = 256) -> pxt.Json

Return a list of colors used in the image, up to a maximum of maxcolors. Equivalent to PIL.Image.Image.getcolors() Parameters:

maxcolors (pxt.Int): The maximum number of colors to return.

udf getextrema()

Signature

@pxt.udf
getextrema(self: pxt.Image) -> pxt.Json

Return a 2-tuple containing the minimum and maximum pixel values of the image. Equivalent to PIL.Image.Image.getextrema()

udf getpalette()

Signature

@pxt.udf
getpalette(
    self: pxt.Image,
    mode: pxt.String | None = None
) -> pxt.Json | None

Return the palette of the image, optionally converting it to a different mode. Equivalent to PIL.Image.Image.getpalette() Parameters:

mode (pxt.String | None): The mode to convert the palette to.

udf getpixel()

Signature

@pxt.udf
getpixel(self: pxt.Image, xy: pxt.Json) -> pxt.Json

Return the pixel value at the given position. The position xy is a tuple containing the x and y coordinates. Equivalent to PIL.Image.Image.getpixel() Parameters:

xy (pxt.Json): The coordinates, given as (x, y).

udf getprojection()

Signature

@pxt.udf
getprojection(self: pxt.Image) -> pxt.Json

Return two sequences representing the horizontal and vertical projection of the image. Equivalent to PIL.Image.Image.getprojection()

udf height()

Signature

@pxt.udf
height(self: pxt.Image) -> pxt.Int

Return the height of the image.

udf histogram()

Signature

@pxt.udf
histogram(
    self: pxt.Image,
    mask: pxt.Image | None = None,
    extrema: pxt.Json | None = None
) -> pxt.Json

Return a histogram for the image. Equivalent to PIL.Image.Image.histogram() Parameters:

mask (pxt.Image | None): An optional mask image.
extrema (pxt.Json | None): An optional list of extrema.

udf mode()

Signature

@pxt.udf
mode(self: pxt.Image) -> pxt.String

Return the image mode.

udf point()

Signature

@pxt.udf
point(
    self: pxt.Image,
    lut: pxt.Json,
    mode: pxt.String | None = None
) -> pxt.Image

Map image pixels through a lookup table. Equivalent to PIL.Image.Image.point() Parameters:

lut (pxt.Json): A lookup table.

udf quantize()

Signature

@pxt.udf
quantize(
    self: pxt.Image,
    colors: pxt.Int = 256,
    method: pxt.Int | None = None,
    kmeans: pxt.Int = 0,
    palette: pxt.Image | None = None,
    dither: pxt.Int = <Dither.FLOYDSTEINBERG: 3>
) -> pxt.Image

Convert the image to ‘P’ mode with the specified number of colors. Equivalent to PIL.Image.Image.quantize() Parameters:

colors (pxt.Int): The number of colors to quantize to.
method (pxt.Int | None): The quantization method. See the Pillow documentation for a list of supported methods.
kmeans (pxt.Int): The number of k-means clusters to use.
palette (pxt.Image | None): The palette to use.
dither (pxt.Int): The dithering method. See the Pillow documentation for a list of supported methods.

udf reduce()

Signature

@pxt.udf
reduce(
    self: pxt.Image,
    factor: pxt.Int,
    box: pxt.Json | None = None
) -> pxt.Image

Reduce the image by the given factor. Equivalent to PIL.Image.Image.reduce() Parameters:

factor (pxt.Int): The reduction factor.
box (pxt.Json | None): An optional 4-tuple of ints providing the source image region to be reduced. The values must be within (0, 0, width, height) rectangle. If omitted or None, the entire source is used.

udf resize()

Signature

@pxt.udf
resize(self: pxt.Image, size: pxt.Json) -> pxt.Image

Return a resized copy of the image. The size parameter is a tuple containing the width and height of the new image. Equivalent to PIL.Image.Image.resize()

udf rotate()

Signature

@pxt.udf
rotate(self: pxt.Image, angle: pxt.Int) -> pxt.Image

Return a copy of the image rotated by the given angle. Equivalent to PIL.Image.Image.rotate() Parameters:

angle (pxt.Int): The angle to rotate the image, in degrees. Positive angles are counter-clockwise.

udf thumbnail()

Signature

@pxt.udf
thumbnail(
    self: pxt.Image,
    size: pxt.Json,
    resample: pxt.Int = <Resampling.LANCZOS: 1>,
    reducing_gap: pxt.Float | None = 2.0
) -> pxt.Image

Create a thumbnail of the image. Equivalent to PIL.Image.Image.thumbnail() Parameters:

size (pxt.Json): The size of the thumbnail, as a tuple of (width, height).
resample (pxt.Int): The resampling filter to use. See the Pillow documentation for a list of supported filters.
reducing_gap (pxt.Float | None): The reducing gap to use.

udf transpose()

Signature

@pxt.udf
transpose(self: pxt.Image, method: pxt.Int) -> pxt.Image

Transpose the image. Equivalent to PIL.Image.Image.transpose() Parameters:

method (pxt.Int): The transpose method. See the Pillow documentation for a list of supported methods.

udf width()

Signature

@pxt.udf
width(self: pxt.Image) -> pxt.Int

Return the width of the image.

SDK Reference

​module pixeltable.functions.image

​iterator tile_iterator()

​udf alpha_composite()

​udf b64_encode()

​udf blend()

​udf composite()

​udf convert()

​udf crop()

​udf effect_spread()

​udf entropy()

​udf get_metadata()

​udf getbands()

​udf getbbox()

​udf getchannel()

​udf getcolors()

​udf getextrema()

​udf getpalette()

​udf getpixel()

​udf getprojection()

​udf height()

​udf histogram()

​udf mode()

​udf point()

​udf quantize()

​udf reduce()

​udf resize()

​udf rotate()

​udf thumbnail()

​udf transpose()

​udf width()

module pixeltable.functions.image

iterator tile_iterator()

udf alpha_composite()

udf b64_encode()

udf blend()

udf composite()

udf convert()

udf crop()

udf effect_spread()

udf entropy()

udf get_metadata()

udf getbands()

udf getbbox()

udf getchannel()

udf getcolors()

udf getextrema()

udf getpalette()

udf getpixel()

udf getprojection()

udf height()

udf histogram()

udf mode()

udf point()

udf quantize()

udf reduce()

udf resize()

udf rotate()

udf thumbnail()

udf transpose()

udf width()