ImageFile
index
/Library/Python/2.7/site-packages/PIL/ImageFile.py

# The Python Imaging Library.
# $Id$
#
# base class for image file handlers
#
# history:
# 1995-09-09 fl   Created
# 1996-03-11 fl   Fixed load mechanism.
# 1996-04-15 fl   Added pcx/xbm decoders.
# 1996-04-30 fl   Added encoders.
# 1996-12-14 fl   Added load helpers
# 1997-01-11 fl   Use encode_to_file where possible
# 1997-08-27 fl   Flush output in _save
# 1998-03-05 fl   Use memory mapping for some modes
# 1999-02-04 fl   Use memory mapping also for "I;16" and "I;16B"
# 1999-05-31 fl   Added image parser
# 2000-10-12 fl   Set readonly flag on memory-mapped images
# 2002-03-20 fl   Use better messages for common decoder errors
# 2003-04-21 fl   Fall back on mmap/map_buffer if map is not available
# 2003-10-30 fl   Added StubImageFile class
# 2004-02-25 fl   Made incremental parser more robust
#
# Copyright (c) 1997-2004 by Secret Labs AB
# Copyright (c) 1995-2004 by Fredrik Lundh
#
# See the README file for information on usage and redistribution.
#

 
Modules
       
Image
os
string
traceback

 
Classes
       
Image.Image
ImageFile
StubImageFile
Parser

 
class ImageFile(Image.Image)
    Base class for image file format handlers.
 
  Methods defined here:
__init__(self, fp=None, filename=None)
draft(self, mode, size)
Set draft mode
load(self)
Load image data based on tile list
load_end(self)
load_prepare(self)
verify(self)
Check file integrity

Methods inherited from Image.Image:
__getattr__(self, name)
__repr__(self)
convert(self, mode=None, data=None, dither=None, palette=0, colors=256)
Convert to other pixel format
copy(self)
Copy raster data
crop(self, box=None)
Crop region from image
filter(self, filter)
Apply environment filter to image
fromstring(self, data, decoder_name='raw', *args)
Load data to image from binary string
getbands(self)
Get band names
getbbox(self)
Get bounding box of actual data (non-zero pixels) in image
getcolors(self, maxcolors=256)
Get colors from image, up to given limit
getdata(self, band=None)
Get image data as sequence object.
getextrema(self)
Get min/max value
getim(self)
Get PyCObject pointer to internal image memory
getpalette(self)
Get palette contents.
getpixel(self, xy)
Get pixel value
getprojection(self)
Get projection to x and y axes
histogram(self, mask=None, extrema=None)
Take histogram of image
offset(self, xoffset, yoffset=None)
(deprecated) Offset image in horizontal and/or vertical direction
paste(self, im, box=None, mask=None)
Paste other image into region
point(self, lut, mode=None)
Map image through lookup table
putalpha(self, alpha)
Set alpha layer
putdata(self, data, scale=1.0, offset=0.0)
Put data from a sequence object into an image.
putpalette(self, data, rawmode='RGB')
Put palette data into an image.
putpixel(self, xy, value)
Set pixel value
quantize(self, colors=256, method=0, kmeans=0, palette=None)
resize(self, size, resample=0)
Resize image
rotate(self, angle, resample=0, expand=0)
Rotate image.  Angle given as degrees counter-clockwise.
save(self, fp, format=None, **params)
Save image to file or stream
seek(self, frame)
Seek to given frame in sequence file
show(self, title=None, command=None)
Display image (for debug purposes only)
split(self)
Split image into bands
tell(self)
Return current frame number
thumbnail(self, size, resample=0)
Create thumbnail representation (modifies image in place)
tobitmap(self, name='image')
Return image as an XBM bitmap
tostring(self, encoder_name='raw', *args)
Return image as a binary string
transform(self, size, method, data=None, resample=0, fill=1)
Transform image
transpose(self, method)
Transpose image (flip or rotate in 90 degree steps)

Data and other attributes inherited from Image.Image:
format = None
format_description = None

 
class Parser
     Methods defined here:
close(self)
feed(self, data)
reset(self)

Data and other attributes defined here:
data = None
decoder = None
finished = 0
image = None
incremental = None

 
class StubImageFile(ImageFile)
    Base class for stub image loaders.
 
 
Method resolution order:
StubImageFile
ImageFile
Image.Image

Methods defined here:
load(self)

Methods inherited from ImageFile:
__init__(self, fp=None, filename=None)
draft(self, mode, size)
Set draft mode
load_end(self)
load_prepare(self)
verify(self)
Check file integrity

Methods inherited from Image.Image:
__getattr__(self, name)
__repr__(self)
convert(self, mode=None, data=None, dither=None, palette=0, colors=256)
Convert to other pixel format
copy(self)
Copy raster data
crop(self, box=None)
Crop region from image
filter(self, filter)
Apply environment filter to image
fromstring(self, data, decoder_name='raw', *args)
Load data to image from binary string
getbands(self)
Get band names
getbbox(self)
Get bounding box of actual data (non-zero pixels) in image
getcolors(self, maxcolors=256)
Get colors from image, up to given limit
getdata(self, band=None)
Get image data as sequence object.
getextrema(self)
Get min/max value
getim(self)
Get PyCObject pointer to internal image memory
getpalette(self)
Get palette contents.
getpixel(self, xy)
Get pixel value
getprojection(self)
Get projection to x and y axes
histogram(self, mask=None, extrema=None)
Take histogram of image
offset(self, xoffset, yoffset=None)
(deprecated) Offset image in horizontal and/or vertical direction
paste(self, im, box=None, mask=None)
Paste other image into region
point(self, lut, mode=None)
Map image through lookup table
putalpha(self, alpha)
Set alpha layer
putdata(self, data, scale=1.0, offset=0.0)
Put data from a sequence object into an image.
putpalette(self, data, rawmode='RGB')
Put palette data into an image.
putpixel(self, xy, value)
Set pixel value
quantize(self, colors=256, method=0, kmeans=0, palette=None)
resize(self, size, resample=0)
Resize image
rotate(self, angle, resample=0, expand=0)
Rotate image.  Angle given as degrees counter-clockwise.
save(self, fp, format=None, **params)
Save image to file or stream
seek(self, frame)
Seek to given frame in sequence file
show(self, title=None, command=None)
Display image (for debug purposes only)
split(self)
Split image into bands
tell(self)
Return current frame number
thumbnail(self, size, resample=0)
Create thumbnail representation (modifies image in place)
tobitmap(self, name='image')
Return image as an XBM bitmap
tostring(self, encoder_name='raw', *args)
Return image as a binary string
transform(self, size, method, data=None, resample=0, fill=1)
Transform image
transpose(self, method)
Transpose image (flip or rotate in 90 degree steps)

Data and other attributes inherited from Image.Image:
format = None
format_description = None

 
Functions
       
raise_ioerror(error)

 
Data
        ERRORS = {-9: 'out of memory error', -8: 'bad configuration', -3: 'unknown error', -2: 'decoding error', -1: 'image buffer overrun error'}
MAXBLOCK = 65536
SAFEBLOCK = 1048576