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

Classes for the efficient drawing of large collections of objects that
share most properties, eg a large number of line segments or polygons
 
The classes are not meant to be as flexible as their single element
counterparts (eg you may not be able to select all line styles) but
they are meant to be fast for common use cases (eg a bunch of solid
line segemnts)

 
Modules
       
math
warnings

 
Classes
       
matplotlib.artist.Artist
Collection
LineCollection
PatchCollection(Collection, matplotlib.cm.ScalarMappable)
PolyCollection
RegularPolyCollection

 
class Collection(matplotlib.artist.Artist)
    All properties in a collection must be sequences.  The
property of the ith element of the collection is the
 
  prop[i % len(props)].
 
This implies that the properties cycle if the len of props is less
than the number of elements of the collection.  A length 1
property is shared by all the elements of the collection
 
All color args to a collection are sequences of rgba tuples
 
  Methods defined here:
__init__(self)
get_verts(self)
return seq of (x,y) in collection

Methods inherited from matplotlib.artist.Artist:
add_callback(self, func)
draw(self, renderer, *args, **kwargs)
Derived classes drawing method
get_alpha(self)
Return the alpha value used for blending - not supported on all
backends
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_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

 
class LineCollection(Collection)
    All parameters must be sequences.  The property of the ith line
segment is the prop[i % len(props)], ie the properties cycle if
the len of props is less than the number of sements
 
 
Method resolution order:
LineCollection
Collection
matplotlib.artist.Artist

Methods defined here:
__init__(self, segments, linewidths=None, colors=None, antialiaseds=None, linestyle='solid', offsets=None, transOffset=None)
segments is a sequence of ( line0, line1, line2), where
linen = (x0, y0), (x1, y1), ... (xm, ym).
Each line can be a different length.
 
colors must be a tuple of RGBA tuples (eg arbitrary color
strings, etc, not allowed).
 
antialiaseds must be a sequence of ones or zeros
 
linestyles is a string or dash tuple. Legal string values are
  solid|dashed|dashdot|dotted.  The dash tuple is (offset, onoffseq)
  where onoffseq is an even length tuple of on and off ink in points.
 
if linewidths, colors, or antialiaseds is None, they default to
their rc params setting, in sequence form
color(self, c)
Set the color(s) of the line collection.  c can be a
matplotlib color arg (all patches have same color), or a a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
 
ACCEPTS: matplotlib color arg or sequence of rgba tuples
draw(self, renderer)
get_colors(self)
get_dashes(self)
get_lines(self)
return seq of lines in collection
get_linestyle(self)
get_linewidths(self)
get_verts(self)
return seq of (x,y) in collection
set_alpha(self, alpha)
Set the alpha tranpancies of the collection.  Alpha can be a
float, in which case it is applied to the entire collection,
or a sequence of floats
 
ACCEPTS: float or sequence of floats
set_color(self, c)
Set the color(s) of the line collection.  c can be a
matplotlib color arg (all patches have same color), or a a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence
 
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_linestyle(self, ls)
Set the linestyles(s) for the collection.
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' |  (offset, on-off-dash-seq) ]
set_linewidth(self, lw)
Set the linewidth(s) for the collection.  lw can be a scalar or a
sequence; if it is a sequence the patches will cycle through the
sequence
 
ACCEPTS: float or sequence of floats

Data and other attributes defined here:
zorder = 2

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_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_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'

 
class PatchCollection(Collection, matplotlib.cm.ScalarMappable)
    and transOffset are used to translate the patch after
rendering (default no offsets)
 
If any of edgecolors, facecolors, linewidths, antialiaseds are
None, they default to their patch.* rc params setting, in sequence
form
 
The use of ScalarMappable is optional.  If the ScalarMappable
matrix _A is not None (ie a call to set_array has been made), at
draw time a call to scalar mappable will be made to set the face
colors.
 
 
Method resolution order:
PatchCollection
Collection
matplotlib.artist.Artist
matplotlib.cm.ScalarMappable

Methods defined here:
__init__(self, edgecolors=None, facecolors=None, linewidths=None, antialiaseds=None, offsets=None, transOffset=<Affine object>, norm=None, cmap=None)
set_alpha(self, alpha)
Set the alpha tranpancies of the collection.  Alpha can be a
float, in which case it is applied to the entire collection,
or a sequence of floats
 
ACCEPTS: float or sequence of floats
set_color(self, c)
Set both the edgecolor and the facecolor.
See set_facecolor and set_edgecolor.
 
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_edgecolor(self, c)
Set the facecolor(s) of the collection. c can be a matplotlib color
arg (all patches have same color), or a a sequence or rgba tuples; if
it is a sequence the patches will cycle through the sequence
 
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_facecolor(self, c)
Set the facecolor(s) of the collection.  c can be a matplotlib
color arg (all patches have same color), or a a sequence or
rgba tuples; if it is a sequence the patches will cycle
through the sequence
 
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_linewidth(self, lw)
Set the linewidth(s) for the collection.  lw can be a scalar or a
sequence; if it is a sequence the patches will cycle through the
sequence
 
ACCEPTS: float or sequence of floats
update_scalarmappable(self)
If the scalar mappable array is not none, update facecolors
from scalar data

Data and other attributes defined here:
zorder = 1

Methods inherited from Collection:
get_verts(self)
return seq of (x,y) in collection

Methods inherited from matplotlib.artist.Artist:
add_callback(self, func)
draw(self, renderer, *args, **kwargs)
Derived classes drawing method
get_alpha(self)
Return the alpha value used for blending - not supported on all
backends
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_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'

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
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)

 
class PolyCollection(PatchCollection)
    
Method resolution order:
PolyCollection
PatchCollection
Collection
matplotlib.artist.Artist
matplotlib.cm.ScalarMappable

Methods defined here:
__init__(self, verts, **kwargs)
verts is a sequence of ( verts0, verts1, ...) where verts_i is
a sequence of xy tuples of vertices.
 
 
 
Optional kwargs from Patch collection include
 
  edgecolors    = ( (0,0,0,1), ),
  facecolors    = ( (1,1,1,0), ),
  linewidths    = ( 1.0, ),
  antialiaseds  = (1,),
  offsets       = None
  transOffset   = None
draw(self, renderer)
get_verts(self)
return seq of (x,y) in collection

Methods inherited from PatchCollection:
set_alpha(self, alpha)
Set the alpha tranpancies of the collection.  Alpha can be a
float, in which case it is applied to the entire collection,
or a sequence of floats
 
ACCEPTS: float or sequence of floats
set_color(self, c)
Set both the edgecolor and the facecolor.
See set_facecolor and set_edgecolor.
 
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_edgecolor(self, c)
Set the facecolor(s) of the collection. c can be a matplotlib color
arg (all patches have same color), or a a sequence or rgba tuples; if
it is a sequence the patches will cycle through the sequence
 
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_facecolor(self, c)
Set the facecolor(s) of the collection.  c can be a matplotlib
color arg (all patches have same color), or a a sequence or
rgba tuples; if it is a sequence the patches will cycle
through the sequence
 
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_linewidth(self, lw)
Set the linewidth(s) for the collection.  lw can be a scalar or a
sequence; if it is a sequence the patches will cycle through the
sequence
 
ACCEPTS: float or sequence of floats
update_scalarmappable(self)
If the scalar mappable array is not none, update facecolors
from scalar data

Data and other attributes inherited from PatchCollection:
zorder = 1

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_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_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'

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
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)

 
class RegularPolyCollection(PatchCollection)
    
Method resolution order:
RegularPolyCollection
PatchCollection
Collection
matplotlib.artist.Artist
matplotlib.cm.ScalarMappable

Methods defined here:
__init__(self, dpi, numsides, rotation=0, sizes=(1,), **kwargs)
Draw a regular polygon with numsides.  sizes gives the area of
the circle circumscribing the regular polygon and rotation is
the rotation of the polygon in radians.
 
offsets are a sequence of x,y tuples that give the centers of
the polygon in data coordinates, and transOffset is the
Transformation instance used to transform the centers onto the
canvas.
 
dpi is the figure dpi instance, and is required to do the area
scaling.
draw(self, renderer)
get_verts(self)
return seq of (x,y) in collection

Methods inherited from PatchCollection:
set_alpha(self, alpha)
Set the alpha tranpancies of the collection.  Alpha can be a
float, in which case it is applied to the entire collection,
or a sequence of floats
 
ACCEPTS: float or sequence of floats
set_color(self, c)
Set both the edgecolor and the facecolor.
See set_facecolor and set_edgecolor.
 
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_edgecolor(self, c)
Set the facecolor(s) of the collection. c can be a matplotlib color
arg (all patches have same color), or a a sequence or rgba tuples; if
it is a sequence the patches will cycle through the sequence
 
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_facecolor(self, c)
Set the facecolor(s) of the collection.  c can be a matplotlib
color arg (all patches have same color), or a a sequence or
rgba tuples; if it is a sequence the patches will cycle
through the sequence
 
ACCEPTS: matplotlib color arg or sequence of rgba tuples
set_linewidth(self, lw)
Set the linewidth(s) for the collection.  lw can be a scalar or a
sequence; if it is a sequence the patches will cycle through the
sequence
 
ACCEPTS: float or sequence of floats
update_scalarmappable(self)
If the scalar mappable array is not none, update facecolors
from scalar data

Data and other attributes inherited from PatchCollection:
zorder = 1

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_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_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'

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
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)

 
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.

 
Data
        colorConverter = <matplotlib.colors.ColorConverter instance>
cos = <ufunc 'cos'>
pi = 3.1415926535897931
rcParams = {'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', 'datapath': '/usr/share/matplotlib', ...}
sin = <ufunc 'sin'>
sqrt = <ufunc 'sqrt'>
verbose = <matplotlib.Verbose instance>
@footer@