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

 
Modules
       
math

 
Classes
       
matplotlib.artist.Artist
Patch
Polygon
Wedge
Rectangle
RegularPolygon
Circle
Shadow

 
class Circle(RegularPolygon)
    A circle patch
 
 
Method resolution order:
Circle
RegularPolygon
Patch
matplotlib.artist.Artist

Methods defined here:
__init__(self, xy, radius=5, resolution=20, **kwargs)

Methods inherited from RegularPolygon:
get_verts(self)

Methods inherited from Patch:
copy_properties(self, other)
draw(self, renderer)
get_aa(self)
alias for get_antialiased
get_antialiased(self)
get_ec(self)
alias for get_edgecolor
get_edgecolor(self)
get_facecolor(self)
get_fc(self)
alias for get_facecolor
get_fill(self)
return whether fill is set
get_linewidth(self)
get_lw(self)
alias for get_linewidth
get_window_extent(self, renderer=None)
set_antialiased(self, aa)
Set whether to use antialiased rendering
 
ACCEPTS: [True | False]
set_ec(self, val)
alias for set_edgecolor
set_edgecolor(self, color)
Set the patch edge color
 
ACCEPTS: any matplotlib color - see help(colors)
set_facecolor(self, color)
Set the patch face color
 
ACCEPTS: any matplotlib color - see help(colors)
set_fc(self, val)
alias for set_facecolor
set_fill(self, b)
Set whether to fill the patch
 
ACCEPTS: [True | False]
set_linewidth(self, w)
Set the patch linewidth in points
 
ACCEPTS: float
set_lw(self, val)
alias for set_linewidth

Data and other attributes inherited from Patch:
zorder = 1

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'

 
class Patch(matplotlib.artist.Artist)
    A patch is a 2D thingy with a face color and an edge color
 
If any of edgecolor, facecolor, linewidth, or antialiased are
None, they default to their rc params setting
 
  Methods defined here:
__init__(self, edgecolor=None, facecolor=None, linewidth=None, antialiased=None, fill=1, **kwargs)
copy_properties(self, other)
draw(self, renderer)
get_aa(self)
alias for get_antialiased
get_antialiased(self)
get_ec(self)
alias for get_edgecolor
get_edgecolor(self)
get_facecolor(self)
get_fc(self)
alias for get_facecolor
get_fill(self)
return whether fill is set
get_linewidth(self)
get_lw(self)
alias for get_linewidth
get_verts(self)
Return the vertices of the patch
get_window_extent(self, renderer=None)
set_antialiased(self, aa)
Set whether to use antialiased rendering
 
ACCEPTS: [True | False]
set_ec(self, val)
alias for set_edgecolor
set_edgecolor(self, color)
Set the patch edge color
 
ACCEPTS: any matplotlib color - see help(colors)
set_facecolor(self, color)
Set the patch face color
 
ACCEPTS: any matplotlib color - see help(colors)
set_fc(self, val)
alias for set_facecolor
set_fill(self, b)
Set whether to fill the patch
 
ACCEPTS: [True | False]
set_linewidth(self, w)
Set the patch linewidth in points
 
ACCEPTS: float
set_lw(self, val)
alias for set_linewidth

Data and other attributes defined here:
zorder = 1

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'

 
class Polygon(Patch)
    A general polygon patch.  xy is a sequence of x,y 2 tuples tuples
 
 
Method resolution order:
Polygon
Patch
matplotlib.artist.Artist

Methods defined here:
__init__(self, xy, **kwargs)
get_verts(self)

Methods inherited from Patch:
copy_properties(self, other)
draw(self, renderer)
get_aa(self)
alias for get_antialiased
get_antialiased(self)
get_ec(self)
alias for get_edgecolor
get_edgecolor(self)
get_facecolor(self)
get_fc(self)
alias for get_facecolor
get_fill(self)
return whether fill is set
get_linewidth(self)
get_lw(self)
alias for get_linewidth
get_window_extent(self, renderer=None)
set_antialiased(self, aa)
Set whether to use antialiased rendering
 
ACCEPTS: [True | False]
set_ec(self, val)
alias for set_edgecolor
set_edgecolor(self, color)
Set the patch edge color
 
ACCEPTS: any matplotlib color - see help(colors)
set_facecolor(self, color)
Set the patch face color
 
ACCEPTS: any matplotlib color - see help(colors)
set_fc(self, val)
alias for set_facecolor
set_fill(self, b)
Set whether to fill the patch
 
ACCEPTS: [True | False]
set_linewidth(self, w)
Set the patch linewidth in points
 
ACCEPTS: float
set_lw(self, val)
alias for set_linewidth

Data and other attributes inherited from Patch:
zorder = 1

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'

 
class Rectangle(Patch)
    Draw a rectangle with lower left at xy=(x,y) with specified
width and height
 
 
Method resolution order:
Rectangle
Patch
matplotlib.artist.Artist

Methods defined here:
__init__(self, xy, width, height, **kwargs)
xy is an x,y tuple lower, left
 
width and height are width and height of rectangle
 
fill is a boolean indicating whether to fill the rectangle
get_height(self)
Return the height of the rectangle
get_verts(self)
Return the vertices of the rectangle
get_width(self)
Return the width of the  rectangle
get_x(self)
Return the left coord of the rectangle
get_y(self)
Return the bottom coord of the rectangle
set_bounds(self, *args)
Set the bounds of the rectangle: l,b,w,h
 
ACCEPTS: (left, bottom, width, height)
set_height(self, h)
Set the width rectangle
 
ACCEPTS: float
set_width(self, w)
Set the width rectangle
 
ACCEPTS: float
set_x(self, x)
Set the left coord of the rectangle
 
ACCEPTS: float
set_y(self, y)
Set the bottom coord of the rectangle
 
ACCEPTS: float

Methods inherited from Patch:
copy_properties(self, other)
draw(self, renderer)
get_aa(self)
alias for get_antialiased
get_antialiased(self)
get_ec(self)
alias for get_edgecolor
get_edgecolor(self)
get_facecolor(self)
get_fc(self)
alias for get_facecolor
get_fill(self)
return whether fill is set
get_linewidth(self)
get_lw(self)
alias for get_linewidth
get_window_extent(self, renderer=None)
set_antialiased(self, aa)
Set whether to use antialiased rendering
 
ACCEPTS: [True | False]
set_ec(self, val)
alias for set_edgecolor
set_edgecolor(self, color)
Set the patch edge color
 
ACCEPTS: any matplotlib color - see help(colors)
set_facecolor(self, color)
Set the patch face color
 
ACCEPTS: any matplotlib color - see help(colors)
set_fc(self, val)
alias for set_facecolor
set_fill(self, b)
Set whether to fill the patch
 
ACCEPTS: [True | False]
set_linewidth(self, w)
Set the patch linewidth in points
 
ACCEPTS: float
set_lw(self, val)
alias for set_linewidth

Data and other attributes inherited from Patch:
zorder = 1

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'

 
class RegularPolygon(Patch)
    A regular polygon patch.  xy is a length 2 tuple (the center)
numVertices is the number of vertices.  Radius is the distance
from the center to each of the vertices.  Orientation is in
radians and rotates the polygon.
 
 
Method resolution order:
RegularPolygon
Patch
matplotlib.artist.Artist

Methods defined here:
__init__(self, xy, numVertices, radius=5, orientation=0, **kwargs)
get_verts(self)

Methods inherited from Patch:
copy_properties(self, other)
draw(self, renderer)
get_aa(self)
alias for get_antialiased
get_antialiased(self)
get_ec(self)
alias for get_edgecolor
get_edgecolor(self)
get_facecolor(self)
get_fc(self)
alias for get_facecolor
get_fill(self)
return whether fill is set
get_linewidth(self)
get_lw(self)
alias for get_linewidth
get_window_extent(self, renderer=None)
set_antialiased(self, aa)
Set whether to use antialiased rendering
 
ACCEPTS: [True | False]
set_ec(self, val)
alias for set_edgecolor
set_edgecolor(self, color)
Set the patch edge color
 
ACCEPTS: any matplotlib color - see help(colors)
set_facecolor(self, color)
Set the patch face color
 
ACCEPTS: any matplotlib color - see help(colors)
set_fc(self, val)
alias for set_facecolor
set_fill(self, b)
Set whether to fill the patch
 
ACCEPTS: [True | False]
set_linewidth(self, w)
Set the patch linewidth in points
 
ACCEPTS: float
set_lw(self, val)
alias for set_linewidth

Data and other attributes inherited from Patch:
zorder = 1

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'

 
class Shadow(Patch)
    
Method resolution order:
Shadow
Patch
matplotlib.artist.Artist

Methods defined here:
__init__(self, patch, ox, oy, props=None)
Create a shadow of the patch offset by ox, oy.  props, if not None is
a patch property update dictionary.  If None, the shadow will have
have the same color as the face, but darkened
get_verts(self)

Methods inherited from Patch:
copy_properties(self, other)
draw(self, renderer)
get_aa(self)
alias for get_antialiased
get_antialiased(self)
get_ec(self)
alias for get_edgecolor
get_edgecolor(self)
get_facecolor(self)
get_fc(self)
alias for get_facecolor
get_fill(self)
return whether fill is set
get_linewidth(self)
get_lw(self)
alias for get_linewidth
get_window_extent(self, renderer=None)
set_antialiased(self, aa)
Set whether to use antialiased rendering
 
ACCEPTS: [True | False]
set_ec(self, val)
alias for set_edgecolor
set_edgecolor(self, color)
Set the patch edge color
 
ACCEPTS: any matplotlib color - see help(colors)
set_facecolor(self, color)
Set the patch face color
 
ACCEPTS: any matplotlib color - see help(colors)
set_fc(self, val)
alias for set_facecolor
set_fill(self, b)
Set whether to fill the patch
 
ACCEPTS: [True | False]
set_linewidth(self, w)
Set the patch linewidth in points
 
ACCEPTS: float
set_lw(self, val)
alias for set_linewidth

Data and other attributes inherited from Patch:
zorder = 1

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'

 
class Wedge(Polygon)
    
Method resolution order:
Wedge
Polygon
Patch
matplotlib.artist.Artist

Methods defined here:
__init__(self, center, r, theta1, theta2, dtheta=0.10000000000000001, **kwargs)
Draw a wedge centered at x,y tuple center with radius r that
sweeps theta1 to theta2 (angles)
 
 
kwargs are Polygon keyword args
 
dtheta is the resolution in degrees

Methods inherited from Polygon:
get_verts(self)

Methods inherited from Patch:
copy_properties(self, other)
draw(self, renderer)
get_aa(self)
alias for get_antialiased
get_antialiased(self)
get_ec(self)
alias for get_edgecolor
get_edgecolor(self)
get_facecolor(self)
get_fc(self)
alias for get_facecolor
get_fill(self)
return whether fill is set
get_linewidth(self)
get_lw(self)
alias for get_linewidth
get_window_extent(self, renderer=None)
set_antialiased(self, aa)
Set whether to use antialiased rendering
 
ACCEPTS: [True | False]
set_ec(self, val)
alias for set_edgecolor
set_edgecolor(self, color)
Set the patch edge color
 
ACCEPTS: any matplotlib color - see help(colors)
set_facecolor(self, color)
Set the patch face color
 
ACCEPTS: any matplotlib color - see help(colors)
set_fc(self, val)
alias for set_facecolor
set_fill(self, b)
Set whether to fill the patch
 
ACCEPTS: [True | False]
set_linewidth(self, w)
Set the patch linewidth in points
 
ACCEPTS: float
set_lw(self, val)
alias for set_linewidth

Data and other attributes inherited from Patch:
zorder = 1

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'

 
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.
array(...)
array(sequence, typecode=None, copy=1, savespace=0) will return a new array formed from the given (potentially nested) sequence with type given by typecode.  If no typecode is given, then the type will be determined as the minimum type required to hold the objects in sequence.  If copy is zero and sequence is already an array, a reference will be returned.  If savespace is nonzero, the new array will maintain its precision in operations.
bbox_artist(artist, renderer, props=None)
This is a debug function to draw a rectangle around the bounding
box returned by get_window_extent of an artist, to test whether
the artist is returning the correct bbox
 
props is a dict of rectangle props with the additional property
'pad' that sets the padding around the bbox in points
draw_bbox(bbox, renderer, color='k', trans=None)
This is a debug function to draw a rectangle around the bounding
box returned by get_window_extent of an artist, to test whether
the artist is returning the correct bbox

 
Data
        Float = 'd'
colorConverter = <matplotlib.colors.ColorConverter instance>
cos = <ufunc 'cos'>
division = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
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': 'TkAgg', 'datapath': '/usr/local/share/matplotlib', ...}
sin = <ufunc 'sin'>
@footer@