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

An agg http://antigrain.com/ backend
 
Features that are implemented
 
 * capstyles and join styles
 * dashes
 * linewidth 
 * lines, rectangles, ellipses
 * clipping to a rectangle
 * output to RGBA and PNG
 * alpha blending
 * DPI scaling properly - everything scales properly (dashes, linewidths, etc)
 * draw polygon 
 * freetype2 w/ ft2font
 
TODO:
 
  * allow save to file handle
 
  * allow load from png
 
  * integrate screen dpi w/ ppi and text
  
INSTALLING 
 
  REQUIREMENTs
 
    python2.2+
    Numeric 22+
    agg2 (see below)
    freetype 2
    libpng
    libz
    
  Install AGG2 (cut and paste below into xterm should work)
 
    wget http://www.antigrain.com/agg2.tar.gz
    tar xvfz agg2.tar.gz
    cd agg2
    make
 
    (Optional) if you want to make the examples:
    cd examples/X11
    make
 
  Installing backend_agg
 
     
   Edit setup.py: change aggsrc to point to the agg2 src tree and
   replace if 0: with if 1: in the backend_agg section
 
   Then just do the usual thing: python setup.py build
 
   Please let me know if you encounter build problems, and tell me
   platform, gcc version, etc...  Currently the paths in setupext.py
   assume as linux like filesystem (eg X11 include dir, location of
   libttf, etcc) so you may need to tweak these
 
  Using agg backend
 
    python somefile.py -dAgg   
 
  or
 
    import matplotlib
    matplotlib.use('Agg')

 
Modules
       
os
sys

 
Classes
       
matplotlib.backend_bases.FigureCanvasBase
FigureCanvasAgg
matplotlib.backend_bases.RendererBase
RendererAgg

 
class FigureCanvasAgg(matplotlib.backend_bases.FigureCanvasBase)
    The canvas the figure renders into.  Calls the draw and print fig
methods, creates the renderers, etc...
 
Public attribute
 
  figure - A Figure instance
 
  Methods defined here:
buffer_rgba(self)
draw(self)
Draw the figure using the renderer
print_figure(self, filename, dpi=150, facecolor='w', edgecolor='w', orientation='portrait')
Render the figure to hardcopy.  Set the figure patch face and
edge colors.  This is useful because some of the GUIs have a
gray figure face color background and you'll probably want to
override this on hardcopy
 
If the extension matches PNG, write a PNG file
 
If the extension matches BMP or RAW, write an RGBA bitmap file
tostring_rgb(self)

Methods inherited from matplotlib.backend_bases.FigureCanvasBase:
__init__(self, figure)
mpl_connect(self, s, func)
Connect event with string s to func.  The signature of func is
 
  def func(event)
 
where event is a MplEvent.  The following events are recognized
 
 'button_press_event' 
 'button_release_event' 
 'motion_notify_event' 
 
 For the three events above, if the mouse is over the axes,
 the variable event.inaxes will be set to the axes it is over,
 and additionally, the variables event.xdata and event.ydata
 will be defined.  This is the mouse location in data coords.
 See backend_bases.MplEvent.
 
return value is a connection id that can be used with
mpl_disconnect
mpl_disconnect(self, cid)
Connect s to func. return an id that can be used with disconnect
switch_backends(self, FigureCanvasClass)
instantiate an instance of FigureCanvasClass
 
This is used for backend switching, eg, to instantiate a
FigureCanvasPS from a FigureCanvasGTK.  Note, deep copying is
not done, so any changes to one of the instances (eg, setting
figure size or line props), will be reflected in the other

Data and other attributes inherited from matplotlib.backend_bases.FigureCanvasBase:
events = ('button_press_event', 'button_release_event', 'motion_notify_event')

 
class RendererAgg(matplotlib.backend_bases.RendererBase)
    The renderer handles all the drawing primitives using a graphics
context instance that controls the colors/styles
 
  Methods defined here:
__init__(self, width, height, dpi)
buffer_rgba(self)
clear(self)
draw_arc(self, gcEdge, rgbFace, x, y, width, height, angle1, angle2)
Draw an arc centered at x,y with width and height and angles
from 0.0 to 360.0
 
If rgbFace is not None, fill the rectangle with that color.  gcEdge
is a GraphicsContext instance
 
Currently, I'm only supporting ellipses, ie angle args are
ignored
draw_line(self, gc, x1, y1, x2, y2)
x and y are equal length arrays, draw lines connecting each
point in x, y
draw_mathtext(self, gc, x, y, s, prop, angle)
Draw the math text using matplotlib.mathtext
draw_point(self, gc, x, y)
Draw a single point at x,y
draw_text(self, gc, x, y, s, prop, angle, ismath)
Render the text
get_canvas_width_height(self)
return the canvas width and height in display coords
get_text_width_height(self, s, prop, ismath)
get the width and height in display coords of the string s
with FontPropertry prop
points_to_pixels(self, points)
convert point measures to pixes using dpi and the pixels per
inch of the display
tostring_rgb(self)

Data and other attributes defined here:
debug = 1

Methods inherited from matplotlib.backend_bases.RendererBase:
close_group(self, s)
close a grouping element with label s
draw_image(self, x, y, im, origin, bbox)
Draw the Image instance into the current axes; x is the
distance in pixels from the left hand side of the canvas. y is
the distance from the origin.  That is, if origin is upper, y
is the distance from top.  If origin is lower, y is the
distance from bottom
 
origin is 'upper' or 'lower'
 
bbox is a matplotlib.transforms.BBox instance for clipping, or
None
draw_line_collection(self, segments, transform, clipbox, colors, linewidths, antialiaseds, offsets, transOffset)
This is a function for optimized line drawing.  If you need to
draw many line segments with similar properties, it is faster
to avoid the overhead of all the object creation etc.  The
lack of total configurability is compensated for with
efficiency.  Hence we don't use a GC and many of the line
props it supports.  See matplotlib.collections for more
details
 
sements is a sequence of ( line0, line1, line2), where linen =
(x0, y0), (x1, y1), ... (xm, ym).  Each line can be a
different length
 
transform is used to Transform the lines
 
clipbox is a  xmin, ymin, width, height clip rect
 
colors is a tuple of RGBA tuples
 
linewidths is a tuple of linewidths
 
antialiseds is a tuple of ones or zeros indicating whether the
segment should be aa or not
 
offsets, if not None, is a list of x,y offsets to translate
the lines by after transoff is used to transform the offset
coords
 
This function is intended to be overridden by the backend
level in extension code for backends that want fast line
collection drawing.  Here is is implemented using native
backend calls and may be slow
draw_lines(self, gc, x, y)
x and y are equal length arrays, draw lines connecting each
point in x, y
draw_poly_collection(self, verts, transform, clipbox, facecolors, edgecolors, linewidths, antialiaseds, offsets, transOffset)
Draw a polygon collection
 
verts are a sequence of polygon vectors, where each polygon
vector is a sequence of x,y tuples of vertices
 
facecolors and edgecolors are a sequence of RGBA tuples
linewidths are a sequence of linewidths
antialiaseds are a sequence of 0,1 integers whether to use aa
draw_polygon(self, gc, rgbFace, points)
Draw a polygon.  points is a len vertices tuple, each element
giving the x,y coords a vertex
 
If rgbFace is not None, fill the poly with it.  gc
is a GraphicsContext instance
draw_rectangle(self, gcEdge, gcFace, x, y, width, height)
Draw a rectangle with lower left at x,y with width and height.
 
If gcFace is not None, fill the rectangle with it.  gcEdge
is a GraphicsContext instance
draw_regpoly_collection(self, clipbox, offsets, transOffset, verts, sizes, facecolors, edgecolors, linewidths, antialiaseds)
Draw a regular poly collection
 
offsets is a sequence is x,y tuples and transOffset maps this
to display coords
 
verts are the vertices of the regular polygon at the origin
 
sizes are the area of the circle that circumscribes the
polygon in points^2
 
facecolors and edgecolors are a sequence of RGBA tuples
linewidths are a sequence of linewidths
antialiaseds are a sequence of 0,1 integers whether to use aa
flipy(self)
return true if y small numbers are top for renderer
get_text_extent(self, text)
Get the text extent in window coords
new_gc(self)
Return an instance of a GraphicsContextBase
open_group(self, s)
open a grouping element with label s

 
Functions
       
FT2Font(...)
FT2Font
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.
new_figure_manager(num, *args, **kwargs)
Create a new figure manager instance

 
Data
        DEBUG = 0
False = False
Float = 'd'
True = True
division = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
fontManager = <matplotlib.font_manager.FontManager instance>
@footer@