@header@
 
 
matplotlib.collections
index
/usr/local/lib/python2.3/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

 
Classes
       
matplotlib.artist.Artist
Collection
LineCollection
PatchCollection
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)

Methods inherited from matplotlib.artist.Artist:
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_on(self)
Return whether artist uses clipping
get_transform(self)
return the Transformation instance used by this artist
get_visible(self)
return the artist's visiblity
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
set_clip_box(self, clipbox)
Set the artist's clip Bbox
set_clip_on(self, b)
Set  whether artist uses clipping
set_figure(self, fig)
Set the figure instance the artist belong to
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
set_transform(self, t)
set the Transformation instance used by this artist
set_visible(self, b)
set the artist's visiblity

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

 
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, offsets=None, transOffset=<Affine object>)
sements is a sequence of ( (x00, y00, x01, y01), (x10, y10,
y11, y11), ) tuples
 
colors must be a tuple of RGBA tuples (eg arbitrary color
strings, etc, not allowed).
 
antialiaseds must be a sequence of ones or zeros
 
if linewidths, colors or antialiaseds is None, they default to
their rc params setting, in sequence form
color(self, c)
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
draw(self, renderer)
set_alpha(self, alpha)
set_linewidth(self, lw)
lw can be a scalar or a sequence; if it is a sequence the
patches will cycle through the sequence

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_transform(self)
return the Transformation instance used by this artist
get_visible(self)
return the artist's visiblity
is_figure_set(self)
is_transform_set(self)
Artist has transform explicity let
set_clip_box(self, clipbox)
Set the artist's clip Bbox
set_clip_on(self, b)
Set  whether artist uses clipping
set_figure(self, fig)
Set the figure instance the artist belong to
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
set_transform(self, t)
set the Transformation instance used by this artist
set_visible(self, b)
set the artist's visiblity

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

 
class PatchCollection(Collection)
    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
 
 
Method resolution order:
PatchCollection
Collection
matplotlib.artist.Artist

Methods defined here:
__init__(self, edgecolors=None, facecolors=None, linewidths=None, antialiaseds=None, offsets=None, transOffset=<Affine object>)
set_alpha(self, alpha)
set_edgecolor(self, c)
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
set_facecolor(self, c)
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
set_linewidth(self, lw)
lw can be a scalar or a sequence; if it is a sequence the
patches will cycle through the sequence

Methods inherited from matplotlib.artist.Artist:
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_on(self)
Return whether artist uses clipping
get_transform(self)
return the Transformation instance used by this artist
get_visible(self)
return the artist's visiblity
is_figure_set(self)
is_transform_set(self)
Artist has transform explicity let
set_clip_box(self, clipbox)
Set the artist's clip Bbox
set_clip_on(self, b)
Set  whether artist uses clipping
set_figure(self, fig)
Set the figure instance the artist belong to
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
set_transform(self, t)
set the Transformation instance used by this artist
set_visible(self, b)
set the artist's visiblity

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

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

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)

Methods inherited from PatchCollection:
set_alpha(self, alpha)
set_edgecolor(self, c)
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
set_facecolor(self, c)
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
set_linewidth(self, lw)
lw can be a scalar or a sequence; if it is a sequence the
patches will cycle through the sequence

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_transform(self)
return the Transformation instance used by this artist
get_visible(self)
return the artist's visiblity
is_figure_set(self)
is_transform_set(self)
Artist has transform explicity let
set_clip_box(self, clipbox)
Set the artist's clip Bbox
set_clip_on(self, b)
Set  whether artist uses clipping
set_figure(self, fig)
Set the figure instance the artist belong to
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
set_transform(self, t)
set the Transformation instance used by this artist
set_visible(self, b)
set the artist's visiblity

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

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

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)

Methods inherited from PatchCollection:
set_alpha(self, alpha)
set_edgecolor(self, c)
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
set_facecolor(self, c)
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
set_linewidth(self, lw)
lw can be a scalar or a sequence; if it is a sequence the
patches will cycle through the sequence

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_transform(self)
return the Transformation instance used by this artist
get_visible(self)
return the artist's visiblity
is_figure_set(self)
is_transform_set(self)
Artist has transform explicity let
set_clip_box(self, clipbox)
Set the artist's clip Bbox
set_clip_on(self, b)
Set  whether artist uses clipping
set_figure(self, fig)
Set the figure instance the artist belong to
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
set_transform(self, t)
set the Transformation instance used by this artist
set_visible(self, b)
set the artist's visiblity

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

 
Data
        False = False
True = True
colorConverter = <matplotlib.colors.ColorConverter instance>
cos = <UFunc: 'cos'>
pi = 3.1415926535897931
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', ...}
sin = <UFunc: 'sin'>
sqrt = <UFunc: 'sqrt'>
@footer@