shesha.widgets.widget_base.WidgetBase Class Reference

Inheritance diagram for shesha.widgets.widget_base.WidgetBase:

Collaboration diagram for shesha.widgets.widget_base.WidgetBase:

Public Member Functions
None	__init__ (self, parent=None, hide_histograms=False)
None	gui_timer_config (self, state)
None	closeEvent (self, Any event)
None	quitGUI (self, Any event=None)
def	saveArea (self, widget, filename=None)
	METHODS #. More...
def	showDock (self, name)
def	restoreMyState (self, state)
def	loadArea (self, widget=None, filename=None)
None	addConfigFromFile (self)
def	update_displayDock (self)
Dock	add_dispDock (self, str name, parent, str type="pg_image")
None	load_config (self, *args, **kwargs)
	Callback when 'LOAD' button is hit. More...
None	loadDefaultConfig (self)
None	init_config (self)
None	init_configThread (self)
None	init_configFinished (self)
None	updateDisplay (self)
def	addSHGrid (self, pg_image, valid_sub, sspsize, pitch)
None	printInPlace (self, str text)
def	run (self)

Public Attributes
	uiBase
	gui_timer
	ATTRIBUTES #. More...
	loopLock
	hide_histograms
	area
	PYQTGRAPH DockArea INIT #. More...
	gridSH
	defaultParPath
	defaultAreaPath
	disp_checkboxes
	docks
	viewboxes
	imgs
	hists
	PupilLines
	wao_phasesgroup_cb
	wao_graphgroup_cb
	wao_imagesgroup_cb
	thread

Detailed Description

Definition at line 79 of file widget_base.py.

Constructor & Destructor Documentation

__init__()

None shesha.widgets.widget_base.WidgetBase.__init__	(		self,
			parent = None,
			hide_histograms = False
	)

Definition at line 81 of file widget_base.py.

    def __init__(self, parent=None, hide_histograms=False) -> None:
        BaseClassTemplate.__init__(self, parent=parent)
 
        self.uiBase = BaseWidgetTemplate()
        self.uiBase.setupUi(self)
 
        
 
        self.gui_timer = QTimer()  # type: QTimer
        self.gui_timer.timeout.connect(self.updateDisplay)
        if self.uiBase.wao_Display.isChecked():
            self.gui_timer.start(1000. / self.uiBase.wao_frameRate.value())
        self.loopLock = threading.Lock(
        )  # type: Threading.Lock # Asynchronous loop / display safe-threading
        self.hide_histograms = hide_histograms
        
 
        self.area = DockArea()
        self.uiBase.wao_DisplayDock.setWidget(self.area)
        self.gridSH = []
 
        
        self.defaultParPath = "."
        self.defaultAreaPath = "."
        self.uiBase.wao_load_config.clicked.connect(self.load_config)
        self.uiBase.wao_loadArea.clicked.connect(self.loadArea)
        self.uiBase.wao_saveArea.clicked.connect(self.saveArea)
        self.uiBase.wao_init.clicked.connect(self.init_config)
        self.uiBase.wao_configFromFile.clicked.connect(self.addConfigFromFile)
 
        self.uiBase.wao_Display.stateChanged.connect(self.gui_timer_config)
        self.uiBase.wao_frameRate.setValue(2)
 
        self.uiBase.wao_load_config.setDisabled(False)
        self.uiBase.wao_init.setDisabled(True)
 
        self.disp_checkboxes = []
        self.docks = {}  # type: Dict[str, pg.dockarea.Dock]
        self.viewboxes = {}  # type: Dict[str, pg.ViewBox]
        self.imgs = {}  # type: Dict[str, pg.ImageItem]
        self.hists = {}  # type: Dict[str, pg.HistogramLUTItem]
 
        self.PupilLines = None
        self.adjustSize()
 

Member Function Documentation

add_dispDock()

Dock shesha.widgets.widget_base.WidgetBase.add_dispDock	(		self,
		str	name,
			parent,
		str	type = "pg_image"
	)

Reimplemented in shesha.widgets.widget_ao.widgetAOWindow, and shesha.widgets.widget_bench.widgetBenchWindow.

Definition at line 252 of file widget_base.py.

    def add_dispDock(self, name: str, parent, type: str = "pg_image") -> Dock:
        checkBox = QtGui.QCheckBox(name, parent)
        checkBox.clicked.connect(self.update_displayDock)
        checkableAction = QtGui.QWidgetAction(parent)
        checkableAction.setDefaultWidget(checkBox)
        parent.addAction(checkableAction)
        self.disp_checkboxes.append(checkBox)
 
        d = Dock(name)  # , closable=True)
        self.docks[name] = d
        if type == "pg_image":
            img = pg.ImageItem(border='w')
            self.imgs[name] = img
 
            viewbox = pg.ViewBox()
 
            viewbox.setAspectLocked(True)
            viewbox.addItem(img)  # Put image in plot area
            self.viewboxes[name] = viewbox
            iv = pg.ImageView(view=viewbox, imageItem=img)
            viewbox.invertY(False)
 
            if (self.hide_histograms):
                iv.ui.histogram.hide()
            iv.ui.histogram.autoHistogramRange()  # init levels
            iv.ui.histogram.setMaximumWidth(100)
            iv.ui.menuBtn.hide()
            iv.ui.roiBtn.hide()
            d.addWidget(iv)
        elif type == "pg_plot":
            img = pg.PlotItem(border='w')
            self.imgs[name] = img
            d.addWidget(img)
        elif type == "MPL":
            img = MatplotlibWidget()
            self.imgs[name] = img
            d.addWidget(img)
        # elif type == "SR":
        #     d.addWidget(self.uiBase.wao_Strehl)
        return d
 

Here is the call graph for this function:

addConfigFromFile()

None shesha.widgets.widget_base.WidgetBase.addConfigFromFile

(

self

)

Definition at line 234 of file widget_base.py.

        '''
        filepath = QtWidgets.QFileDialog(directory=self.defaultParPath).getOpenFileName(
                self, "Select parameter file", "",
                "parameters file (*.py);;hdf5 file (*.h5);;all files (*)")
 
        self.uiBase.wao_selectConfig.clear()
        self.uiBase.wao_selectConfig.addItem(str(filepath[0]))
 
        self.load_config(config_file=self.uiBase.wao_selectConfig.currentText())
 

Here is the call graph for this function:

addSHGrid()

def shesha.widgets.widget_base.WidgetBase.addSHGrid	(		self,
			pg_image,
			valid_sub,
			sspsize,
			pitch
	)

Definition at line 373 of file widget_base.py.

    def addSHGrid(self, pg_image, valid_sub, sspsize, pitch):
        # First remove the old grid, if any
        if self.PupilLines is not None:
            pg_image.removeItem(self.PupilLines)
 
        nssp_tot = valid_sub[0].size
        connect = np.ones((nssp_tot, 5), dtype=bool)
        connect[:, -1] = 0  # don't draw the segment between each trace
        roi_x = np.ones((nssp_tot, 5), dtype=int)
        roi_y = np.ones((nssp_tot, 5), dtype=int)
        for idx_ssp in range(nssp_tot):
            (x, y) = (valid_sub[0][idx_ssp], valid_sub[1][idx_ssp])
            roi_x[idx_ssp, :] = [x, x, x + sspsize, x + sspsize, x]
            roi_y[idx_ssp, :] = [y, y + sspsize, y + sspsize, y, y]
        self.PupilLines = PupilBoxes(roi_x, roi_y)
        pg_image.addItem(self.PupilLines)
 

Here is the caller graph for this function:

closeEvent()

None shesha.widgets.widget_base.WidgetBase.closeEvent	(		self,
		Any	event
	)

Definition at line 140 of file widget_base.py.

    def closeEvent(self, event: Any) -> None:
        self.quitGUI(event)
 

Here is the call graph for this function:

gui_timer_config()

None shesha.widgets.widget_base.WidgetBase.gui_timer_config	(		self,
			state
	)

Definition at line 133 of file widget_base.py.

    def gui_timer_config(self, state) -> None:
        self.uiBase.wao_frameRate.setDisabled(state)
        if state:
            self.gui_timer.start(1000. / self.uiBase.wao_frameRate.value())
        else:
            self.gui_timer.stop()
 

init_config()

None shesha.widgets.widget_base.WidgetBase.init_config

(

self

)

Reimplemented in shesha.widgets.widget_ao.widgetAOWindow, shesha.widgets.widget_bench.widgetBenchWindow, and shesha.widgets.widget_canapass.widgetCanapassWindowPyro.

Definition at line 348 of file widget_base.py.

    def init_config(self) -> None:
        self.loopLock.acquire(True)
        self.uiBase.wao_load_config.setDisabled(True)
        self.uiBase.wao_init.setDisabled(True)
        self.thread = WorkerThread(self.init_configThread)
        self.thread.finished.connect(self.init_configFinished)
        self.thread.start()
 

init_configFinished()

None shesha.widgets.widget_base.WidgetBase.init_configFinished

(

self

)

Reimplemented in shesha.widgets.widget_ao.widgetAOWindow, and shesha.widgets.widget_bench.widgetBenchWindow.

Definition at line 359 of file widget_base.py.

    def init_configFinished(self) -> None:
        self.uiBase.wao_load_config.setDisabled(False)
        self.uiBase.wao_init.setDisabled(False)
        self.loopLock.release()
 

init_configThread()

None shesha.widgets.widget_base.WidgetBase.init_configThread

(

self

)

Reimplemented in shesha.widgets.widget_ao.widgetAOWindow, shesha.widgets.widget_bench.widgetBenchWindow, and shesha.widgets.widget_canapass.widgetCanapassWindowPyro.

Definition at line 356 of file widget_base.py.

    def init_configThread(self) -> None:
        pass
 

load_config()

None shesha.widgets.widget_base.WidgetBase.load_config	(		self,
		*	args,
		**	kwargs
	)

Callback when 'LOAD' button is hit.

Definition at line 296 of file widget_base.py.

        '''
        for groupbox in [
                self.uiBase.wao_phasesgroup_tb, self.uiBase.wao_imagesgroup_tb,
                self.uiBase.wao_graphgroup_tb
        ]:
            layout = groupbox.menu()
            while layout and not layout.isEmpty():
                w = layout.children()[0]
                layout.removeAction(w)
                w.setParent(None)
        self.disp_checkboxes.clear()
 
        # TODO: remove self.imgs, self.viewboxes and self.docks children
        for _, dock in self.docks.items():
            if dock.isVisible():
                dock.close()
 
        self.docks.clear()
        self.imgs.clear()
        self.viewboxes.clear()
 
        self.wao_phasesgroup_cb = QtGui.QMenu(self)
        self.uiBase.wao_phasesgroup_tb.setMenu(self.wao_phasesgroup_cb)
        self.uiBase.wao_phasesgroup_tb.setText('Select')
        self.uiBase.wao_phasesgroup_tb.setPopupMode(QtWidgets.QToolButton.InstantPopup)
 
        self.wao_graphgroup_cb = QtGui.QMenu(self)
        self.uiBase.wao_graphgroup_tb.setMenu(self.wao_graphgroup_cb)
        self.uiBase.wao_graphgroup_tb.setText('Select')
        self.uiBase.wao_graphgroup_tb.setPopupMode(QtWidgets.QToolButton.InstantPopup)
 
        self.uiBase.wao_imagesgroup_tb.setText('Select')
        self.wao_imagesgroup_cb = QtGui.QMenu(self)
        self.uiBase.wao_imagesgroup_tb.setMenu(self.wao_imagesgroup_cb)
        self.uiBase.wao_imagesgroup_tb.setPopupMode(QtWidgets.QToolButton.InstantPopup)
 
        # self.uiBase.wao_init.setDisabled(False)
        #
        # if (hasattr(self.sim.config, "layout")):
        #     area_filename = self.defaultAreaPath + "/" + self.sim.config.layout + ".area"
        #     self.loadArea(filename=area_filename)
        #
        # self.adjustSize()
 

Here is the caller graph for this function:

loadArea()

def shesha.widgets.widget_base.WidgetBase.loadArea	(		self,
			widget = None,
			filename = None
	)

Definition at line 197 of file widget_base.py.

    def loadArea(self, widget=None, filename=None):
        # close all docks
        for disp_checkbox in self.disp_checkboxes:
            disp_checkbox.setChecked(False)
        for dock in self.docks.values():
            if dock.isVisible():
                dock.close()
 
        if filename is None:
            filepath = QtWidgets.QFileDialog(
                    directory=self.defaultAreaPath).getOpenFileName(
                            self, "Select area layout file", "",
                            "area layout file (*.area);;all files (*)")
            filename = filepath[0]
 
        try:
            with open(filename, "r") as f:
                st = eval(f.readline())
 
                # restore docks from main area
                if st['main'] is not None:
                    self.restoreMyState(st["main"])
 
                # restore docks from floating area
                for win in st["float"]:
                    self.restoreMyState(win[0]['main'])
 
                # rearange dock s as in stored state
                self.area.restoreState(st)
        except FileNotFoundError as err:
            warnings.warn(filename + "not loaded: " + err)
 

Here is the call graph for this function:

Here is the caller graph for this function:

loadDefaultConfig()

None shesha.widgets.widget_base.WidgetBase.loadDefaultConfig

(

self

)

Definition at line 340 of file widget_base.py.

    def loadDefaultConfig(self) -> None:
        import glob
        parlist = sorted(glob.glob(self.defaultParPath + "/*.py"))
        self.uiBase.wao_selectConfig.clear()
        self.uiBase.wao_selectConfig.addItems([
                parlist[i].split('/')[-1] for i in range(len(parlist))
        ])
 

Here is the call graph for this function:

printInPlace()

None shesha.widgets.widget_base.WidgetBase.printInPlace	(		self,
		str	text
	)

Definition at line 390 of file widget_base.py.

    def printInPlace(self, text: str) -> None:
        # This seems to trigger the GUI and keep it responsive
        print(text, end='\r', flush=True)
 

Here is the caller graph for this function:

quitGUI()

None shesha.widgets.widget_base.WidgetBase.quitGUI	(		self,
		Any	event = None
	)

Definition at line 143 of file widget_base.py.

    def quitGUI(self, event: Any = None) -> None:
        reply = QtWidgets.QMessageBox.question(
                self, 'Message', "Are you sure to quit?", QtWidgets.QMessageBox.Yes |
                QtWidgets.QMessageBox.No, QtWidgets.QMessageBox.No)
 
        if reply == QtWidgets.QMessageBox.Yes:
            if event:
                event.accept()
            quit()
        else:
            if event:
                event.ignore()
 

Here is the caller graph for this function:

restoreMyState()

def shesha.widgets.widget_base.WidgetBase.restoreMyState	(		self,
			state
	)

Definition at line 188 of file widget_base.py.

    def restoreMyState(self, state):
        typ, contents, _ = state
 
        if typ == 'dock':
            self.showDock(contents)
        else:
            for o in contents:
                self.restoreMyState(o)
 

Here is the call graph for this function:

Here is the caller graph for this function:

run()

def shesha.widgets.widget_base.WidgetBase.run

(

self

)

Reimplemented in shesha.widgets.widget_ao.widgetAOWindow, and shesha.widgets.widget_bench.widgetBenchWindow.

Definition at line 394 of file widget_base.py.

    def run(self):
        self.loop_once()
        if not self.stop:
            QTimer.singleShot(0, self.run)  # Update loop
 
 

Here is the call graph for this function:

Here is the caller graph for this function:

saveArea()

def shesha.widgets.widget_base.WidgetBase.saveArea	(		self,
			widget,
			filename = None
	)

METHODS #.

Definition at line 165 of file widget_base.py.

        '''
        if filename is None:
            filepath = QtWidgets.QFileDialog(
                    directory=self.defaultAreaPath).getSaveFileName(
                            self, "Select area layout file", "",
                            "area layout file (*.area);;all files (*)")
            filename = filepath[0]
 
        try:
            with open(filename, "w+") as f:
                st = self.area.saveState()
                f.write(str(st))
        except FileNotFoundError as err:
            warnings.warn(filename + " not loaded: " + err)
 

showDock()

def shesha.widgets.widget_base.WidgetBase.showDock	(		self,
			name
	)

Definition at line 180 of file widget_base.py.

    def showDock(self, name):
        for disp_checkbox in self.disp_checkboxes:
            if disp_checkbox.text() == name:
                disp_checkbox.setChecked(True)
                break
        if name in self.docks.keys():
            self.area.addDock(self.docks[name])
 

Here is the caller graph for this function:

update_displayDock()

def shesha.widgets.widget_base.WidgetBase.update_displayDock

(

self

)

Definition at line 244 of file widget_base.py.

    def update_displayDock(self):
        guilty_guy = self.sender().text()
        state = self.sender().isChecked()
        if state:
            self.area.addDock(self.docks[guilty_guy])
        elif self.docks[guilty_guy].isVisible():
            self.docks[guilty_guy].close()
 

Here is the caller graph for this function:

updateDisplay()

None shesha.widgets.widget_base.WidgetBase.updateDisplay

(

self

)

Reimplemented in shesha.widgets.widget_ao.widgetAOWindow, and shesha.widgets.widget_bench.widgetBenchWindow.

Definition at line 364 of file widget_base.py.

    def updateDisplay(self) -> None:
        if not self.loopLock.acquire(False):
            return
        else:
            try:
                pass
            finally:
                self.loopLock.release()
 

Here is the caller graph for this function:

Member Data Documentation

area

shesha.widgets.widget_base.WidgetBase.area

PYQTGRAPH DockArea INIT #.

Definition at line 102 of file widget_base.py.

defaultAreaPath

shesha.widgets.widget_base.WidgetBase.defaultAreaPath

Definition at line 111 of file widget_base.py.

defaultParPath

shesha.widgets.widget_base.WidgetBase.defaultParPath

            CONNECTED BUTTONS                         #

Default path for config files

Definition at line 110 of file widget_base.py.

disp_checkboxes

shesha.widgets.widget_base.WidgetBase.disp_checkboxes

Definition at line 124 of file widget_base.py.

docks

shesha.widgets.widget_base.WidgetBase.docks

Definition at line 125 of file widget_base.py.

gridSH

shesha.widgets.widget_base.WidgetBase.gridSH

Definition at line 104 of file widget_base.py.

gui_timer

shesha.widgets.widget_base.WidgetBase.gui_timer

ATTRIBUTES #.

Definition at line 91 of file widget_base.py.

hide_histograms

shesha.widgets.widget_base.WidgetBase.hide_histograms

Definition at line 97 of file widget_base.py.

hists

shesha.widgets.widget_base.WidgetBase.hists

Definition at line 128 of file widget_base.py.

imgs

shesha.widgets.widget_base.WidgetBase.imgs

Definition at line 127 of file widget_base.py.

loopLock

shesha.widgets.widget_base.WidgetBase.loopLock

Definition at line 95 of file widget_base.py.

PupilLines

shesha.widgets.widget_base.WidgetBase.PupilLines

Definition at line 130 of file widget_base.py.

thread

shesha.widgets.widget_base.WidgetBase.thread

Definition at line 352 of file widget_base.py.

uiBase

shesha.widgets.widget_base.WidgetBase.uiBase

Definition at line 84 of file widget_base.py.

viewboxes

shesha.widgets.widget_base.WidgetBase.viewboxes

Definition at line 126 of file widget_base.py.

wao_graphgroup_cb

shesha.widgets.widget_base.WidgetBase.wao_graphgroup_cb

Definition at line 322 of file widget_base.py.

wao_imagesgroup_cb

shesha.widgets.widget_base.WidgetBase.wao_imagesgroup_cb

Definition at line 328 of file widget_base.py.

wao_phasesgroup_cb

shesha.widgets.widget_base.WidgetBase.wao_phasesgroup_cb

Definition at line 317 of file widget_base.py.

---

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

• widget_base.py