The following pages are generated from pythondoc markup in the source files.
- -Image plugin for the experimental Animated Raster Graphics format.
-For more information about this class, see The ArgImageFile Class.
-Font file plugin for the X11 BDF format.
-For more information about this class, see The BdfFontFile Class.
-Image plugin for the Windows BMP format.
-For more information about this class, see The BmpImageFile Class.
-A file object that provides read access to a part of an existing -file (for example a TAR file).
-For more information about this class, see The ContainerIO Class.
-Image plugin for Windows Cursor files.
-For more information about this class, see The CurImageFile Class.
-Image plugin for the Intel DCX format.
-For more information about this class, see The DcxImageFile Class.
-Image plugin for Encapsulated Postscript.
-For more information about this class, see The EpsImageFile Class.
-Image plugin for the FLI/FLC animation format.
-For more information about this class, see The FliImageFile Class.
-Image plugin for the FLI/FLC animation format. Use the seek -method to load individual frames. -
Base class for raster font file handlers.
-For more information about this class, see The FontFile Class.
-Image plugin for the FlashPix images.
-For more information about this class, see The FpxImageFile Class.
-Image plugin for the GIMP brush format.
-For more information about this class, see The GbrImageFile Class.
-Image plugin for the GD uncompressed format.
-For more information about this class, see The GdImageFile Class.
-Image plugin for the GD uncompressed format. Note that this format -is not supported by the standard Image.open function. To use -this plugin, you have to import the GdImageFile module and -use the GdImageFile.open function. -
Image plugin for GIF images.
-For more information about this class, see The GifImageFile Class.
-File handler for GIMP's gradient format.
-For more information about this class, see The GimpGradientFile Class.
-File handler for GIMP's palette format.
-For more information about this class, see The GimpPaletteFile Class.
-Image plugin for Mac OS icons.
-For more information about this class, see The IcnsImageFile Class.
-Image plugin for Windows Icon files.
-For more information about this class, see The IcoImageFile Class.
-Image plugin for the IFUNC IM file format.
-For more information about this class, see The ImImageFile Class.
-Creates a new image by interpolating between two input images, using -a constant alpha. - -
- out = image1 * (1.0 - alpha) + image2 * alpha -- -
(New in 1.1.4) Creates an image memory from pixel data in a string -or byte buffer. -
-This function is similar to fromstring, but uses data in -the byte buffer, where possible. This means that changes to the -original buffer object are reflected in this image). Not all modes -can share memory; support modes include "L", "RGBX", "RGBA", and -"CMYK". For other modes, this function behaves like a corresponding -call to the fromstring function. -
-Note that this function decodes pixel data only, not entire images. -If you have an entire image file in a string, wrap it in a -StringIO object, and use open to load it. - -
Creates an image memory from pixel data in a string. -
-In its simplest form, this function takes three arguments -(mode, size, and unpacked pixel data). -
-You can also use any pixel decoder supported by PIL. For more -information on available decoders, see the section Writing Your Own File Decoder. -
-Note that this function decodes pixel data only, not entire images. -If you have an entire image in a string, wrap it in a -StringIO object, and use open to load it. - -
Gets a list of individual band names. Given a mode, this function -returns a tuple containing the names of individual bands (use -getmodetype to get the mode used to store each individual -band. - -
This class represents an image object.
-For more information about this class, see The Image Class.
-Opens and identifies the given image file. -
-This is a lazy operation; this function identifies the file, but the -actual image data is not read from the file until you try to process -the data (or call the load method). - -
Returns a converted copy of this image. For the "P" mode, this -method translates pixels through the palette. If mode is -omitted, a mode is chosen so that all information in the image -and the palette can be represented without a palette. -
-The current version supports all possible conversions between -"L", "RGB" and "CMYK." -
-When translating a colour image to black and white (mode "L"), -the library uses the ITU-R 601-2 luma transform: -
-L = R * 299/1000 + G * 587/1000 + B * 114/1000 -
-When translating a greyscale image into a bilevel image (mode -"1"), all non-zero values are set to 255 (white). To use other -thresholds, use the point method. - -
Returns a rectangular region from this image. The box is a -4-tuple defining the left, upper, right, and lower pixel -coordinate. -
-This is a lazy operation. Changes to the source image may or -may not be reflected in the cropped image. To break the -connection, call the load method on the cropped -copy. - -
Configures the image file loader so it returns a version of the -image that as closely as possible matches the given mode and -size. For example, you can use this method to convert a colour -JPEG to greyscale while loading it, or to extract a 128x192 -version from a PCD file. -
-Note that this method modifies the Image object in place. If -the image has already been loaded, this method has no effect. - -
Filters this image using the given filter. For a list of -available filters, see the ImageFilter module. - -
Loads this image with pixel data from a string. -
-This method is similar to the fromstring function, but -loads data into this image instead of creating a new image -object. -
Returns a tuple containing the name of each band in this image. -For example, getbands on an RGB image returns ("R", "G", "B"). - -
Returns the contents of this image as a sequence object -containing pixel values. The sequence object is flattened, so -that values for line one follow directly after the values of -line zero, and so on. -
-Note that the sequence object returned by this method is an -internal PIL data type, which only supports certain sequence -operations. To convert it to an ordinary sequence (e.g. for -printing), use list(im.getdata()). - -
Returns a histogram for the image. The histogram is returned as -a list of pixel counts, one for each pixel value in the source -image. If the image has more than one band, the histograms for -all bands are concatenated (for example, the histogram for an -"RGB" image contains 768 values). -
-A bilevel image (mode "1") is treated as a greyscale ("L") image -by this method. -
-If a mask is provided, the method returns a histogram for those -parts of the image where the mask image is non-zero. The mask -image must have the same size as the image, and be either a -bi-level image (mode "1") or a greyscale image ("L"). - -
(Deprecated) Returns a copy of the image where the data has been -offset by the given distances. Data wraps around the edges. If -yoffset is omitted, it is assumed to be equal to xoffset. -
-This method is deprecated. New code should use the offset -function in the ImageChops module. - -
Pastes another image into this image. The box argument is either -a 2-tuple giving the upper left corner, a 4-tuple defining the -left, upper, right, and lower pixel coordinate, or None (same as -(0, 0)). If a 4-tuple is given, the size of the pasted image -must match the size of the region. -
-If the modes don't match, the pasted image is converted to the -mode of this image (see the convert method for -details). -
-Instead of an image, the source can be a integer or tuple -containing pixel values. The method then fills the region -with the given colour. When creating RGB images, you can -also use colour strings as supported by the ImageColor module. -
-If a mask is given, this method updates only the regions -indicated by the mask. You can use either "1", "L" or "RGBA" -images (in the latter case, the alpha band is used as mask). -Where the mask is 255, the given image is copied as is. Where -the mask is 0, the current value is preserved. Intermediate -values can be used for transparency effects. -
-Note that if you paste an "RGBA" image, the alpha band is -ignored. You can work around this by using the same image as -both source image and mask. - -
An optional 4-tuple giving the region to paste into. - If a 2-tuple is used instead, it's treated as the upper left - corner. If omitted or None, the source is pasted into the - upper left corner. -
- If an image is given as the second argument and there is no - third, the box defaults to (0, 0), and the second argument - is interpreted as a mask image. -
Copies pixel data to this image. This method copies data from a -sequence object into the image, starting at the upper left -corner (0, 0), and continuing until either the image or the -sequence ends. The scale and offset values are used to adjust -the sequence values: pixel = value*scale + offset. - -
Modifies the pixel at the given position. The colour is given as -a single numerical value for single-band images, and a tuple for -multi-band images. -
-Note that this method is relatively slow. For more extensive -changes, use paste or the ImageDraw module -instead. - -
Saves this image under the given filename. If no format is -specified, the format to use is determined from the filename -extension, if possible. -
-Keyword options can be used to provide additional instructions -to the writer. If a writer doesn't recognise an option, it is -silently ignored. The available options are described later in -this handbook. -
-You can use a file object instead of a filename. In this case, -you must always specify the format. The file object must -implement the seek, tell, and write -methods, and be opened in binary mode. - -
Seeks to the given frame in this sequence file. If you seek -beyond the end of the sequence, the method raises an -EOFError exception. When a sequence file is opened, the -library automatically seeks to frame 0. -
-Note that in the current version of the library, most sequence -formats only allows you to seek to the next frame. - -
Displays this image. This method is mainly intended for -debugging purposes. -
-On Unix platforms, this method saves the image to a temporary -PPM file, and calls the xv utility. -
-On Windows, it saves the image to a temporary BMP file, and uses -the standard BMP display utility to show it (usually Paint). - -
Make this image into a thumbnail. This method modifies the -image to contain a thumbnail version of itself, no larger than -the given size. This method calculates an appropriate thumbnail -size to preserve the aspect of the image, calls the draft method to configure the file reader (where -applicable), and finally resizes the image. -
-Note that the bilinear and bicubic filters in the current -version of PIL are not well-suited for thumbnail generation. -You should use ANTIALIAS unless speed is much more -important than quality. -
-Also note that this function modifies the Image object in place. -If you need to use the full resolution image as well, apply this -method to a copy of the original image. - -
Transforms this image. This method creates a new image with the -given size, and the same mode as the original, and copies data -to the new image using the given transform. -
-
The ImageChops module contains a number of arithmetical image -operations, called channel operations ("chops"). These can be -used for various purposes, including special effects, image -compositions, algorithmic painting, and more. -
-At this time, channel operations are only implemented for 8-bit -images (e.g. "L" and "RGB"). -
-Most channel operations take one or two image arguments and returns -a new image. Unless otherwise noted, the result of a channel -operation is always clipped to the range 0 to MAX (which is 255 for -all modes supported by the operations in this module). -
Add images -((image1 + image2) / scale + offset). -
-Adds two images, dividing the result by scale and adding the -offset. If omitted, scale defaults to 1.0, and offset to 0.0. - -
Add images without clipping -((image1 + image2) % MAX). -
-Adds two images, without clipping the result. - -
Blend images using constant transparency weight. -
-Same as the blend function in the Image module. -
Create composite using transparency mask. -
-Same as the composite function in the Image module. -
Compare images, and return darker pixel value -(min(image1, image2)). -
-Compares the two images, pixel by pixel, and returns a new image -containing the darker values. - -
Calculate absolute difference -(abs(image1 - image2)). -
-Returns the absolute value of the difference between the two images. - -
Compare images, and return lighter pixel value -(max(image1, image2)). -
-Compares the two images, pixel by pixel, and returns a new image -containing the lighter values. - -
Superimpose positive images -(image1 * image2 / MAX). -
-Superimposes two images on top of each other. If you multiply an -image with a solid black image, the result is black. If you multiply -with a solid white image, the image is unaffected. - -
Offset image data. -
-Returns a copy of the image where data has been offset by the given -distances. Data wraps around the edges. If yoffset is omitted, it -is assumed to be equal to xoffset. - -
Superimpose negative images -(MAX - ((MAX - image1) * (MAX - image2) / MAX)). -
-Superimposes two inverted images on top of each other. - -
Subtract images -((image1 - image2) / scale + offset). -
-Subtracts two images, dividing the result by scale and adding the -offset. If omitted, scale defaults to 1.0, and offset to 0.0. - -
Subtract images without clipping -((image1 - image2) % MAX). -
-Subtracts two images, without clipping the result. - -
A simple 2D drawing interface for PIL images.
-For more information about this class, see The ImageDraw Class.
-A simple 2D drawing interface for PIL images. -
-Application code should use the Draw factory, instead of -directly. -
Brightness enhancement object.
-For more information about this class, see The Brightness Class.
-Color enhancement object.
-For more information about this class, see The Color Class.
-Contrast enhancement object.
-For more information about this class, see The Contrast Class.
-Sharpness enhancement object.
-For more information about this class, see The Sharpness Class.
-Brightness enhancement object. -
-This class can be used to control the brighntess of an image. An -enhancement factor of 0.0 gives a black image, factor 1.0 gives the -original image. -
Color enhancement object. -
-This class can be used to adjust the colour balance of an image, in -a manner similar to the controls on a colour TV set. An enhancement -factor of 0.0 gives a black and white image, a factor of 1.0 gives -the original image. -
Contrast enhancement object. -
-This class can be used to control the contrast of an image, similar -to the contrast control on a TV set. An enhancement factor of 0.0 -gives an solid grey image, factor 1.0 gives the original image. -
Sharpness enhancement object. -
-This class can be used to adjust the sharpness of an image. The -enhancement factor 0.0 gives a blurred image, 1.0 gives the original -image, and a factor of 2.0 gives a sharpened image. -
(Internal) Support class for the Parser file.
-For more information about this class, see The _ParserFile Class.
-Base class for image file handlers.
-For more information about this class, see The ImageFile Class.
-Incremental image parser.
-For more information about this class, see The Parser Class.
-Base class for stub image loaders.
-For more information about this class, see The StubImageFile Class.
-(Internal) Support class for the Parser file. -
Base class for stub image loaders. -
-A stub loader is an image loader that can identify files of a -certain format, but relies on external code to load the file. -
The ImageFileIO module can be used to read an image from a -socket, or any other stream device.
-For more information about this class, see The ImageFileIO Class.
-The ImageFileIO module can be used to read an image from a -socket, or any other stream device. -
-This module is deprecated. New code should use the Parser -class in the ImageFile module instead. - -
Adds buffering to a stream file object, in order to -provide seek and tell methods required -by the Image.open method. The stream object must -implement read and close methods. - -
Blur filter.
-For more information about this class, see The BLUR Class.
-Contour filter.
-For more information about this class, see The CONTOUR Class.
-Detail filter.
-For more information about this class, see The DETAIL Class.
-Edge enhancement filter.
-For more information about this class, see The EDGE_ENHANCE Class.
-Stronger edge enhancement filter.
-For more information about this class, see The EDGE_ENHANCE_MORE Class.
-Embossing filter.
-For more information about this class, see The EMBOSS Class.
-Edge-finding filter.
-For more information about this class, see The FIND_EDGES Class.
-Convolution filter kernel.
-For more information about this class, see The Kernel Class.
-Max filter.
-For more information about this class, see The MaxFilter Class.
-Median filter.
-For more information about this class, see The MedianFilter Class.
-Min filter.
-For more information about this class, see The MinFilter Class.
-Mode filter.
-For more information about this class, see The ModeFilter Class.
-Rank filter.
-For more information about this class, see The RankFilter Class.
-Sharpening filter.
-For more information about this class, see The SHARPEN Class.
-Smoothing filter.
-For more information about this class, see The SMOOTH Class.
-Stronger smoothing filter.
-For more information about this class, see The SMOOTH_MORE Class.
-Create a convolution kernel. The current version only -supports 3x3 and 5x5 integer and floating point kernels. -
-In the current version, kernels can only be applied to -"L" and "RGB" images. - -
Wrapper for FreeType fonts.
-For more information about this class, see The FreeTypeFont Class.
-The ImageFont module defines a class with the same name.
-For more information about this class, see The ImageFont Class.
-Wrapper that creates a transposed font from any existing font -object.
-For more information about this class, see The TransposedFont Class.
-Load a TrueType or OpenType font file, and create a font object. -This function loads a font object from the given file, and creates -a font object for a font of the given size. -
-This function requires the _imagingft service. - -
Wrapper for FreeType fonts. Application code should use the -truetype factory function to create font objects. -
The ImageFont module defines a class with the same name. -Instances of this class store bitmap fonts, and are used with the -text method of the ImageDraw class. -
-PIL uses it's own font file format to store bitmap fonts. You can -use the pilfont utility to convert BDF and PCF font -descriptors (X window font formats) to this format. -
-Starting with version 1.1.4, PIL can be configured to support -TrueType and OpenType fonts. For earlier version, TrueType -support is only available as part of the imToolkit package - -
Texture factory.
-For more information about this class, see The TextureFactory Class.
-(New in 1.1.3) The ImageGrab module can be used to copy -the contents of the screen to a PIL image memory. -
-The current version works on Windows only.
- -(New in 1.1.3) The ImageOps module contains a number of -'ready-made' image processing operations. This module is somewhat -experimental, and most operators only work on L and RGB images. - -
Maximize (normalize) image contrast. This function calculates a -histogram of the input image, removes cutoff percent of the -lightest and darkest pixels from the histogram, and remaps the image -so that the darkest pixel becomes black (0), and the lightest -becomes white (255). - -
Colorize grayscale image. The black and white -arguments should be RGB tuples; this function calculates a colour -wedge mapping all black pixels in the source image to the first -colour, and all white pixels to the second colour. - -
Returns a sized and cropped version of the image, cropped to the -requested aspect ratio and size. -
-The fit function was contributed by Kevin Cazabon. - -
Colour palette wrapper for palette mapped images.
-For more information about this class, see The ImagePalette Class.
-Path wrapper.
-For more information about this class, see The Path Class.
-This class implements an iterator object that can be used to loop -over an image sequence.
-For more information about this class, see The Iterator Class.
-The ImageStat module calculates global statistics for an -image, or a region of an image. -
Calculate statistics for the given image.
-For more information about this class, see The Stat Class.
-The ImageTk module contains support to create and modify -Tkinter BitmapImage and PhotoImage objects. -
-For examples, see the demo programs in the Scripts -directory. -
Create a Tkinter-compatible bitmap image.
-For more information about this class, see The BitmapImage Class.
-Creates a Tkinter-compatible photo image.
-For more information about this class, see The PhotoImage Class.
-Create a Tkinter-compatible bitmap image. -
-The given image must have mode "1". Pixels having value 0 are -treated as transparent. Options, if any, are passed on to -Tkinter. The most commonly used option is foreground, -which is used to specify the colour for the non-transparent -parts. See the Tkinter documentation for information on how to -specify colours. - -
Create a photo image object. The constructor takes either -a PIL image, or a mode and a size. Alternatively, you can -use the file or data options to initialize -the photo image object. -
-
Define an affine image transform.
-For more information about this class, see The AffineTransform Class.
-Define a transform to extract a subregion from an image.
-For more information about this class, see The ExtentTransform Class.
-Define an mesh image transform.
-For more information about this class, see The MeshTransform Class.
-Define an quad image transform.
-For more information about this class, see The QuadTransform Class.
-Define an affine image transform. -
-This function takes a 6-tuple (a, b, c, d, e, f) which -contain the first two rows from an affine transform matrix. For -each pixel (x, y) in the output image, the new value is -taken from a position (a x + b y + c, -d x + e y + f) in the input image, rounded to -nearest pixel. -
-This function can be used to scale, translate, rotate, and shear the -original image. - -
Define a transform to extract a subregion from an image. -
-Maps a rectangle (defined by two corners) from the image to a -rectangle of the given size. The resulting image will contain -data sampled from between the corners, such that (x0, y0) -in the input image will end up at (0,0) in the output image, -and (x1, y1) at size. -
-This method can be used to crop, stretch, shrink, or mirror an -arbitrary rectangle in the current image. It is slightly slower than -crop, but about as fast as a corresponding resize -operation. - -
Define an quad image transform. -
-Maps a quadrilateral (a region defined by four corners) from the -image to a rectangle of the given size. - -
Create a Windows bitmap with the given mode and size.
-For more information about this class, see The Dib Class.
-The ImageWin module contains support to create and display -images under Windows 95/98, NT, 2000 and later.
-For more information about this class, see The HDC Class.
-Create an image window which displays the given image.
-For more information about this class, see The ImageWindow Class.
-Create a Window with the given title size.
-For more information about this class, see The Window Class.
-Create a Windows bitmap with the given mode and size. The mode can -be one of "1", "L", "P", or "RGB". - -If the display requires a palette, this constructor creates a -suitable palette and associates it with the image. For an "L" image, -128 greylevels are allocated. For an "RGB" image, a 6x6x6 colour -cube is used, together with 20 greylevels. - -To make sure that palettes work properly under Windows, you must -call the palette method upon certain events from Windows. -
Installs the palette associated with the image in the -given device context. -
-This method should be called upon QUERYNEWPALETTE -and PALETTECHANGED events from Windows. If this -method returns a non-zero value, one or more display -palette entries were changed, and the image should be -redrawn. - -
The ImageWin module contains support to create and display -images under Windows 95/98, NT, 2000 and later. -
Image plugin for IM Tools images.
-For more information about this class, see The ImtImageFile Class.
-Image plugin for IPTC/NAA datastreams.
-For more information about this class, see The IptcImageFile Class.
-Image plugin for IPTC/NAA datastreams. To read IPTC/NAA fields -from TIFF and JPEG files, use the getiptcinfo function. -
Image plugin for JPEG and JFIF images.
-For more information about this class, see The JpegImageFile Class.
-Image plugin for McIdas area images.
-For more information about this class, see The McIdasImageFile Class.
-Image plugin for Microsoft's Image Composer file format.
-For more information about this class, see The MicImageFile Class.
-Image plugin for MPEG streams.
-For more information about this class, see The MpegImageFile Class.
-Image plugin for Windows MSP images.
-For more information about this class, see The MspImageFile Class.
-This class encapsulates the interface to an OLE 2 structured -storage file.
-For more information about this class, see The OleFileIO Class.
-This class encapsulates the interface to an OLE 2 structured -storage file. Use the listdir and openstream -methods to access the contents of this file. -
Simple Postscript graphics interface.
-For more information about this class, see The PSDraw Class.
-File handler for Teragon-style palette files.
-For more information about this class, see The PaletteFile Class.
-Image plugin for PhotoCD images.
-For more information about this class, see The PcdImageFile Class.
-Font file plugin for the X11 PCF format.
-For more information about this class, see The PcfFontFile Class.
-Image plugin for Paintbrush images.
-For more information about this class, see The PcxImageFile Class.
-Image plugin for PIXAR raster images.
-For more information about this class, see The PixarImageFile Class.
-Image plugin for PNG images.
-For more information about this class, see The PngImageFile Class.
-Image plugin for PBM, PGM, and PPM images.
-For more information about this class, see The PpmImageFile Class.
-Image plugin for Photoshop images.
-For more information about this class, see The PsdImageFile Class.
-Image plugin for SGI images.
-For more information about this class, see The SgiImageFile Class.
-Image plugin for the Spider image format. This format is is used -by the SPIDER software, in processing image data from electron -microscopy and tomography.
-Image plugin for the SPIDER format.
-For more information about this class, see The SpiderImageFile Class.
-Image plugin for the SPIDER format.
-Image plugin for Sun raster files.
-For more information about this class, see The SunImageFile Class.
-A file object that provides read access to a given member of a TAR -file.
-For more information about this class, see The TarIO Class.
-Image plugin for Targa files.
-For more information about this class, see The TgaImageFile Class.
-Wrapper for TIFF IFDs.
-For more information about this class, see The ImageFileDirectory Class.
-Image plugin for TIFF files.
-For more information about this class, see The TiffImageFile Class.
-Load texture from a Quake2 WAL texture file. -
-By default, a Quake2 standard palette is attached to the texture. -To override the palette, use the putpalette method. - -
Image plugin for Windows metafiles.
-For more information about this class, see The WmfStubImageFile Class.
-Image plugin for XV thumbnail images.
-For more information about this class, see The XVThumbImageFile Class.
-Image plugin for X11 bitmaps.
-For more information about this class, see The XbmImageFile Class.
-Image plugin for X11 pixel maps.
-For more information about this class, see The XpmImageFile Class.
-