Source code for lavuelib.bkgSubtractionWidget
# Copyright (C) 2017 DESY, Christoph Rosemann, Notkestr. 85, D-22607 Hamburg
#
# lavue is an image viewing program for photon science imaging detectors.
# Its usual application is as a live viewer using hidra as data source.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation in version 2
# of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor,
# Boston, MA 02110-1301, USA.
#
# Authors:
# Christoph Rosemann <christoph.rosemann@desy.de>
# Jan Kotanski <jan.kotanski@desy.de>
#
""" background subtraction widget """
from .qtuic import uic
from pyqtgraph import QtCore, QtGui
try:
from pyqtgraph import QtWidgets
except Exception:
from pyqtgraph import QtGui as QtWidgets
import os
_formclass, _baseclass = uic.loadUiType(
os.path.join(os.path.dirname(os.path.abspath(__file__)),
"ui", "BkgSubtractionWidget.ui"))
[docs]class BkgSubtractionWidget(QtWidgets.QWidget):
"""
Define bkg image and subtract from displayed image.
"""
#: (:class:`pyqtgraph.QtCore.pyqtSignal`) bkg file selected signal
bkgFileSelected = QtCore.pyqtSignal(str)
#: (:class:`pyqtgraph.QtCore.pyqtSignal`) use current image signal
useCurrentImageAsBkg = QtCore.pyqtSignal()
#: (:class:`pyqtgraph.QtCore.pyqtSignal`) apply state change signal
applyStateChanged = QtCore.pyqtSignal(int)
#: (:class:`pyqtgraph.QtCore.pyqtSignal`) bkg scaling factor change signal
bkgScalingFactorChanged = QtCore.pyqtSignal()
def __init__(self, parent=None, settings=None):
""" constructor
:param parent: parent object
:type parent: :class:`pyqtgraph.QtCore.QObject`
:param settings: lavue configuration settings
:type settings: :class:`lavuelib.settings.Settings`
"""
QtWidgets.QWidget.__init__(self, parent)
#: (:class:`Ui_BkgSubtractionkWidget') ui_widget object from qtdesigner
self.__ui = _formclass()
self.__ui.setupUi(self)
#: (:class:`lavuelib.settings.Settings`) settings
self.__settings = settings
self.__ui.selectPushButton.clicked.connect(self._showImageSelection)
self.__ui.selectCurrentPushButton.hide()
self.__ui.selectCurrentPushButton.clicked.connect(self._useCurrent)
self.__ui.selectFilePushButton.hide()
self.__ui.selectFilePushButton.clicked.connect(self._showFileDialog)
self.__ui.applyBkgCheckBox.clicked.connect(
self._emitApplyStateChanged)
if QtGui.QIcon.hasThemeIcon("document-open"):
icon = QtGui.QIcon.fromTheme("document-open")
self.__ui.selectPushButton.setIcon(icon)
self.__ui.dfsfLineEdit.textChanged.connect(
self._emitBkgScalingFactorChanged)
if QtGui.QIcon.hasThemeIcon("document-open"):
icon = QtGui.QIcon.fromTheme("document-open")
self.__ui.selectPushButton.setIcon(icon)
[docs] def setBkgScalingFactor(self, scale):
""" sets the background scaling factor
:param scale: background scaling factor
:type scale: :obj:`float` or :obj:`str`
"""
self.__ui.dfsfLineEdit.setText(str(scale if scale is not None else ""))
[docs] def bkgScalingFactor(self):
""" provides background scaling factor
:returns: background scaling factor
:rtype: :obj:`float`
"""
try:
scale = float(self.__ui.dfsfLineEdit.text())
except Exception:
scale = None
return scale
@QtCore.pyqtSlot()
def _emitBkgScalingFactorChanged(self):
""" emits bkg scaling factor chnaged
"""
self.bkgScalingFactorChanged.emit()
@QtCore.pyqtSlot(bool)
def _emitApplyStateChanged(self, state):
""" emits state of apply button
:param state: apply button state
:type state: :obj:`bool`
"""
self.applyStateChanged.emit(int(state))
@QtCore.pyqtSlot()
def _showFileDialog(self):
""" shows file dialog and select the file name
"""
fileDialog = QtWidgets.QFileDialog()
fileout = fileDialog.getOpenFileName(
self, 'Open file', self.__settings.bkgimagename or '.')
if isinstance(fileout, tuple):
fileName = str(fileout[0])
else:
fileName = str(fileout)
if fileName:
self.__settings.bkgimagename = fileName
self.setDisplayedName(self.__settings.bkgimagename)
self.bkgFileSelected.emit(self.__settings.bkgimagename)
self.__hideImageSelection()
[docs] def setBackground(self, fname):
""" sets the image background
:param fname: file name
:type fname: :obj:`str`
"""
self.__settings.bkgimagename = fname
self.setDisplayedName(fname)
self.bkgFileSelected.emit(fname)
self.__ui.applyBkgCheckBox.setChecked(True)
self.applyStateChanged.emit(2)
@QtCore.pyqtSlot()
def _useCurrent(self):
""" emits useCurrentImageAsBkg and hides image selection
"""
self.useCurrentImageAsBkg.emit()
self.__hideImageSelection()
[docs] def setDisplayedName(self, name):
""" sets displayed file name
:param name: file name
:type name: :obj:`str`
"""
if name == "":
self.__ui.fileLabel.setText("no Image selected")
self.__ui.applyBkgCheckBox.setEnabled(False)
else:
self.__ui.fileLabel.setText("..." + str(name)[-24:])
self.__ui.applyBkgCheckBox.setEnabled(True)
@QtCore.pyqtSlot()
def _showImageSelection(self):
""" shows image selection
"""
self.__ui.selectCurrentPushButton.show()
self.__ui.selectFilePushButton.show()
self.__ui.selectPushButton.hide()
[docs] @QtCore.pyqtSlot()
def showScalingFactors(self, show=True):
if show:
self.__ui.dfsfWidget.show()
else:
self.__ui.dfsfWidget.hide()
def __hideImageSelection(self):
""" hides image selection
"""
self.__ui.selectCurrentPushButton.hide()
self.__ui.selectFilePushButton.hide()
self.__ui.selectPushButton.show()
[docs] def checkBkgSubtraction(self, state):
""" unchecks apply CheckBox if state is 1 and it is checked
and reset the display
:param state: checkbox state
:type state: :obj:`int`
"""
if not state and self.__ui.applyBkgCheckBox.isChecked():
self.__ui.applyBkgCheckBox.setChecked(False)
self.setDisplayedName("")
[docs] def isBkgSubApplied(self):
""" if background subtraction applied
:returns: apply status
:rtype: :obj:`bool`
"""
return self.__ui.applyBkgCheckBox.isChecked()
if __name__ == "__main__":
import sys
app = QtWidgets.QApplication(sys.argv)
myapp = BkgSubtractionWidget()
myapp.show()
sys.exit(app.exec_())