.. include:: headings.inc

.. module:: lib.plot

.. currentmodule:: lib.plot

.. highlight:: python



.. _lib.plot:

==========================================================================================================================================
|phoenix_title|  **plot**
==========================================================================================================================================

This is a simple light weight plotting module that can be used with
Boa or easily integrated into your own wxPython application.  The
emphasis is on small size and fast plotting for large data sets.  It
has a reasonable number of features to do line and scatter graphs
easily as well as simple bar graphs.  It is not as sophisticated or 
as powerful as SciPy Plt or Chaco.  Both of these are great packages 
but consume huge amounts of computer resources for simple plots.
They can be found at http://scipy.com

This file contains two parts; first the re-usable library stuff, then,
after a "if __name__=='__main__'" test, a simple frame and a few default
plots for examples and testing.

Based on wxPlotCanvas
Written by K.Hinsen, R. Srinivasan;
Ported to wxPython Harm van der Heijden, feb 1999

Major Additions Gordon Williams Feb. 2003 (g_will@cyberus.ca)
    -More style options
    -Zooming using mouse "rubber band"
    -Scroll left, right
    -Grid(graticule)
    -Printing, preview, and page set up (margins)
    -Axis and title labels
    -Cursor xy axis values
    -Doc strings and lots of comments
    -Optimizations for large number of points
    -Legends
    
Did a lot of work here to speed markers up. Only a factor of 4
improvement though. Lines are much faster than markers, especially
filled markers.  Stay away from circles and triangles unless you
only have a few thousand points.

Times for 25,000 points
Line - 0.078 sec
Markers
Square -                   0.22 sec
dot -                      0.10
circle -                   0.87
cross,plus -               0.28
triangle, triangle_down -  0.90

Thanks to Chris Barker for getting this version working on Linux.

Zooming controls with mouse (when enabled):
    Left mouse drag - Zoom box.
    Left mouse double click - reset zoom.
    Right mouse click - zoom out centred on click location.



|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for module **plot**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.plot_inheritance.png" alt="Inheritance diagram of plot" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="591,85,671,115"/> <area shape="rect" id="node12" href="Panel.html" title="A panel is a window on which controls are placed." alt="" coords="784,58,856,89"/> <area shape="rect" id="node27" href="TopLevelWindow.html" title="TopLevelWindow  is a common base class for Dialog  and Frame." alt="" coords="748,111,892,142"/> <area shape="rect" id="node2" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="400,85,499,115"/> <area shape="rect" id="node8" href="lib.plot.PlotPrintout.html" title="Controls how the plot is made in printing and previewing" alt="" coords="564,138,697,169"/> <area shape="rect" id="node5" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="232,125,304,155"/> <area shape="rect" id="node10" href="lib.plot.PlotGraphics.html" title="Container to hold PolyXXX objects and graph labels" alt="" coords="7,65,151,95"/> <area shape="rect" id="node11" href="lib.plot.PlotCanvas.html" title="Subclass of a wx.Panel which holds two scrollbars and the actual" alt="" coords="941,58,1075,89"/> <area shape="rect" id="node14" href="lib.plot.TestFrame.html" title="plot.TestFrame" alt="" coords="1124,111,1252,142"/> <area shape="rect" id="node15" href="Frame.html" title="A frame is a window whose size and position can (usually) be changed by the user." alt="" coords="972,111,1044,142"/> <area shape="rect" id="node20" href="lib.plot.PolySpline.html" title="Class to define line type and style" alt="" coords="385,5,513,35"/> <area shape="rect" id="node21" href="lib.plot.PolyLine.html" title="Class to define line type and style" alt="" coords="211,5,325,35"/> <area shape="rect" id="node23" href="lib.plot.PolyPoints.html" title="Base Class for lines and markers" alt="" coords="15,9,143,39"/> <area shape="rect" id="node25" href="lib.plot.PolyMarker.html" title="Class to define marker type and style" alt="" coords="201,58,335,89"/> </map> 
   </p>

|


|class_summary| Classes Summary
===============================

================================================================================ ================================================================================
:ref:`lib.plot.PlotCanvas`                                                       Subclass of a wx.Panel which holds two scrollbars and the actual
:ref:`lib.plot.PlotGraphics`                                                     Container to hold PolyXXX objects and graph labels
:ref:`lib.plot.PlotPrintout`                                                     Controls how the plot is made in printing and previewing
:ref:`lib.plot.PolyLine`                                                         Class to define line type and style
:ref:`lib.plot.PolyMarker`                                                       Class to define marker type and style
:ref:`lib.plot.PolyPoints`                                                       Base Class for lines and markers
:ref:`lib.plot.PolySpline`                                                       Class to define line type and style
:ref:`lib.plot.TestFrame`                                                        
================================================================================ ================================================================================


|


.. toctree::
   :maxdepth: 1
   :hidden:

   lib.plot.PlotCanvas
   lib.plot.PlotGraphics
   lib.plot.PlotPrintout
   lib.plot.PolyLine
   lib.plot.PolyMarker
   lib.plot.PolyPoints
   lib.plot.PolySpline
   lib.plot.TestFrame