Plotter Class Reference

This is a helper class which helps with plotting functions to a pdf file. More...

Inheritance diagram for Plotter:

Collaboration diagram for Plotter:

Public Member Functions
def	start_pdf (self)
	Initialize a new pdf file. More...
def	close_pdf (self)
	Saves the pdf file to disc after all plots are finished.
def	finish_plot (self)
	Adds the current plot to the pdf file.
def	figureLegendRight (self, ylabel, title, n)
	Creates a new plot with figure legend right of the plot. More...
def	plot (self, time, data, kwargs)
	Wraps matplotlibs plot function. More...
Public Member Functions inherited from OutputManager
def	__init__ (self, args, kwargs)
	Arguments are passed through to OptionsManager.
def	runmodes (self, section=None)
	Return runmodes. More...
def	output (self, runmode, section=None, statefile=False)
	The name of the output file for a given runmode. More...
def	clean (self, runmode)
	Delete the trajectory file and state file for a given runmode. More...
Public Member Functions inherited from OptionsManager
def	__init__ (self, options, cp)
def	get_option (self, name, default=None, required=False, section=None)
	Get configuration file keys in a safe way. More...

Additional Inherited Members
Public Attributes inherited from OutputManager
	outputdir
	All output files end up here. More...
	expecteddir
	Where to look for pre-run simulations to compare test runs to. More...
Public Attributes inherited from OptionsManager
	options
	optparse.Values: command line options
	cp
	ConfigParser: configuration file keys.
	test
	The name of the current test.

Detailed Description

This is a helper class which helps with plotting functions to a pdf file.

If the global variable plot is False, all functions are a no-op.

Definition at line 555 of file testdriver.py.

Member Function Documentation

def figureLegendRight	(		self,
			ylabel,
			title,
			n
	)

Creates a new plot with figure legend right of the plot.

Parameters

ylabel	The label of the y axis.
title	The title of the plot
n	The value number.

Definition at line 589 of file testdriver.py.

def plot	(		self,
			time,
			data,
			kwargs
	)

Wraps matplotlibs plot function.

Parameters

time	An array of time values.
data	An array of data values.
**kwargs	These are passed to matplotlib.plot.

Definition at line 612 of file testdriver.py.

def start_pdf

(

self

)

Initialize a new pdf file.

The file is read from the configuration key pdf.

Definition at line 564 of file testdriver.py.

---

The documentation for this class was generated from the following file:

• Testing/testdriver.py