@header@
 
 
matplotlib.patches
index
/matplotlib/patches.py

 
Classes
       
matplotlib.artist.Artist
Patch
Circle
Rectangle
RegularPolygon

 
class Circle(Patch)
    A circle patch
 
Public attributes:
  dpi     : a DPI instance
  bbox    : a Bound2D instance in display coords
  transx : a Bound1D instance giving the x coords
  transy : a Bound1D instance giving the y coords
  transrx : a Bound1D instance giving the radius coords in x direction
  transry : a Bound1D instance giving the radius coords in y direction
 
 
Method resolution order:
Circle
Patch
matplotlib.artist.Artist

Methods defined here:
__init__(self, dpi, bbox, xy, radius=5, edgecolor='k', facecolor='b', fill=1, transx=Transform: Bound1D: 0 1 to Bound1D: 0 1, transy=Transform: Bound1D: 0 1 to Bound1D: 0 1, transrx=None, transry=None)
if transrx is None, default to transx
if transry is None, default to transy
get_window_extent(self)

Methods inherited from Patch:
copy_properties(self, other)
get_linewidth(self)
set_edgecolor(self, color)
set_facecolor(self, color)
set_fill(self, b)
set_linewidth(self, w)

Methods inherited from matplotlib.artist.Artist:
draw(self, drawable=None, *args, **kwargs)
Derived classes drawing method
get_child_artists(self)
Return all artists contained in self
get_dpi(self)
Get the DPI of the display
set_child_attr(self, attr, val)
Set attribute attr for self, and all child artists
set_clip_on(self, b)
Set whether artist is clipped to bbox
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_renderer(self, renderer)
Set the renderer
set_transform(self, transform)
Set the artist transform for self and all children
wash_brushes(self)
Erase any state vars that would impair a draw to a clean palette

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
 
Public attributes:
dpi    : a DPI instance
bbox   : a Bound2D instance in display coords
transx : a Transform instance
transy : a Transform instance
 
  Methods defined here:
__init__(self, dpi, bbox, edgecolor='k', facecolor='b', fill=1, transx=Transform: Bound1D: 0 1 to Bound1D: 0 1, transy=Transform: Bound1D: 0 1 to Bound1D: 0 1)
copy_properties(self, other)
get_linewidth(self)
set_edgecolor(self, color)
set_facecolor(self, color)
set_fill(self, b)
set_linewidth(self, w)

Methods inherited from matplotlib.artist.Artist:
draw(self, drawable=None, *args, **kwargs)
Derived classes drawing method
get_child_artists(self)
Return all artists contained in self
get_dpi(self)
Get the DPI of the display
get_window_extent(self)
Return the window extent of the Artist as a Bound2D instance
set_child_attr(self, attr, val)
Set attribute attr for self, and all child artists
set_clip_on(self, b)
Set whether artist is clipped to bbox
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_renderer(self, renderer)
Set the renderer
set_transform(self, transform)
Set the artist transform for self and all children
wash_brushes(self)
Erase any state vars that would impair a draw to a clean palette

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
 
Public attributes:
dpi     : a DPI instance
bbox     : a Bound2D instance in display coords
transx : a Transform instance for x data
transy : a Transform instance for y data
transw : a Transform instance for width data, default transx
transh : a Transform instance for height data, default transy
 
 
Method resolution order:
Rectangle
Patch
matplotlib.artist.Artist

Methods defined here:
__init__(self, dpi, bbox, xy, width, height, edgecolor='k', facecolor='b', fill=True, transx=Transform: Bound1D: 0 1 to Bound1D: 0 1, transy=Transform: Bound1D: 0 1 to Bound1D: 0 1, transw=None, transh=None)
dpi  isa DPI instance
bbox is the display Bound2D bounding boc
xy is an x,y tuple; width and height are width and height of rectangle
fill is a boolean indicating whether to fill the rectangle
transy and transy are the transforms of the x and y data
transw and hccords are the transforms of the width and height data
        if None, use transx and transy
get_height(self)
Return the height of the rectangle
get_width(self)
Return the width of the  rectangle
get_window_extent(self)
get_x(self)
Return the left coord of the rectangle
get_y(self)
Return the bottom coord of the rectangle
set_bounds(self, l, b, w, h)
set_height(self, h)
Set the width rectangle
set_width(self, w)
Set the width rectangle
set_x(self, x)
Set the left coord of the rectangle
set_y(self, y)
Set the bottom coord of the rectangle

Methods inherited from Patch:
copy_properties(self, other)
get_linewidth(self)
set_edgecolor(self, color)
set_facecolor(self, color)
set_fill(self, b)
set_linewidth(self, w)

Methods inherited from matplotlib.artist.Artist:
draw(self, drawable=None, *args, **kwargs)
Derived classes drawing method
get_child_artists(self)
Return all artists contained in self
get_dpi(self)
Get the DPI of the display
set_child_attr(self, attr, val)
Set attribute attr for self, and all child artists
set_clip_on(self, b)
Set whether artist is clipped to bbox
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_renderer(self, renderer)
Set the renderer
set_transform(self, transform)
Set the artist transform for self and all children
wash_brushes(self)
Erase any state vars that would impair a draw to a clean palette

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.
 
Public attributes:
dpi     : a DPI instance
bbox    : a Bound2D instance in display coords
transx  : a Transform for the x data
transy  : a Transform for the y data
transw  : a Transform for the radius
 
 
Method resolution order:
RegularPolygon
Patch
matplotlib.artist.Artist

Methods defined here:
__init__(self, dpi, bbox, xy, numVertices, radius=5, orientation=0, edgecolor='k', facecolor='b', fill=1, transx=Transform: Bound1D: 0 1 to Bound1D: 0 1, transy=Transform: Bound1D: 0 1 to Bound1D: 0 1, transr=Transform: Bound1D: 0 1 to Bound1D: 0 1)

Methods inherited from Patch:
copy_properties(self, other)
get_linewidth(self)
set_edgecolor(self, color)
set_facecolor(self, color)
set_fill(self, b)
set_linewidth(self, w)

Methods inherited from matplotlib.artist.Artist:
draw(self, drawable=None, *args, **kwargs)
Derived classes drawing method
get_child_artists(self)
Return all artists contained in self
get_dpi(self)
Get the DPI of the display
get_window_extent(self)
Return the window extent of the Artist as a Bound2D instance
set_child_attr(self, attr, val)
Set attribute attr for self, and all child artists
set_clip_on(self, b)
Set whether artist is clipped to bbox
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_renderer(self, renderer)
Set the renderer
set_transform(self, transform)
Set the artist transform for self and all children
wash_brushes(self)
Erase any state vars that would impair a draw to a clean palette

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, drawable)
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
        False = False
Float = 'd'
True = True
cos = <ufunc 'cos'>
division = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
pi = 3.1415926535897931
sin = <ufunc 'sin'>
@footer@