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

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

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

 
Classes
       
matplotlib.artist.Artist
AxesImage(matplotlib.artist.Artist, matplotlib.cm.ScalarMappable)
NonUniformImage
FigureImage(matplotlib.artist.Artist, matplotlib.cm.ScalarMappable)
matplotlib.cm.ScalarMappable
AxesImage(matplotlib.artist.Artist, matplotlib.cm.ScalarMappable)
NonUniformImage
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, interpolation=None, origin=None, extent=None, filternorm=1, filterrad=4.0)
interpolation and cmap default to their rc settings
 
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_extent(self)
get the image extent: xmin, xmax, ymin, ymax
get_filternorm(self)
return the filternorm setting
get_filterrad(self)
return the filterrad setting
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)
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_data(self, A, shape=None)
Set the image array
 
ACCEPTS: numeric/numarray/PIL Image A
set_filternorm(self, filternorm)
Set whether the resize filter norms the weights -- see
help for imshow
 
ACCEPTS: 0 or 1
set_filterrad(self, filterrad)
Set the resize filter radius only applicable to some
interpolation schemes -- see help for imshow
 
ACCEPTS: positive float
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:
add_callback(self, func)
get_alpha(self)
Return the alpha value used for blending - not supported on all
backends
get_animated(self)
return the artist's animated state
get_clip_box(self)
Return artist clipbox
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
pchanged(self)
fire event when property changed
remove_callback(self, oid)
set(self, **kwargs)
A tkstyle set command, pass kwargs to set properties
set_animated(self, b)
set the artist's animation state
 
ACCEPTS: [True | False]
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)
update_from(self, other)
copy properties from other to self

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
get_array(self)
Return the array
get_clim(self)
return the min, max of the color limits for image scaling
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 normalization instance
to_rgba(self, x, alpha=1.0)
Return a normalized rgba array corresponding to x.
If x is already an rgb or rgba array, return it unchanged.

 
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:
add_callback(self, func)
get_alpha(self)
Return the alpha value used for blending - not supported on all
backends
get_animated(self)
return the artist's animated state
get_clip_box(self)
Return artist clipbox
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
pchanged(self)
fire event when property changed
remove_callback(self, oid)
set(self, **kwargs)
A tkstyle set command, pass kwargs to set properties
set_alpha(self, alpha)
Set the alpha value used for blending - not supported on
all backends
 
ACCEPTS: float
set_animated(self, b)
set the artist's animation state
 
ACCEPTS: [True | False]
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)
update_from(self, other)
copy properties from other to self

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
get_array(self)
Return the array
get_clim(self)
return the min, max of the color limits for image scaling
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 normalization instance
to_rgba(self, x, alpha=1.0)
Return a normalized rgba array corresponding to x.
If x is already an rgb or rgba array, return it unchanged.

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

Methods defined here:
__init__(self, ax, cmap=None, norm=None, extent=None)
get_extent(self)
make_image(self)
set_array(self, *args)
set_cmap(self, cmap)
set_data(self, x, y, A)
set_filternorm(self, s)
set_filterrad(self, s)
set_interpolation(self, s)
set_norm(self, norm)

Methods inherited from AxesImage:
changed(self)
Call this whenever the mappable is changed so observers can
update state
draw(self, renderer, *args, **kwargs)
get_filternorm(self)
return the filternorm setting
get_filterrad(self)
return the filterrad setting
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
set_alpha(self, alpha)
Set the alpha value used for blending - not supported on
all backends
 
ACCEPTS: float
write_png(self, fname)
Write the image to png file with fname

Methods inherited from matplotlib.artist.Artist:
add_callback(self, func)
get_alpha(self)
Return the alpha value used for blending - not supported on all
backends
get_animated(self)
return the artist's animated state
get_clip_box(self)
Return artist clipbox
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
pchanged(self)
fire event when property changed
remove_callback(self, oid)
set(self, **kwargs)
A tkstyle set command, pass kwargs to set properties
set_animated(self, b)
set the artist's animation state
 
ACCEPTS: [True | False]
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)
update_from(self, other)
copy properties from other to self

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
get_array(self)
Return the array
get_clim(self)
return the min, max of the color limits for image scaling
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_colorbar(self, im, ax)
set the colorbar image and axes associated with mappable
to_rgba(self, x, alpha=1.0)
Return a normalized rgba array corresponding to x.
If x is already an rgb or rgba array, return it unchanged.

 
Functions
       
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
        Float32 = 'f'
NewAxis = None
UInt8 = 'B'
colorConverter = <matplotlib.colors.ColorConverter instance>
division = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
rcParams = {'axes.axisbelow': False, 'axes.edgecolor': 'black', 'axes.facecolor': 'white', 'axes.grid': False, 'axes.hold': True, 'axes.labelcolor': 'black', 'axes.labelsize': 12.0, 'axes.linewidth': 1.0, 'axes.titlesize': 14.0, 'backend': 'GTKAgg', ...}
@footer@