Module wxmpl
[show private | hide private]
[frames | no frames]

Module wxmpl

Embedding matplotlib in wxPython applications is straightforward, but the default plotting widget lacks the capabilities necessary for interactive use. WxMpl (wxPython+matplotlib) is a library of components that provide these missing features in the form of a better matplolib FigureCanvas.
Classes
Channel Provides data for a StripCharter to plot.
FigurePrinter Provides a simplified interface to the wxPython printing framework that's designed for printing matplotlib figures.
PlotApp A wxApp that provides a matplotlib canvas embedded in a wxPython top-level window, encapsulating wxPython's nuts and bolts.
PlotFrame A matplotlib canvas embedded in a wxPython top-level window.
PlotPanel A matplotlib canvas suitable for embedding in wxPython applications.
StripCharter Plots and updates lines on a matplotlib Axes.
AxesLimits Alters the X and Y limits of Axes objects while maintaining a history of the changes.
CrosshairPainter Draws crosshairs through the current position of the mouse.
CursorChanger Manages the current cursor of a wxPython window, allowing it to be switched between a normal arrow and a square cross.
DestructableViewMixin Utility class to break the circular reference between an object and its associated "view".
FigurePrintout Render a matplotlib Figure to a page or file using wxPython's printing framework.
LocationPainter Draws a text message containing the current position of the mouse in the lower left corner of the plot.
MatrixBuffer Manages a Numerical Python matrix, automatically growing it as necessary to accomodate new rows of entries.
Painter Painters encapsulate the mechanics of drawing some value in a wxPython window and erasing it.
PlotPanelDirector Encapsulates all of the user-interaction logic required by the PlotPanel, following the Humble Dialog Box pattern proposed by Michael Feathers: http://www.objectmentor.com/resources/articles/TheHumbleDialogBox.pdf
PointEvent wxPython event emitted when a left-click-release occurs in a matplotlib axes of a window without an area selection.
RubberbandPainter Draws a selection rubberband from one point to another.
SelectionEvent wxPython event emitted when an area selection occurs in a matplotlib axes of a window for which zooming has been disabled.
VectorBuffer Manages a Numerical Python vector, automatically growing it as necessary to accomodate new entries.

Function Summary
  EVT_POINT(win, id, func)
Register to receive wxPython PointEvents from a PlotPanel or PlotFrame.
  EVT_SELECTION(win, id, func)
Register to receive wxPython SelectionEvents from a PlotPanel or PlotFrame.
  find_axes(canvas, x, y)
Finds the Axes within a matplotlib FigureCanvas contains the canavs coordinates (x, y) and returns that axes and the corresponding data coordinates xdata, ydata as a 3-tuple.
  find_selected_axes(canvas, x1, y1, x2, y2)
Finds the Axes within a matplotlib FigureCanvas that overlaps with a canvas area from (x1, y1) to (x1, y1).
  format_coord(axes, xdata, ydata)
A None-safe version of {Axes.format_coord()}.
  get_bbox_lims(bbox)
Returns the boundaries of the X and Y intervals of a Bbox.
  get_delta(X1, X2)
Returns the vector of contiguous, different points between two vectors.
  is_polar(axes)
Returns a boolean indicating if axes is a polar axes.
  limit_selection(bbox, axes)
Finds the region of a selection bbox which overlaps with the supplied axes and returns it as the 2-tuple ((xmin, ymin), (xmax, ymax)).
  make_bbox(X, Y)
Returns a Bbox that contains the supplied sets of X and Y coordinates.
  make_delta_bbox(X1, Y1, X2, Y2)
Returns a Bbox describing the range of difference between two sets of X and Y coordinates.

Variable Summary
str __version__ = '1.2.8'
bool BROKEN_WXAGG_BACKEND = True
int EVT_POINT_ID = 112                                                                   
int EVT_SELECTION_ID = 113                                                                   
str LINUX_PRINTING_COMMAND = 'lpr'

Function Details

EVT_POINT(win, id, func)

Register to receive wxPython PointEvents from a PlotPanel or PlotFrame.

EVT_SELECTION(win, id, func)

Register to receive wxPython SelectionEvents from a PlotPanel or PlotFrame.

find_axes(canvas, x, y)

Finds the Axes within a matplotlib FigureCanvas contains the canavs coordinates (x, y) and returns that axes and the corresponding data coordinates xdata, ydata as a 3-tuple.

If no axes contains the specified point a 3-tuple of None is returned.

find_selected_axes(canvas, x1, y1, x2, y2)

Finds the Axes within a matplotlib FigureCanvas that overlaps with a canvas area from (x1, y1) to (x1, y1). That axes and the corresponding X and Y axes ranges are returned as a 3-tuple.

If no axes overlaps with the specified area, or more than one axes overlaps, a 3-tuple of Nones is returned.

format_coord(axes, xdata, ydata)

A None-safe version of {Axes.format_coord()}.

get_bbox_lims(bbox)

Returns the boundaries of the X and Y intervals of a Bbox.

get_delta(X1, X2)

Returns the vector of contiguous, different points between two vectors.

is_polar(axes)

Returns a boolean indicating if axes is a polar axes.

limit_selection(bbox, axes)

Finds the region of a selection bbox which overlaps with the supplied axes and returns it as the 2-tuple ((xmin, ymin), (xmax, ymax)).

make_bbox(X, Y)

Returns a Bbox that contains the supplied sets of X and Y coordinates.

make_delta_bbox(X1, Y1, X2, Y2)

Returns a Bbox describing the range of difference between two sets of X and Y coordinates.

Variable Details

__version__

Type:
str
Value:
'1.2.8'                                                                

BROKEN_WXAGG_BACKEND

Type:
bool
Value:
True                                                                   

EVT_POINT_ID

Type:
int
Value:
112                                                                   

EVT_SELECTION_ID

Type:
int
Value:
113                                                                   

LINUX_PRINTING_COMMAND

Type:
str
Value:
'lpr'                                                                  

Generated by Epydoc 2.1 on Mon Aug 28 13:47:50 2006 http://epydoc.sf.net