Table of Contents

Class: madLineTimePlot ui/madrigalPlot.py

madLineTimePlot is the class the produces line plots of one or more parameters versus time.

Methods   
__filter_missing
__init__
__truncateIsprint
displayToScreen
getFigureHandle
writeToFile
  __filter_missing 
__filter_missing ( self,  x )

  __init__ 
__init__ (
        self,
        isprintText,
        yParmList,
        titleStr,
        xLabelStr,
        yLabelStr,
        fullFilename,
        size='small',
        useAbsoluteTime=False,
        startTime=None,
        endTime=None,
        maxNumPoints=None,
        noTime=False,
        yMinimum=None,
        yMaximum=None,
        noDate=False,
        timezone=0,
        )

__init__ writes a madLineTimePlot plot to a file.

Inputs:

isprintText - a string giving isprint output without headers. First parameter must be UTH or UT1, depending on whether time scale should be relative to the experiment beginning (UTH) or absolute (UT1). The the following must be the parameters to be plotted. Any missing data should be written as "missing" or other string that cannot be converted to a float.

yParmList - a list of y parameters (strings). Length must == num columns in isprintText - 1

titleStr - plot title (string) - should describe parameter being plotted

xLabelStr - x label string

yLabelStr - ylabel string

fullFilename - full path of file containing pcolor plot to be saved. Extension must be jpeg or png, or exception thrown.

size - size of plot to save. Must be "small", "wide", or "large". Defaults to small.

useAbsoluteTime - if true, print time as YYYY-MM-DD HH:MM:SS. If false (default), print time as hour since beginning of experiment (UTH). If useAbsoluteTime is true, first parameter in isprintText must be UT1, if false, it must be UTH.

startTime - start plot at given time. If useAbsoluteTime == True, then startTime must be in units of seconds since 1/1/1950. If useAbsoluteTime == False, then startTime must be in units of UTH (hours since midnight UT of first day of experiment). Default is None, which means start at lowest time found.

endTime - end plot at given time. If useAbsoluteTime == True, then endTime must be in units of seconds since 1/1/1950. If useAbsoluteTime == False, then endTime must be in units of UTH (hours since midnight UT of first day of experiment). Default is None, which means end at largest time found.

maxNumPoints - maximum number of points to plot. If not None, truncate isprintText if needed to have at most maxNumPoints lines.

noTime - if True and useAbsoluteTime True, then dates without times printed on x axis.

noDate - if True and useAbsoluteTime True, then times without dates printed on x axis.

yMinimum - set y minimum. If default=None, use data minimum

yMaximum - set y maximum. If default=None, use data maximum

timezone - The offset of the local (non-DST) timezone, in seconds west of UTC (negative in most of Western Europe, positive in the US, zero in the UK).

Returns: void

Affects: None

Exceptions   
ValueError, 'No valid y data found'
ValueError, 'input text is not parseable'
ValueError, 'size must be "small", "wide", or "large", not %s' %(str( size ) )
  __truncateIsprint 
__truncateIsprint (
        self,
        isprintText,
        maxLines,
        )

__truncateIsprint truncates isprintText to have maxLines at most.

  displayToScreen 
displayToScreen ( self )

  getFigureHandle 
getFigureHandle ( self )

  writeToFile 
writeToFile ( self,  fullFilename )


Table of Contents

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