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

Class GnuplotTimelines

source code


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

Instance Methods [hide private]
 
__init__(self, timelines, custom, showWindow=True, registry=None)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
actualSetTitle(self, title)
Sets the title
source code
 
buildData(self, times, name, title, lastValid)
Build the implementation specific data
source code
 
doHardcopy(self, filename, form)
Write the contents of the plot to disk
source code
 
doReplot(self)
Replot the whole data
source code
 
preparePlot(self)
Prepare the plotting window
source code
 
setYLabel(self, title)
Sets the label on the first Y-Axis
source code
 
setYLabel2(self, title)
Sets the label on the second Y-Axis
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

    Inherited from GeneralPlotTimelines.GeneralPlotTimelines
 
getNames(self)
Get the names of the data items
source code
 
hasData(self)
Check whether there is any plotable data
source code
 
hasTimes(self)
Check whether this timeline contains any timesteps
source code
 
redo(self)
Replot the timelines
source code
 
setTitle(self, title)
Sets the title
source code
    Inherited from ThirdParty.Gnuplot._Gnuplot.Gnuplot
 
__call__(self, s)
Send a command string to gnuplot.
source code
 
__del__(self) source code
 
_add_to_queue(self, items)
Add a list of items to the itemlist (but don't plot them).
source code
 
_clear_queue(self)
Clear the 'PlotItems' from the queue.
source code
 
clear(self)
Clear the plot window (without affecting the current itemlist).
source code
 
close(self) source code
 
hardcopy(self, filename=None, terminal='postscript', **keyw)
Create a hardcopy of the current plot.
source code
 
interact(self)
Allow user to type arbitrary commands to gnuplot.
source code
 
load(self, filename)
Load a file using gnuplot's 'load' command.
source code
 
plot(self, *items, **keyw)
Draw a new plot.
source code
 
refresh(self)
Refresh the plot, using the current 'PlotItem's.
source code
 
replot(self, *items, **keyw)
Replot the data, possibly adding new 'PlotItem's.
source code
 
reset(self)
Reset all gnuplot settings to their defaults and clear itemlist.
source code
 
save(self, filename)
Save the current plot commands using gnuplot's 'save' command.
source code
 
set(self, **keyw)
Set one or more settings at once from keyword arguments.
source code
 
set_boolean(self, option, value)
Set an on/off option.
source code
 
set_label(self, option, s=None, offset=None, font=None)
Set or clear a label option, which can include an offset or font.
source code
 
set_range(self, option, value)
Set a range option (xrange, yrange, trange, urange, etc.).
source code
 
set_string(self, option, s=None)
Set a string option, or if s is omitted, unset the option.
source code
 
splot(self, *items, **keyw)
Draw a new three-dimensional plot.
source code
 
title(self, s=None, offset=None, font=None)
Set the plot's title.
source code
 
xlabel(self, s=None, offset=None, font=None)
Set the plot's xlabel.
source code
 
ylabel(self, s=None, offset=None, font=None)
Set the plot's ylabel.
source code
 
zlabel(self, s=None, offset=None, font=None)
Set the plot's zlabel.
source code
Class Variables [hide private]
  terminalNr = 1
    Inherited from ThirdParty.Gnuplot._Gnuplot.Gnuplot
  optiontypes = {'output': 'string', 'parametric': 'boolean', 'p...
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, timelines, custom, showWindow=True, registry=None)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Parameters:
  • timelines (TimeLineCollection) - The timelines object
  • custom - A CustomplotInfo-object. Values in this object usually override the other options
Overrides: ThirdParty.Gnuplot._Gnuplot.Gnuplot.__init__

actualSetTitle(self, title)

source code 

Sets the title

Overrides: GeneralPlotTimelines.GeneralPlotTimelines.actualSetTitle

buildData(self, times, name, title, lastValid)

source code 

Build the implementation specific data

Parameters:
  • times - The vector of times for which data exists
  • name - the name under which the data is stored in the timeline
  • title - the title under which this will be displayed
Overrides: GeneralPlotTimelines.GeneralPlotTimelines.buildData

doHardcopy(self, filename, form)

source code 

Write the contents of the plot to disk

Parameters:
  • filename - Name of the file without type extension
  • form - String describing the format
Overrides: GeneralPlotTimelines.GeneralPlotTimelines.doHardcopy

doReplot(self)

source code 

Replot the whole data

Overrides: GeneralPlotTimelines.GeneralPlotTimelines.doReplot

preparePlot(self)

source code 

Prepare the plotting window

Overrides: GeneralPlotTimelines.GeneralPlotTimelines.preparePlot

setYLabel(self, title)

source code 

Sets the label on the first Y-Axis

Overrides: GeneralPlotTimelines.GeneralPlotTimelines.setYLabel

setYLabel2(self, title)

source code 

Sets the label on the second Y-Axis

Overrides: GeneralPlotTimelines.GeneralPlotTimelines.setYLabel2