PIL Package¶
PIL
Package¶
ArgImagePlugin
Module¶
-
class
PIL.ArgImagePlugin.
ArgImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
-
format
= 'ARG'¶
-
format_description
= 'Animated raster graphics'¶
-
-
class
PIL.ArgImagePlugin.
ArgStream
(fp)[source]¶ Bases:
PIL.PngImagePlugin.ChunkStream
Parser callbacks for ARG data
BdfFontFile
Module¶
-
class
PIL.BdfFontFile.
BdfFontFile
(fp)[source]¶ Bases:
PIL.FontFile.FontFile
BmpImagePlugin
Module¶
-
class
PIL.BmpImagePlugin.
BmpImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
-
format
= 'BMP'¶
-
format_description
= 'Windows Bitmap'¶
-
-
class
PIL.BmpImagePlugin.
DibImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.BmpImagePlugin.BmpImageFile
-
format
= 'DIB'¶
-
format_description
= 'Windows Bitmap'¶
-
BufrStubImagePlugin
Module¶
-
class
PIL.BufrStubImagePlugin.
BufrStubImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.StubImageFile
-
format
= 'BUFR'¶
-
format_description
= 'BUFR'¶
-
ContainerIO
Module¶
CurImagePlugin
Module¶
-
class
PIL.CurImagePlugin.
CurImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.BmpImagePlugin.BmpImageFile
-
format
= 'CUR'¶
-
format_description
= 'Windows Cursor'¶
-
DcxImagePlugin
Module¶
EpsImagePlugin
Module¶
-
class
PIL.EpsImagePlugin.
EpsImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
EPS File Parser for the Python Imaging Library
-
format
= 'EPS'¶
-
format_description
= 'Encapsulated Postscript'¶
-
ExifTags
Module¶
FitsStubImagePlugin
Module¶
-
class
PIL.FitsStubImagePlugin.
FITSStubImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.StubImageFile
-
format
= 'FITS'¶
-
format_description
= 'FITS'¶
-
FliImagePlugin
Module¶
FontFile
Module¶
FpxImagePlugin
Module¶
GbrImagePlugin
Module¶
GdImageFile
Module¶
-
class
PIL.GdImageFile.
GdImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
-
format
= 'GD'¶
-
format_description
= 'GD uncompressed images'¶
-
GifImagePlugin
Module¶
-
class
PIL.GifImagePlugin.
GifImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
-
format
= 'GIF'¶
-
format_description
= 'Compuserve GIF'¶
-
global_palette
= None¶
-
GimpPaletteFile
Module¶
GribStubImagePlugin
Module¶
-
class
PIL.GribStubImagePlugin.
GribStubImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.StubImageFile
-
format
= 'GRIB'¶
-
format_description
= 'GRIB'¶
-
Hdf5StubImagePlugin
Module¶
-
class
PIL.Hdf5StubImagePlugin.
HDF5StubImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.StubImageFile
-
format
= 'HDF5'¶
-
format_description
= 'HDF5'¶
-
IcnsImagePlugin
Module¶
-
class
PIL.IcnsImagePlugin.
IcnsFile
(fobj)[source]¶ -
SIZES
= {(16, 16): [('is32', <function read_32>), ('s8mk', <function read_mk>)], (48, 48): [('ih32', <function read_32>), ('h8mk', <function read_mk>)], (128, 128): [('it32', <function read_32t>), ('t8mk', <function read_mk>)], (32, 32): [('il32', <function read_32>), ('l8mk', <function read_mk>)]}¶
-
-
class
PIL.IcnsImagePlugin.
IcnsImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
PIL read-only image support for Mac OS .icns files. Chooses the best resolution, but will possibly load a different size image if you mutate the size attribute before calling ‘load’.
The info dictionary has a key ‘sizes’ that is a list of sizes that the icns file has.
-
format
= 'ICNS'¶
-
format_description
= 'Mac OS icns resource'¶
-
IcoImagePlugin
Module¶
-
class
PIL.IcoImagePlugin.
IcoImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.BmpImagePlugin.BmpImageFile
-
format
= 'ICO'¶
-
format_description
= 'Windows Icon'¶
-
ImImagePlugin
Module¶
-
class
PIL.ImImagePlugin.
ImImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
-
format
= 'IM'¶
-
format_description
= 'IFUNC Image Memory'¶
-
Image
Module¶
-
class
PIL.Image.
Image
[source]¶ -
convert
(mode=None, data=None, dither=None, palette=0, colors=256)[source]¶ Convert to other pixel format
-
format
= None¶
-
format_description
= None¶
-
offset
(xoffset, yoffset=None)[source]¶ (deprecated) Offset image in horizontal and/or vertical direction
-
-
PIL.Image.
composite
(image1, image2, mask)[source]¶ Create composite image by blending images using a transparency mask
-
PIL.Image.
frombuffer
(mode, size, data, decoder_name='raw', *args)[source]¶ Load image from bytes or buffer
ImageChops
Module¶
-
PIL.ImageChops.
blend
(image1, image2, alpha)[source]¶ Blend two images using a constant transparency weight
-
PIL.ImageChops.
composite
(image1, image2, mask)[source]¶ Create composite image by blending images using a transparency mask
ImageCms
Module¶
ImageColor
Module¶
ImageDraw2
Module¶
ImageEnhance
Module¶
-
class
PIL.ImageEnhance.
Brightness
(image)[source]¶ Bases:
PIL.ImageEnhance._Enhance
Adjust image brightness
-
class
PIL.ImageEnhance.
Color
(image)[source]¶ Bases:
PIL.ImageEnhance._Enhance
Adjust image colour balance
ImageFile
Module¶
-
class
PIL.ImageFile.
ImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.Image.Image
Base class for image file format handlers.
-
class
PIL.ImageFile.
Parser
[source]¶ -
-
data
= None¶
-
decoder
= None¶
-
finished
= 0¶
-
image
= None¶
-
incremental
= None¶
-
-
class
PIL.ImageFile.
StubImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
Base class for stub image loaders.
ImageFilter
Module¶
-
class
PIL.ImageFilter.
BLUR
[source]¶ Bases:
PIL.ImageFilter.BuiltinFilter
-
filterargs
= ((5, 5), 16, 0, (1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 1, 0, 0, 0, 1, 1, 0, 0, 0, 1, 1, 1, 1, 1, 1))¶
-
name
= 'Blur'¶
-
-
class
PIL.ImageFilter.
BuiltinFilter
[source]¶ Bases:
PIL.ImageFilter.Kernel
-
class
PIL.ImageFilter.
CONTOUR
[source]¶ Bases:
PIL.ImageFilter.BuiltinFilter
-
filterargs
= ((3, 3), 1, 255, (-1, -1, -1, -1, 8, -1, -1, -1, -1))¶
-
name
= 'Contour'¶
-
-
class
PIL.ImageFilter.
DETAIL
[source]¶ Bases:
PIL.ImageFilter.BuiltinFilter
-
filterargs
= ((3, 3), 6, 0, (0, -1, 0, -1, 10, -1, 0, -1, 0))¶
-
name
= 'Detail'¶
-
-
class
PIL.ImageFilter.
EDGE_ENHANCE
[source]¶ Bases:
PIL.ImageFilter.BuiltinFilter
-
filterargs
= ((3, 3), 2, 0, (-1, -1, -1, -1, 10, -1, -1, -1, -1))¶
-
name
= 'Edge-enhance'¶
-
-
class
PIL.ImageFilter.
EDGE_ENHANCE_MORE
[source]¶ Bases:
PIL.ImageFilter.BuiltinFilter
-
filterargs
= ((3, 3), 1, 0, (-1, -1, -1, -1, 9, -1, -1, -1, -1))¶
-
name
= 'Edge-enhance More'¶
-
-
class
PIL.ImageFilter.
EMBOSS
[source]¶ Bases:
PIL.ImageFilter.BuiltinFilter
-
filterargs
= ((3, 3), 1, 128, (-1, 0, 0, 0, 1, 0, 0, 0, 0))¶
-
name
= 'Emboss'¶
-
-
class
PIL.ImageFilter.
FIND_EDGES
[source]¶ Bases:
PIL.ImageFilter.BuiltinFilter
-
filterargs
= ((3, 3), 1, 0, (-1, -1, -1, -1, 8, -1, -1, -1, -1))¶
-
name
= 'Find Edges'¶
-
-
class
PIL.ImageFilter.
GaussianBlur
(radius=2)[source]¶ Bases:
PIL.ImageFilter.Filter
-
name
= 'GaussianBlur'¶
-
-
class
PIL.ImageFilter.
Kernel
(size, kernel, scale=None, offset=0)[source]¶ Bases:
PIL.ImageFilter.Filter
-
class
PIL.ImageFilter.
MaxFilter
(size=3)[source]¶ Bases:
PIL.ImageFilter.RankFilter
-
name
= 'Max'¶
-
-
class
PIL.ImageFilter.
MedianFilter
(size=3)[source]¶ Bases:
PIL.ImageFilter.RankFilter
-
name
= 'Median'¶
-
-
class
PIL.ImageFilter.
MinFilter
(size=3)[source]¶ Bases:
PIL.ImageFilter.RankFilter
-
name
= 'Min'¶
-
-
class
PIL.ImageFilter.
ModeFilter
(size=3)[source]¶ Bases:
PIL.ImageFilter.Filter
-
name
= 'Mode'¶
-
-
class
PIL.ImageFilter.
RankFilter
(size, rank)[source]¶ Bases:
PIL.ImageFilter.Filter
-
name
= 'Rank'¶
-
-
class
PIL.ImageFilter.
SHARPEN
[source]¶ Bases:
PIL.ImageFilter.BuiltinFilter
-
filterargs
= ((3, 3), 16, 0, (-2, -2, -2, -2, 32, -2, -2, -2, -2))¶
-
name
= 'Sharpen'¶
-
-
class
PIL.ImageFilter.
SMOOTH
[source]¶ Bases:
PIL.ImageFilter.BuiltinFilter
-
filterargs
= ((3, 3), 13, 0, (1, 1, 1, 1, 5, 1, 1, 1, 1))¶
-
name
= 'Smooth'¶
-
-
class
PIL.ImageFilter.
SMOOTH_MORE
[source]¶ Bases:
PIL.ImageFilter.BuiltinFilter
-
filterargs
= ((5, 5), 100, 0, (1, 1, 1, 1, 1, 1, 5, 5, 5, 1, 1, 5, 44, 5, 1, 1, 5, 5, 5, 1, 1, 1, 1, 1, 1))¶
-
name
= 'Smooth More'¶
-
ImageFont
Module¶
ImageMath
Module¶
ImageMode
Module¶
ImageOps
Module¶
-
PIL.ImageOps.
autocontrast
(image, cutoff=0, ignore=None)[source]¶ Maximize image contrast, based on histogram
-
PIL.ImageOps.
fit
(image, size, method=0, bleed=0.0, centering=(0.5, 0.5))[source]¶ This method returns a sized and cropped version of the image, cropped to the aspect ratio and size that you request.
-
PIL.ImageOps.
gblur
(im[, radius])¶
-
PIL.ImageOps.
unsharp_mask
(im, radius=None, percent=None, threshold=None)[source]¶ PIL_usm.usm(im, [radius, percent, threshold])
-
PIL.ImageOps.
usm
(im[, radius, percent, threshold])¶
ImagePalette
Module¶
ImagePath
Module¶
ImageQt
Module¶
ImageShow
Module¶
-
class
PIL.ImageShow.
DisplayViewer
[source]¶ Bases:
PIL.ImageShow.UnixViewer
-
class
PIL.ImageShow.
UnixViewer
[source]¶ Bases:
PIL.ImageShow.Viewer
-
class
PIL.ImageShow.
XVViewer
[source]¶ Bases:
PIL.ImageShow.UnixViewer
ImageStat
Module¶
ImageTransform
Module¶
-
class
PIL.ImageTransform.
AffineTransform
(data)[source]¶ Bases:
PIL.ImageTransform.Transform
-
method
= 0¶
-
-
class
PIL.ImageTransform.
ExtentTransform
(data)[source]¶ Bases:
PIL.ImageTransform.Transform
-
method
= 1¶
-
-
class
PIL.ImageTransform.
MeshTransform
(data)[source]¶ Bases:
PIL.ImageTransform.Transform
-
method
= 4¶
-
-
class
PIL.ImageTransform.
QuadTransform
(data)[source]¶ Bases:
PIL.ImageTransform.Transform
-
method
= 3¶
-
ImageWin
Module¶
-
class
PIL.ImageWin.
ImageWindow
(image, title='PIL')[source]¶ Bases:
PIL.ImageWin.Window
ImtImagePlugin
Module¶
-
class
PIL.ImtImagePlugin.
ImtImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
-
format
= 'IMT'¶
-
format_description
= 'IM Tools'¶
-
IptcImagePlugin
Module¶
-
class
PIL.IptcImagePlugin.
IptcImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
-
format
= 'IPTC'¶
-
format_description
= 'IPTC/NAA'¶
-
JpegImagePlugin
Module¶
-
class
PIL.JpegImagePlugin.
JpegImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
-
format
= 'JPEG'¶
-
format_description
= 'JPEG (ISO 10918)'¶
-
JpegPresets
Module¶
JPEG quality settings equivalent to the Photoshop settings.
More presets can be added to the presets dict if needed.
Can be use when saving JPEG file.
To apply the preset, specify:
quality="preset_name"
To apply only the quantization table:
qtables="preset_name"
To apply only the subsampling setting:
subsampling="preset_name"
Example:
im.save("image_name.jpg", quality="web_high")
Subsampling¶
Subsampling is the practice of encoding images by implementing less resolution for chroma information than for luma information. (ref.: http://en.wikipedia.org/wiki/Chroma_subsampling)
Possible subsampling values are 0, 1 and 2 that correspond to 4:4:4, 4:2:2 and 4:1:1 (or 4:2:0?).
You can get the subsampling of a JPEG with the JpegImagePlugin.get_subsampling(im) function.
Quantization tables¶
They are values use by the DCT (Discrete cosine transform) to remove unnecessary information from the image (the lossy part of the compression). (ref.: http://en.wikipedia.org/wiki/Quantization_matrix#Quantization_matrices, http://en.wikipedia.org/wiki/JPEG#Quantization)
You can get the quantization tables of a JPEG with:
im.quantization
This will return a dict with a number of arrays. You can pass this dict directly as the qtables argument when saving a JPEG.
The tables format between im.quantization and quantization in presets differ in 3 ways:
- The base container of the preset is a list with sublists instead of dict. dict[0] -> list[0], dict[1] -> list[1], …
- Each table in a preset is a list instead of an array.
- The zigzag order is remove in the preset (needed by libjpeg >= 6a).
You can convert the dict format to the preset format with the JpegImagePlugin.convert_dict_qtables(dict_qtables) function.
Libjpeg ref.: http://www.jpegcameras.com/libjpeg/libjpeg-3.html
McIdasImagePlugin
Module¶
-
class
PIL.McIdasImagePlugin.
McIdasImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
-
format
= 'MCIDAS'¶
-
format_description
= 'McIdas area file'¶
-
MicImagePlugin
Module¶
MpegImagePlugin
Module¶
-
class
PIL.MpegImagePlugin.
MpegImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
-
format
= 'MPEG'¶
-
format_description
= 'MPEG'¶
-
MspImagePlugin
Module¶
-
class
PIL.MspImagePlugin.
MspImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
-
format
= 'MSP'¶
-
format_description
= 'Windows Paint'¶
-
OleFileIO
Module¶
-
class
PIL.OleFileIO.
OleFileIO
(filename=None)[source]¶ OLE container object
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.
Object names are given as a list of strings, one for each subentry level. The root entry should be omitted. For example, the following code extracts all image streams from a Microsoft Image Composer file:
ole = OleFileIO("fan.mic") for entry in ole.listdir(): if entry[1:2] == "Image": fin = ole.openstream(entry) fout = open(entry[0:1], "wb") while 1: s = fin.read(8192) if not s: break fout.write(s)
You can use the viewer application provided with the Python Imaging Library to view the resulting files (which happens to be standard TIFF files).
PaletteFile
Module¶
PalmImagePlugin
Module¶
PcdImagePlugin
Module¶
PcfFontFile
Module¶
-
class
PIL.PcfFontFile.
PcfFontFile
(fp)[source]¶ Bases:
PIL.FontFile.FontFile
-
name
= 'name'¶
-
PcxImagePlugin
Module¶
-
class
PIL.PcxImagePlugin.
PcxImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
-
format
= 'PCX'¶
-
format_description
= 'Paintbrush'¶
-
PdfImagePlugin
Module¶
PixarImagePlugin
Module¶
-
class
PIL.PixarImagePlugin.
PixarImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
-
format
= 'PIXAR'¶
-
format_description
= 'PIXAR raster image'¶
-
PngImagePlugin
Module¶
-
class
PIL.PngImagePlugin.
PngImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
-
format
= 'PNG'¶
-
format_description
= 'Portable network graphics'¶
-
-
PIL.PngImagePlugin.
getchunks
(im, **params)[source]¶ Return a list of PNG chunks representing this image.
-
PIL.PngImagePlugin.
is_cid
()¶ match(string[, pos[, endpos]]) –> match object or None. Matches zero or more characters at the beginning of the string
PpmImagePlugin
Module¶
-
class
PIL.PpmImagePlugin.
PpmImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
-
format
= 'PPM'¶
-
format_description
= 'Pbmplus image'¶
-
PsdImagePlugin
Module¶
SgiImagePlugin
Module¶
-
class
PIL.SgiImagePlugin.
SgiImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
-
format
= 'SGI'¶
-
format_description
= 'SGI Image File Format'¶
-
SpiderImagePlugin
Module¶
-
class
PIL.SpiderImagePlugin.
SpiderImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
-
format
= 'SPIDER'¶
-
format_description
= 'Spider 2D image'¶
-
SunImagePlugin
Module¶
-
class
PIL.SunImagePlugin.
SunImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
-
format
= 'SUN'¶
-
format_description
= 'Sun Raster File'¶
-
TarIO
Module¶
-
class
PIL.TarIO.
TarIO
(tarfile, file)[source]¶ Bases:
PIL.ContainerIO.ContainerIO
TgaImagePlugin
Module¶
-
class
PIL.TgaImagePlugin.
TgaImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
-
format
= 'TGA'¶
-
format_description
= 'Targa'¶
-
TiffImagePlugin
Module¶
-
class
PIL.TiffImagePlugin.
ImageFileDirectory
(prefix)[source]¶ Bases:
_abcoll.MutableMapping
-
load_dispatch
= {1: (1, <function load_byte>), 2: (1, <function load_string>), 3: (2, <function load_short>), 4: (4, <function load_long>), 5: (8, <function load_rational>), 7: (1, <function load_undefined>), 11: (4, <function load_float>), 12: (8, <function load_double>)}¶
-
TiffTags
Module¶
WebPImagePlugin
Module¶
WmfImagePlugin
Module¶
-
class
PIL.WmfImagePlugin.
WmfStubImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.StubImageFile
-
format
= 'WMF'¶
-
format_description
= 'Windows Metafile'¶
-
XVThumbImagePlugin
Module¶
-
class
PIL.XVThumbImagePlugin.
XVThumbImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
-
format
= 'XVThumb'¶
-
format_description
= 'XV thumbnail image'¶
-
XbmImagePlugin
Module¶
-
class
PIL.XbmImagePlugin.
XbmImageFile
(fp=None, filename=None)[source]¶ Bases:
PIL.ImageFile.ImageFile
-
format
= 'XBM'¶
-
format_description
= 'X11 Bitmap'¶
-