Package PyFoam :: Package Basics :: Module GnuplotTimelines :: Class GnuplotTimelines
[hide private]
[frames] | no frames]

Class GnuplotTimelines

source code

ThirdParty.Gnuplot._Gnuplot.Gnuplot --+
                                      |
                                     GnuplotTimelines

This class opens a gnuplot window and plots a timelines-collection in it

Instance Methods [hide private]
 
__init__(self, timelines, persist=None, raiseit=True, with='lines', alternateAxis=[], forbidden=[], start=None, end=None, logscale=False, ylabel=None, y2label=None)
Create a Gnuplot object.
source code
 
redo(self)
Replot the timelines
source code

Inherited from ThirdParty.Gnuplot._Gnuplot.Gnuplot: __call__, __del__, clear, close, hardcopy, interact, load, plot, refresh, replot, reset, save, set, set_boolean, set_label, set_range, set_string, splot, title, xlabel, ylabel, zlabel

Class Variables [hide private]
  terminalNr = 1

Inherited from ThirdParty.Gnuplot._Gnuplot.Gnuplot: optiontypes

Method Details [hide private]

__init__(self, timelines, persist=None, raiseit=True, with='lines', alternateAxis=[], forbidden=[], start=None, end=None, logscale=False, ylabel=None, y2label=None)
(Constructor)

source code 
Create a Gnuplot object.

Create a 'Gnuplot' object.  By default, this starts a gnuplot
process and prepares to write commands to it.

Keyword arguments:

  'filename=<string>' -- if a filename is specified, the
      commands are instead written to that file (e.g., for
      later use using 'load').

  'persist=1' -- start gnuplot with the '-persist' option
      (which creates a new plot window for each plot command).
      (This option is not available on older versions of
      gnuplot.)

  'debug=1' -- echo the gnuplot commands to stderr as well as
      sending them to gnuplot.

Parameters:
  • timelines (TimeLineCollection) - The timelines object
  • persist - Gnuplot window persistst after run
  • raiseit - Raise the window at every plot
  • with - how to plot the data (lines, points, steps)
  • alternateAxis - list with names that ought to appear on the alternate y-axis
  • forbidden - A list with strings. If one of those strings is found in a name, it is not plotted
  • start - First time that should be plotted. If undefined everything from the start is plotted
  • end - Last time that should be plotted. If undefined data is plotted indefinitly
  • logscale - Scale the y-axis logarithmic
  • ylabel - Label of the y-axis
  • y2label - Label of the alternate y-axis
Overrides: ThirdParty.Gnuplot._Gnuplot.Gnuplot.__init__