PyFoam.Basics.GnuplotTimelines module

Plots a collection of timelines

class PyFoam.Basics.GnuplotTimelines.GnuplotTimelines(timelines, custom, terminal='x11', showWindow=True, registry=None)

Bases: PyFoam.Basics.GeneralPlotTimelines.GeneralPlotTimelines, PyFoam.ThirdParty.Gnuplot._Gnuplot.Gnuplot

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

__init__(timelines, custom, terminal='x11', showWindow=True, registry=None)

Parameters:

• timelines (TimeLineCollection) – The timelines object
• custom – A CustomplotInfo-object. Values in this object usually override the

other options. If the object has an attribute named gnuplotCommands (which is assumed to be a string list) then these strings are executed during initialization of the plot (the purpose of this is to set non-standard stuff) :param terminal: terminal implementation to use

__module__ = 'PyFoam.Basics.GnuplotTimelines'

actualSetTitle(title)

Sets the title

buildData(times, name, title, lastValid)

Build the implementation specific data :param times: The vector of times for which data exists :param name: the name under which the data is stored in the timeline :param title: the title under which this will be displayed

doHardcopy(filename, form, termOpts='')

Write the contents of the plot to disk :param filename: Name of the file without type extension :param form: String describing the format

doReplot()

Replot the whole data

internalHardcopy(terminal, filename)

Emulate the regular hardcopy command

preparePlot()

Prepare the plotting window

setYLabel(title)

Sets the label on the first Y-Axis

setYLabel2(title)

Sets the label on the second Y-Axis

terminalNr = 1

PyFoam.Basics.GnuplotTimelines.validTerminals()

Returns a list with the valid Gnuplot terminals