diaGrabber.plot

Gui

class diaGrabber.plot.Gui.Gui(matrixClass, **kwargs)

This class provides a graphical frontend for viewing n-dimensional targets. Since it’s only possible to visualize exact either n mergeDimensions over one basisDimension (2d-graph) or one mergeDimension over two basisDimensions (merge coded als contrast/color) without deforming the values in the figure only at max. two basisDimensions are shown. All other basisDimensions were conentrated. By default all merge-values over that dimensions werde middled.

In this class you have many options to choose which basis to show and in which way to concentrate other basisDimensions. It is also possible to slice a target and to view another basis.

Each parameter and each botton controling the view is described in diaGrabber.plot._preferenceDock.preferenceDock.

Though it’s possible to customize the Gui you can also preconfigure the Gui by setting keyword-arguments when initializing the class.

For a list of all possible keyword-arguments have a look at setArgs()

plot(**kwargs)

For a list of all possible Keyword-arguments have a look at setArgs()

save(**kwargs)

Optional kwargs (“keyword arguments”) are:

Keyword	Type	Default	Description
mergeName	string	[{All}]	names of merges to save
name	string	“”	name-prefix of the image
type	string	“png”	typ of the image [“png”,”jpg”,”tiff”,”svg”]
parameters	list	[]	takes all parameters accepted by pyQtGraph.exporters

setArgs(**kwargs)

Optional kwargs (“keyword arguments”) are:

Keyword	Type	Default	Description
interactive	bool	False	[True, False]
show	list	[{All}]	a list of lists containing names of merge-(m) and basisDimensions(b) to show e.g. show = [ (m1,b1,b2), (m2,b2) ]
fps	float	20	frames per seconds
lps	float	None	readout n lines from source per second (needs limitReadoutRate = True)
limitReadoutRate	bool	False	Choose whether to limit the readoutrate via arg lps
enableAutoRange	list	[]	[“x”, “y”]
colorTheme	string	“default”	[“default”, “bright”]
windowSize	list	[1000,600]	[size_x, size_y]
showPreferences	bool	True	[True, False]
closeWhenFinished	bool	False	[True, False] Choose whether to close the plot-window when fillInteractive() is done
save	dict	{}	can include all keywords from the method ‘save’

preferenceDock

The classes in this module were not controlled or called by the user itself. Only diaGrabber.plot.Gui.Gui controll calls it. Nethertheless most methods are described and viewable in the API.

class diaGrabber.plot._preferenceDock.ConcentrateOpt(n, display, b, concBasisDict, **opts)

class to handle all concentrated basisDimensions

changeAsTime()

changeMax()

changeMean()

changeMin()

changePlotRangeToPosition()

changeSum()

setPAsTime()

the parameter ‘as time’ is only visible if 2 basisDimensions are active (in case of a plotted image)

class diaGrabber.plot._preferenceDock.addContentOf(prefTab, display, **opts)

whith the class plotMergeDims it’s possible to plot merges together over the same basis. in case a display needs other merges with a different base it can be added trough this class.

change2dPlotList()

change2dPlots()

get2dPlotDisplays()

get a name of all displays having only one basis exclude displays with imageplots to prevent a staple of images

class diaGrabber.plot._preferenceDock.mainTab(prefDock)

class for the main-Tab

restoreWidgetLayout()

Restore widget-layout from ‘self.stateWidgetLayout’ or (in case ‘Restore from file’ is active) from file.

saveWidgetLayout()

save the state of the widgetlayout to ‘self.stateWidgetLayout’ and (in case ‘’Save to file’ is active) in file.

class diaGrabber.plot._preferenceDock.plotBasisDims(prefTab, display, **opts)

addConcentrateOpt(n, b)

addPlotRange(n, b)

changePlotRangeFrom()

changePlotRangeStep()

changePlotRangeTo()

changePlotStatus()

class diaGrabber.plot._preferenceDock.plotMergeDims(prefTab, display, **opts)

changeAsDensity()

changePlotMerge()

class diaGrabber.plot._preferenceDock.preferenceDock(Gui)

main-class for the whole preference-dock-system

addPrefTab(display)

add a tab owned by its display

addToArea()

append parameterTree-instance to dockarea

build(preferences_size)

does:

• add mainTab
• add preferenceTab for each display
• add the pref.Dock to the gui
• save the widget-layout

createNewDisplay()

• ask Gui to create a new display
• add a new pref.Tab for it
• save the new layout

removeTab(tab)

remove a pref.Tab from the preferenceDock, save widget-layout

class diaGrabber.plot._preferenceDock.preferenceTab(display, prefDock)

the preference tab that belongs to each Display

printChange(param, changes)

If anything changes in the tree, print a message

remove()

remove a display and it’s appendant preferenceTab

showTabOnClick()

show the related preference-tab if the mouse click on the viewBox of a display. this is done trough manipluating the ‘mouseClickEvent’-routine of the viewBox of the display.

class diaGrabber.plot._preferenceDock.readoutPlotRates(Gui, **opts)

in case of an interactive plotted readout of the sources this class provides the parameters to change the plotrate (frames per second) and the readoutrate (lines per second)

changeFPS()

changeLPS()

changeLimitReadoutRate()

changeReadoutEveryNLine()

class diaGrabber.plot._preferenceDock.saveRestorePrefs(prefTab, **opts)

save/restore parameters in the preferenceTab

restorePreferences(sgn, state=None, add_missing_remove_extra=None)

savePreferences()

class diaGrabber.plot._preferenceDock.sliceImage(prefTab, display, **opts)

changeActivate()

changeWhichBasis()

changeWhichDisplay()

getAvDisplays()

get the name of all other displays than the own one

getShowBasis()

get the name of all inactive/concentrated basisDimensions

class diaGrabber.plot._preferenceDock.viewOptions(prefTab, display, **opts)

this class includes all otions manipulating the view of the display

changeAutoRangeX()

changeAutoRangeY()

changeCrosshair()

changeLockAspect()

changePlotOverlay()

changePoiClean()

changePoiShowOnlyMerge()

changeTransposeAxes()

setToDefault()