@header@
 
 
matplotlib.image
index
/usr/local/lib/python2.3/site-packages/matplotlib/image.py

The image module supports basic image loading, rescaling and display
operations.

 
Modules
       
matplotlib._image
matplotlib.cm
matplotlib.numerix
os
sys

 
Classes
       
matplotlib.artist.Artist
AxesImage(matplotlib.artist.Artist, matplotlib.cm.ScalarMappable)
FigureImage(matplotlib.artist.Artist, matplotlib.cm.ScalarMappable)
matplotlib.cm.ScalarMappable
AxesImage(matplotlib.artist.Artist, matplotlib.cm.ScalarMappable)
FigureImage(matplotlib.artist.Artist, matplotlib.cm.ScalarMappable)

 
class AxesImage(matplotlib.artist.Artist, matplotlib.cm.ScalarMappable)
    
Method resolution order:
AxesImage
matplotlib.artist.Artist
matplotlib.cm.ScalarMappable

Methods defined here:
__init__(self, ax, cmap=None, norm=None, aspect=None, interpolation=None, origin=None, extent=None)
aspect, interpolation and cmap default to their rc setting
 
cmap is a cm colormap instance
norm is a colors.normalize instance to map luminance to 0-1
 
extent is a data xmin, xmax, ymin, ymax for making image plots
registered with data plots.  Default is the image dimensions
in pixels
changed(self)
Call this whenever the mappable is changed so observers can
update state
draw(self, renderer, *args, **kwargs)
get_aspect(self)
Return the method used to constrain the aspoect ratio of the
One of
 
'free'     : aspect ratio not constrained
'preserve' : preserve aspect ratio when resizing
get_extent(self)
get the image extent: xmin, xmax, ymin, ymax
get_interpolation(self)
Return the interpolation method the image uses when resizing.
 
One of
 
'bicubic', 'bilinear', 'blackman100', 'blackman256', 'blackman64',
'nearest', 'sinc144', 'sinc256', 'sinc64', 'spline16', 'spline36'
get_size(self)
Get the numrows, numcols of the input image
make_image(self, flipy)
set_alpha(self, alpha)
Set the alpha value used for blending - not supported on
all backends
 
ACCEPTS: float
set_array(self, A)
retained for backwards compatibility - use set_data instead
 
ACCEPTS: numeric/numarray/PIL Image A
set_aspect(self, s)
Set the method used to constrain the aspoect ratio of the
image ehen resizing,
 
ACCEPTS ['free' | 'preserve']
set_data(self, A)
Set the image array
 
ACCEPTS: numeric/numarray/PIL Image A
set_interpolation(self, s)
Set the interpolation method the image uses when resizing.
 
ACCEPTS: ['bicubic' | 'bilinear' | 'blackman100' | 'blackman256' | 'blackman64', 'nearest' | 'sinc144' | 'sinc256' | 'sinc64' | 'spline16' | 'spline36']
write_png(self, fname)
Write the image to png file with fname

Methods inherited from matplotlib.artist.Artist:
get_alpha(self)
Return the alpha value used for blending - not supported on all
backends
get_clip_on(self)
Return whether artist uses clipping
get_figure(self)
return the figure instance
get_label(self)
get_transform(self)
return the Transformation instance used by this artist
get_visible(self)
return the artist's visiblity
get_zorder(self)
is_figure_set(self)
is_transform_set(self)
Artist has transform explicity let
set_clip_box(self, clipbox)
Set the artist's clip Bbox
 
ACCEPTS: a matplotlib.transform.Bbox instance
set_clip_on(self, b)
Set  whether artist uses clipping
 
ACCEPTS: [True | False]
set_figure(self, fig)
Set the figure instance the artist belong to
 
ACCEPTS: a matplotlib.figure.Figure instance
set_label(self, s)
Set the line label to s for auto legend
 
ACCEPTS: any string
set_lod(self, on)
Set Level of Detail on or off.  If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly
 
ACCEPTS: [True | False]
set_transform(self, t)
set the Transformation instance used by this artist
 
ACCEPTS: a matplotlib.transform transformation instance
set_visible(self, b)
set the artist's visiblity
 
ACCEPTS: [True | False]
set_zorder(self, level)
Set the zorder for the artist
 
ACCEPTS: any number
update(self, props)

Data and other attributes inherited from matplotlib.artist.Artist:
aname = 'Artist'
zorder = 0

Methods inherited from matplotlib.cm.ScalarMappable:
add_observer(self, mappable)
whenever the norm, clim or cmap is set, call the notify
instance of the mappable observer with self.
 
This is designed to allow one image to follow changes in the
cmap of another image
autoscale(self)
Autoscale the scalar limits on the norm instance using the
current array
notify(self, mappable)
If this is called then we are pegged to another mappable.
Update the cmap, norm accordingly
set_clim(self, vmin=None, vmax=None)
set the norm limits for image scaling
set_cmap(self, cmap)
set the colormap for luminance data
set_colorbar(self, im, ax)
set the colorbar image and axes associated with mappable
set_norm(self, norm)
set the colormap for luminance data
to_rgba(self, x, alpha=1.0)

 
class FigureImage(matplotlib.artist.Artist, matplotlib.cm.ScalarMappable)
    
Method resolution order:
FigureImage
matplotlib.artist.Artist
matplotlib.cm.ScalarMappable

Methods defined here:
__init__(self, fig, cmap=None, norm=None, offsetx=0, offsety=0, origin=None)
cmap is a cm colormap instance
norm is a colors.normalize instance to map luminance to 0-1
draw(self, renderer, *args, **kwargs)
get_size(self)
Get the numrows, numcols of the input image
make_image(self)
write_png(self, fname)
Write the image to png file with fname

Methods inherited from matplotlib.artist.Artist:
get_alpha(self)
Return the alpha value used for blending - not supported on all
backends
get_clip_on(self)
Return whether artist uses clipping
get_figure(self)
return the figure instance
get_label(self)
get_transform(self)
return the Transformation instance used by this artist
get_visible(self)
return the artist's visiblity
get_zorder(self)
is_figure_set(self)
is_transform_set(self)
Artist has transform explicity let
set_alpha(self, alpha)
Set the alpha value used for blending - not supported on
all backends
 
ACCEPTS: float
set_clip_box(self, clipbox)
Set the artist's clip Bbox
 
ACCEPTS: a matplotlib.transform.Bbox instance
set_clip_on(self, b)
Set  whether artist uses clipping
 
ACCEPTS: [True | False]
set_figure(self, fig)
Set the figure instance the artist belong to
 
ACCEPTS: a matplotlib.figure.Figure instance
set_label(self, s)
Set the line label to s for auto legend
 
ACCEPTS: any string
set_lod(self, on)
Set Level of Detail on or off.  If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly
 
ACCEPTS: [True | False]
set_transform(self, t)
set the Transformation instance used by this artist
 
ACCEPTS: a matplotlib.transform transformation instance
set_visible(self, b)
set the artist's visiblity
 
ACCEPTS: [True | False]
set_zorder(self, level)
Set the zorder for the artist
 
ACCEPTS: any number
update(self, props)

Data and other attributes inherited from matplotlib.artist.Artist:
aname = 'Artist'
zorder = 0

Methods inherited from matplotlib.cm.ScalarMappable:
add_observer(self, mappable)
whenever the norm, clim or cmap is set, call the notify
instance of the mappable observer with self.
 
This is designed to allow one image to follow changes in the
cmap of another image
autoscale(self)
Autoscale the scalar limits on the norm instance using the
current array
changed(self)
Call this whenever the mappable is changed so observers can
update state
notify(self, mappable)
If this is called then we are pegged to another mappable.
Update the cmap, norm accordingly
set_array(self, A)
Set the image array from numeric/numarray A
set_clim(self, vmin=None, vmax=None)
set the norm limits for image scaling
set_cmap(self, cmap)
set the colormap for luminance data
set_colorbar(self, im, ax)
set the colorbar image and axes associated with mappable
set_norm(self, norm)
set the colormap for luminance data
to_rgba(self, x, alpha=1.0)

 
Functions
       
arange(...)
arange(start, stop=None, step=1, typecode=None)
 
 Just like range() except it returns an array whose type can be
specified by the keyword argument typecode.
imread(fname)
return image file in fname as numerix array
 
Return value is a MxNx4 array of 0-1 normalized floats
pil_to_array(pilImage)

 
Data
        colorConverter = <matplotlib.colors.ColorConverter instance>
division = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
rcParams = {'axes.edgecolor': 'k', 'axes.facecolor': 'w', 'axes.grid': False, 'axes.hold': True, 'axes.labelcolor': 'k', 'axes.labelsize': 12.0, 'axes.linewidth': 1.0, 'axes.titlesize': 14.0, 'backend': 'GTKAgg', 'datapath': '/usr/local/share/matplotlib', ...}
@footer@