module pixeltable.functions.image
Pixeltable UDFs for ImageType.
Example:
udf alpha_composite()
Alpha composite im2 over im1.
Equivalent to PIL.Image.alpha_composite()
udf b64_encode()
Convert image to a base64-encoded string.
Parameters:
udf blend()
Return a new image by interpolating between two input images, using a constant alpha.
Equivalent to PIL.Image.blend()
udf composite()
Return a composite image by blending two images using a mask.
Equivalent to PIL.Image.composite()
udf convert()
Convert the image to a different mode.
Equivalent to
PIL.Image.Image.convert().
Parameters:
udf crop()
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()
Randomly spread pixels in an image.
Equivalent to
PIL.Image.Image.effect_spread()
Parameters:
distance (Int): The distance to spread pixels.
udf entropy()
Returns the entropy of the image, optionally using a mask and extrema.
Equivalent to
PIL.Image.Image.entropy()
Parameters:
mask (Image | None): An optional mask image.
extrema (Json | None): An optional list of extrema.
Return metadata for the image.
udf getbands()
Return a tuple containing the names of the image bands.
Equivalent to
PIL.Image.Image.getbands()
udf getbbox()
Return a bounding box for the non-zero regions of the image.
Equivalent to PIL.Image.Image.getbbox()
Parameters:
alpha_only (Bool): If True, and the image has an alpha channel, trim transparent pixels. Otherwise,
trim pixels when all channels are zero.
udf getchannel()
Return an L-mode image containing a single channel of the original image.
Equivalent to
PIL.Image.Image.getchannel()
Parameters:
channel (Int): The channel to extract. This is a 0-based index.
udf getcolors()
Return a list of colors used in the image, up to a maximum of maxcolors.
Equivalent to
PIL.Image.Image.getcolors()
Parameters:
maxcolors (Int): The maximum number of colors to return.
udf getextrema()
Return a 2-tuple containing the minimum and maximum pixel values of the image.
Equivalent to
PIL.Image.Image.getextrema()
udf getpalette()
Return the palette of the image, optionally converting it to a different mode.
Equivalent to
PIL.Image.Image.getpalette()
Parameters:
mode (String | None): The mode to convert the palette to.
udf getpixel()
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 (Json): The coordinates, given as (x, y).
udf getprojection()
Return two sequences representing the horizontal and vertical projection of the image.
Equivalent to
PIL.Image.Image.getprojection()
udf height()
Return the height of the image.
udf histogram()
Return a histogram for the image.
Equivalent to
PIL.Image.Image.histogram()
Parameters:
mask (Image | None): An optional mask image.
extrema (Json | None): An optional list of extrema.
udf mode()
Return the image mode.
udf point()
Map image pixels through a lookup table.
Equivalent to
PIL.Image.Image.point()
Parameters:
lut (Json): A lookup table.
udf quantize()
Convert the image to ‘P’ mode with the specified number of colors.
Equivalent to
PIL.Image.Image.quantize()
Parameters:
colors (Int): The number of colors to quantize to.
method (Int | None): The quantization method. See the
Pillow documentation
for a list of supported methods.
kmeans (Int): The number of k-means clusters to use.
palette (Image | None): The palette to use.
dither (Int): The dithering method. See the
Pillow documentation
for a list of supported methods.
udf reduce()
Reduce the image by the given factor.
Equivalent to
PIL.Image.Image.reduce()
Parameters:
factor (Int): The reduction factor.
box (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()
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()
Return a copy of the image rotated by the given angle.
Equivalent to
PIL.Image.Image.rotate()
Parameters:
angle (Int): The angle to rotate the image, in degrees. Positive angles are counter-clockwise.
udf transpose()
Transpose the image.
Equivalent to
PIL.Image.Image.transpose()
Parameters:
udf width()
Return the width of the image.Last modified on January 15, 2026