pdfGenWREB.PDF Class Reference

PDF generation class for reports. More...

Inheritance diagram for pdfGenWREB.PDF:

Public Member Functions
def	header (self)
	Adds a LSST/SLAC header and title to every page. More...
def	footer (self)
	Adds page numbers to every page. More...
def	testTitle (self, title)
	Generic title function for tests. More...
def	summaryPage (self, boardID, boardType, linkVersion, FPGAVersion, scriptVersion, startTime, testList, passList, statsList)
	Generate a summary page for the tests that were run. More...
def	columnTable (self, colData, ROI=None, colHeaders=None, fontSize=8, width=1.0, widthArray=None, align="L")
	Generates a table from a list of lists of column data. More...
def	addPlotPage (self, title, imgName, imgSize=1.0)
	Adds a page for tests with outputs consisting only of an image/plot. More...
def	idleCurrent (self, title, voltages, currents)
	Idle current generation test, will be moved to WREBTest.py soon. More...
def	residualTest (self, title, datas, residuals, passed, stats, ROI=None, imgSize=0.7, xdat=None, pltRange=None)
	Report page for tests that consist of a single residual plot, including comments and pass/fail. More...
def	makeResidualPlotPage (self, title, imgName, datas, residuals, ROI=None, imgSize=1.0, xdat=None, pltRange=None)
	Generates the new page and plot for the residual tests. More...
def	makePlotPage (self, title, imgName, datas, imgSize=1.0, xdat=None)
	Generates the new page and plot for the non-residual tests. More...
def	passFail (self, passed)
	Return color-coded pass/fail result. More...

Detailed Description

PDF generation class for reports.

Member Function Documentation

def pdfGenWREB.PDF.addPlotPage	(		self,
			title,
			imgName,
			imgSize = 1.0
	)

Adds a page for tests with outputs consisting only of an image/plot.

Parameters

title	Title of test on page
imgName	File to save plot as
imgSize	Optional, percent of page width image should take up; defaults to 1.0

def pdfGenWREB.PDF.columnTable	(		self,
			colData,
			ROI = None,
			colHeaders = None,
			fontSize = 8,
			width = 1.0,
			widthArray = None,
			align = "L"
	)

Generates a table from a list of lists of column data.

Parameters

colData	Tuple of column information as ([data], header) to be put in a column, from left to right.
ROI	Optional parameter of [low, high] index of cells to be highlighted as a region of interest.
colHeaders	Optional list of headers for columns; if specified, colData is expected as ([data],[data],...)
fontSize	Optional font size for the table.
width	Percent of page width the table should occupy.
widthArray	Non-normalized list of relative column widths. Defaults to every column having equal width.
align	Align as left ("L"), center ("C"), right ("R")

def pdfGenWREB.PDF.footer

(

self

)

Adds page numbers to every page.

def pdfGenWREB.PDF.header

(

self

)

Adds a LSST/SLAC header and title to every page.

def pdfGenWREB.PDF.idleCurrent	(		self,
			title,
			voltages,
			currents
	)

Idle current generation test, will be moved to WREBTest.py soon.

Parameters

title	Title of test on page
voltages	List of (category title, [voltages])
currents	List of (category title, [currents])

def pdfGenWREB.PDF.makePlotPage	(		self,
			title,
			imgName,
			datas,
			imgSize = 1.0,
			xdat = None
	)

Generates the new page and plot for the non-residual tests.

Parameters

title	Title of test on page
imgName	Title of temporary plot image
datas	Zipped data arrays and legend titles
imgSize	Optional, percent of page width image should take up; defaults to 1.0
xdat	Optional zipped array of x values and titles. Defaults to iteration values.

def pdfGenWREB.PDF.makeResidualPlotPage	(		self,
			title,
			imgName,
			datas,
			residuals,
			ROI = None,
			imgSize = 1.0,
			xdat = None,
			pltRange = None
	)

Generates the new page and plot for the residual tests.

Parameters

title	Title of test on page
imgName	Title of temporary plot image
datas	Zipped data arrays and legend titles
residuals	Zipped array of residuals and legend titles
ROI	Optional parameter specifying region of interest in the plot
imgSize	Optional, percent of page width image should take up; defaults to 1.0
xdat	Optional zipped array of x values and titles. Defaults to iteration values.
pltRange	Optional specified plot range.

def pdfGenWREB.PDF.passFail	(		self,
			passed
	)

Return color-coded pass/fail result.

Parameters

passed

String of either "PASS" or "FAIL"

def pdfGenWREB.PDF.residualTest	(		self,
			title,
			datas,
			residuals,
			passed,
			stats,
			ROI = None,
			imgSize = 0.7,
			xdat = None,
			pltRange = None
	)

Report page for tests that consist of a single residual plot, including comments and pass/fail.

Parameters

title	Title of test on page and title of temporary plot image
datas	Zipped data arrays and legend titles
residuals	Zipped array of residuals and legend titles
passed	Pass/fail result of test
stats	Relevant comments from the test
ROI	Optional parameter specifying region of interest in the plot
imgSize	Optional, percent of page width image should take up; defaults to 1.0
xdat	Optional zipped array of x values and titles. Defaults to iteration values.
pltRange	Optional specified plot range.

def pdfGenWREB.PDF.summaryPage	(		self,
			boardID,
			boardType,
			linkVersion,
			FPGAVersion,
			scriptVersion,
			startTime,
			testList,
			passList,
			statsList
	)

Generate a summary page for the tests that were run.

Parameters

boardID	Serial number of the board that is tested
boardType	Type of phsyical board model
linkVersion	Version of link software
FPGAVersion	Front-end FPGA code version
scriptVersion	Version of the script, given by the last modified date YY.MM.DD.hh.mm.ss
testList	List of test titles that were run
passList	List of test results
statsList	List of relevant statistics returned from the tests

def pdfGenWREB.PDF.testTitle	(		self,
			title
	)

Generic title function for tests.

---

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

• pdfGenWREB.py