Table of Contents

Class: madXYScatterPlot ui/madrigalPlot.py

madXYScatterPlot is the class the produces XY scatter plots.

Change History:

Written by Brandon Scott Fines Aug 2, 2006 Written by Bill Rideout Aug 2, 2006

Methods   
__init__
  __init__ 
__init__ (
        self,
        inputText,
        titleStr,
        xLabelStr,
        yLabelStr,
        fullFilename,
        size='small',
        lowBound=None,
        highBound=None,
        maxNumPoints=None,
        yLegend=None,
        )

Inputs:

inputText - string of values to be plotted. The formatting is as follows:

xval yval xval yval xval yval

titleStr - title of the Plot

xLabelStr - label for the x axis

yLabelStr - label for the y axis

fullFilename - full file path to save the resulting picture to

size - size of plot to be saved. Must be small,'wide', or large. defaults to small.

lowBound - lower bound on the x-axis value. If no bound is specified, the lowest value found in inputText will be used.

highBound - upper bound on the x-axis value. If no bound is specified, the highest value found in inputText will be used.

maxNumPoints - maximum number of points to be plotted.

Outputs: None

Affects: Creates a scatter plot using matplotlib and writes that to the file designated by the variable fullFilename

Exceptions: ValueError if lowBound or highBound cannot be converted to a float value

Non-standard python modules used:

matplotlib

Exceptions   
ValueError, 'lowBound not a number'
ValueError, 'no valid y data found'
ValueError, 'size must be "small","wide", or "large", not %s' %(str( size ) )

Table of Contents

This document was automatically generated on Thu Oct 20 16:51:50 2011 by HappyDoc version r1_5