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

A Cairo backend for matplotlib
Author: Steve Chaplin
 
Cairo is a vector graphics library with cross-device output support.
Features of Cairo:
 * anti-aliasing
 * alpha channel 
 * saves image files as PNG, PostScript, PDF
 
http://cairographics.org
Requires (in order, all available from Cairo website):
    libpixman, cairo, pycairo
 
Naming Conventions
  * classes MixedUpperCase
  * varables lowerUpper
  * functions underscore_separated

 
Modules
       
matplotlib.agg
cairo
matplotlib.numerix
os
sys
warnings

 
Classes
       
matplotlib.backend_bases.FigureCanvasBase
FigureCanvasCairo
matplotlib.backend_bases.GraphicsContextBase
GraphicsContextCairo
matplotlib.backend_bases.RendererBase
RendererCairo

 
class FigureCanvasCairo(matplotlib.backend_bases.FigureCanvasBase)
     Methods defined here:
print_figure(self, filename, dpi=150, facecolor='w', edgecolor='w', orientation='portrait')

Methods inherited from matplotlib.backend_bases.FigureCanvasBase:
__init__(self, figure)
button_press_event(self, x, y, button, guiEvent=None)
Backend derived classes should call this function on any mouse
button press.  x,y are the canvas coords: 0,0 is lower, left.
button and key are as defined in MouseEvent
button_release_event(self, x, y, button, guiEvent=None)
Backend derived classes should call this function on any mouse
button release.  x,y are the canvas coords: 0,0 is lower, left.
button and key are as defined in MouseEvent
draw(self, *args, **kwargs)
Render the figure
draw_cursor(self, event)
Draw a cursor in the event.axes if inaxes is not None.  Use
native GUI drawing for efficiency if possible
draw_idle(self, *args, **kwargs)
draw only if idle; defaults to draw but backends can overrride
key_press_event(self, key, guiEvent=None)
key_release_event(self, key, guiEvent=None)
motion_notify_event(self, x, y, guiEvent=None)
Backend derived classes should call this function on any mouse
button release.  x,y are the canvas coords: 0,0 is lower, left.
button and key are as defined in MouseEvent
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
 
 'key_press_event' 
 '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
Method should return None
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 = ('key_press_event', 'key_release_event', 'button_press_event', 'button_release_event', 'motion_notify_event')

 
class GraphicsContextCairo(matplotlib.backend_bases.GraphicsContextBase)
     Methods defined here:
__init__(self, renderer)
set_alpha(self, alpha)
set_capstyle(self, cs)
set_clip_rectangle(self, rectangle)
set_dashes(self, offset, dashes)
set_foreground(self, fg, isRGB=None)
set_graylevel(self, frac)
set_joinstyle(self, js)
set_linewidth(self, w)

Methods inherited from matplotlib.backend_bases.GraphicsContextBase:
copy_properties(self, gc)
Copy properties from gc to self
get_alpha(self)
Return the alpha value used for blending - not supported on
all backends
get_antialiased(self)
Return true if the object should try to do antialiased rendering
get_capstyle(self)
Return the capstyle as a string in ('butt', 'round', 'projecting')
get_clip_rectangle(self)
Return the clip rectangle as (left, bottom, width, height)
get_dashes(self)
Return the dash information as an offset dashlist tuple The
dash list is a even size list that gives the ink on, ink off
in pixels.  See p107 of to postscript BLUEBOOK for more info
 
Default value is None
get_joinstyle(self)
Return the line join style as one of ('miter', 'round', 'bevel')
get_linestyle(self, style)
Return the linestyle: one of ('solid', 'dashed', 'dashdot',
'dotted').
get_linewidth(self)
Return the line width in points as a scalar
get_rgb(self)
returns a tuple of three floats from 0-1.  color can be a
matlab format string, a html hex color string, or a rgb tuple
set_antialiased(self, b)
True if object should be drawn with antialiased rendering
set_linestyle(self, style)
Set the linestyle to be one of ('solid', 'dashed', 'dashdot',
'dotted').

Data and other attributes inherited from matplotlib.backend_bases.GraphicsContextBase:
dashd = {'dashdot': (0, (3.0, 5.0, 1.0, 5.0)), 'dashed': (0, (6.0, 6.0)), 'dotted': (0, (1.0, 3.0)), 'solid': (None, None)}

 
class RendererCairo(matplotlib.backend_bases.RendererBase)
     Methods defined here:
__init__(self, dpi)
width, height - the canvas width, height. Is not necessarily
the same as the surface (pixmap) width, height
draw_arc(self, gc, rgbFace, x, y, width, height, angle1, angle2)
draw_image(self, x, y, im, origin, bbox)
draw_line(self, gc, x1, y1, x2, y2)
draw_lines(self, gc, x, y, transform=None)
draw_markers(self, gc, path, rgbFace, x, y, transform)
draw_point(self, gc, x, y)
draw_polygon(self, gc, rgbFace, points)
draw_rectangle(self, gc, rgbFace, x, y, width, height)
draw_text(self, gc, x, y, s, prop, angle, ismath=False)
flipy(self)
get_canvas_width_height(self)
get_text_width_height(self, s, prop, ismath)
new_gc(self)
points_to_pixels(self, points)

Data and other attributes defined here:
fontangles = {'italic': 1, 'normal': 0, 'oblique': 2}
fontweights = {100: 0, 200: 0, 300: 0, 400: 0, 500: 0, 600: 1, 700: 1, 800: 1, 900: 1, 'black': 1, ...}

Methods inherited from matplotlib.backend_bases.RendererBase:
close_group(self, s)
close a grouping element with label s
Is only currently used by backend_svg
draw_line_collection(self, segments, transform, clipbox, colors, linewidths, linestyle, 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.
 
segments 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
*** really should be called 'dashes' not 'linestyle', since
we call gc.set_dashes() not gc.set_linestyle() ***
 
linestyle is an (offset, onoffseq) tuple or None,None for solid
 
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 transform is used to transform the offset coords
 
This function could be overridden in the backend to possibly implement
faster drawing, but it is already much faster than using draw_lines()
by itself.
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_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
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
get_text_extent(self, text)
Get the text extent in window coords
open_group(self, s)
open a grouping element with label s
Is only currently used by backend_svg
strip_math(self, s)

 
Functions
       
Bbox(...)
Bbox(ll, ur)
fromstring(...)
fromstring(string, typecode='l', count=-1) returns a new 1d array initialized from the raw binary data in string.  If count is positive, the new array will have count elements, otherwise it's size is determined by the size of string.
new_figure_manager(num, *args, **kwargs)
Create a new figure manager instance
print_figure_fn(figure, filename, dpi=150, facecolor='w', edgecolor='w', orientation='portrait')
zeros(...)
zeros((d1,...,dn),typecode='l',savespace=0) will return a new array of shape (d1,...,dn) and type typecode with all it's entries initialized to zero.  If savespace is nonzero the array will be a spacesaver array.

 
Data
        DEBUG = False
HAVE_CAIRO_NUMPY = True
IMAGE_FORMAT = ['eps', 'png', 'ps', 'svg']
IMAGE_FORMAT_DEFAULT = 'png'
UInt8 = 'b'
backend_version = 'Unknown'
division = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
pi = 3.1415926535897931
version_required = (0, 1, 4)
@footer@