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

Module PlotTimelinesFactory

source code

Creates subclasses of GeneralPlotTimelines

Functions [hide private]
 
createPlotTimelines(timelines, custom, implementation=None, showWindow=True, registry=None)
Creates a plotting object
source code
 
createPlotTimelinesDirect(name, timelines, persist=None, raiseit=True, with_='lines', alternateAxis=[], forbidden=[], start=None, end=None, logscale=False, ylabel=None, y2label=None, implementation=None)
Creates a plot using some prefefined values
source code
Variables [hide private]
  __package__ = 'PyFoam.Basics'
  lookupTable = {'dummy': <class 'PyFoam.Basics.DummyPlotTimelin...

Imports: CustomPlotInfo, DummyPlotTimelines, GnuplotTimelines, MatplotlibTimelines, QwtPlotTimelines, XkcdMatplotlibTimelines, configuration, error


Function Details [hide private]

createPlotTimelines(timelines, custom, implementation=None, showWindow=True, registry=None)

source code 

Creates a plotting object

Parameters:
  • timelines (TimeLineCollection) - The timelines object
  • custom - specifies how the block should look like
  • implementation - the implementation that should be used

createPlotTimelinesDirect(name, timelines, persist=None, raiseit=True, with_='lines', alternateAxis=[], forbidden=[], start=None, end=None, logscale=False, ylabel=None, y2label=None, implementation=None)

source code 

Creates a plot using some prefefined values

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
  • implementation - the implementation that should be used

Variables Details [hide private]

lookupTable

Value:
{'dummy': <class 'PyFoam.Basics.DummyPlotTimelines.DummyPlotTimelines'\
>,
 'gnuplot': <class 'PyFoam.Basics.GnuplotTimelines.GnuplotTimelines'>,
 'matplotlib': <class 'PyFoam.Basics.MatplotlibTimelines.MatplotlibTim\
elines'>,
 'qwtplot': <class 'PyFoam.Basics.QwtPlotTimelines.QwtPlotTimelines'>,
 'xkcd': <class 'PyFoam.Basics.XkcdMatplotlibTimelines.XkcdMatplotlibT\
imelines'>}