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

Class MatplotlibTimelines

source code

                               object --+    
                                        |    
GeneralPlotTimelines.GeneralPlotTimelines --+
                                            |
                                           MatplotlibTimelines

This class opens a matplotlib 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 x.__class__.__doc__ for signature
source code
 
buildData(self, times, name, title, lastValid)
Build the implementation specific data
source code
 
preparePlot(self)
Prepare the plotting window
source code
 
doReplot(self)
Replot the whole data
source code
 
actualSetTitle(self, title)
Sets the title
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
 
doHardcopy(self, filename, form)
Write the contents of the plot to disk
source code

Inherited from GeneralPlotTimelines.GeneralPlotTimelines: getNames, hasData, hasTimes, redo, setTitle

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

Class Variables [hide private]
  figureNr = 1
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 x.__class__.__doc__ for signature

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

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

preparePlot(self)

source code 

Prepare the plotting window

Overrides: GeneralPlotTimelines.GeneralPlotTimelines.preparePlot

doReplot(self)

source code 

Replot the whole data

Overrides: GeneralPlotTimelines.GeneralPlotTimelines.doReplot

actualSetTitle(self, title)

source code 

Sets the title

Overrides: GeneralPlotTimelines.GeneralPlotTimelines.actualSetTitle

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

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