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

A Cairo backend for matplotlib implemented using pycairo
Author: Steve Chaplin
 
Cairo is a vector graphics library with cross-device output support.
Features of Cairo:
 * anti-aliasing
 * alpha channel 
 * in-memory image buffers
 * save image files:
   - PNG
   - PostScript (50% complete)
   - PDF        (proposed, 0% complete)
 
http://cairographics.org
http://www.freedesktop.org/Cairo/Home
Requires (in order, all available from Cairo website):
    libpixman, cairo, pycairo
 
cairo, pycairo from cvs fom Nov 06 2004 onwards are required
 
Naming Conventions
  * classes MixedUpperCase
  * varables lowerUpper
  * functions underscore_separated

 
Modules
       
cairo
os
sys

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

 
class FigureCanvasCairo(matplotlib.backend_bases.FigureCanvasBase)
    The canvas the figure renders into.  Calls the draw and print fig
methods, creates the renderers, etc...
Public attributes
  figure - A Figure instance
 
  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)
draw(self)
Render the 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
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 = ('button_press_event', 'button_release_event', 'motion_notify_event')

 
class GraphicsContextCairo(matplotlib.backend_bases.GraphicsContextBase)
    The graphics context provides the color, line styles, etc...
 
  Methods defined here:
__init__(self, renderer)
set_alpha(self, alpha)
Set the alpha value used for blending
set_capstyle(self, cs)
Set the capstyle as a string in ('butt', 'round', 'projecting')
set_clip_rectangle(self, rectangle)
Set the clip rectangle with sequence (left, bottom, width, height)
set_dashes(self, offset, dashes)
set_foreground(self, fg, isRGB=None)
Set the foreground color.  fg can be a matlab format string, a
html hex color string, an rgb unit tuple, or a float between 0
and 1.  In the latter case, grayscale is used.
set_joinstyle(self, js)
Set the join style to be one of ('miter', 'round', 'bevel')
set_linewidth(self, w)
Set the linewidth in points

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_graylevel(self, frac)
Set the foreground color to be a gray level with frac frac
set_linestyle(self, style)
Set the linestyle to be one of ('solid', 'dashed', 'dashdot',
'dotted').

 
class RendererCairo(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, surface, matrix, width, height, dpi)
draw_arc(self, gc, 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 arc with it.
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(self, gc, x1, y1, x2, y2)
Draw a single line from x1,y1 to x2,y2
draw_lines(self, gc, x, y)
x and y are equal length arrays, draw lines connecting each
point in x, y
draw_point(self, gc, x, y)
Draw a single point at x,y
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 rectangle with it.
draw_rectangle(self, gc, rgbFace, x, y, width, height)
Draw a non-filled rectangle at x,y (lower left) with width and height,
using the GraphicsContext gcEdge.
Draw a filled rectangle within it of color rgbFace, if rgbFace is not
None.
draw_text(self, gc, x, y, s, prop, angle, ismath=False)
Render the matplotlib.text.Text instance at x, y in window
coords using GraphicsContext gc
flipy(self)
return true if y small numbers are top for renderer
get_canvas_width_height(self)
return the canvas width and height in display coords
get_text_scale(self)
Return the scale factor for fontsize taking screendpi and pixels per
inch into account
get_text_width_height(self, s, prop, ismath)
get the width and height in display coords of the string s
with FontPropertry prop
new_gc(self)
Return an instance of a GraphicsContextCairo
points_to_pixels(self, points)
Convert points to display units (as a float).

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
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_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 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
get_text_extent(self, text)
Get the text extent in window coords
open_group(self, s)
open a grouping element with label s
strip_math(self, s)

 
Functions
       
Bbox(...)
Bbox(ll, ur)
draw_if_interactive()
This should be overriden in a windowing environment if drawing
should be done in interactive python mode
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')
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
 
orientation - only currently applies to PostScript printing.
filename - can also be a file object, png format is assumed
show()
This is usually the last line of a matlab script and tells the
backend that it is time to draw.  In interactive mode, this may be
a do nothing func.  See the GTK backend for an example of how to
handle interactive versus batch mode

 
Data
        DEBUG = False
False = False
IMAGE_FORMAT = ['eps', 'png', 'ps', 'svg']
IMAGE_FORMAT_DEFAULT = 'png'
PIXELS_PER_INCH = 96
True = True
UInt8 = 'b'
backend_version = 'unknown'
division = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
pi = 3.1415926535897931
verbose = <matplotlib.Verbose instance>
@footer@