Source code for sas.qtgui.Perspectives.Fitting.MultiConstraint

"""
Widget for parameter constraints.
"""
import os
import webbrowser

# numpy methods required for the validator! Don't remove.
# pylint: disable=unused-import,unused-wildcard-import,redefined-builtin
from numpy import *

from PyQt5 import QtWidgets
from PyQt5 import QtCore

import sas.qtgui.Utilities.GuiUtils as GuiUtils

# Local UI
from sas.qtgui.Perspectives.Fitting.UI.MultiConstraintUI import Ui_MultiConstraintUI

[docs]class MultiConstraint(QtWidgets.QDialog, Ui_MultiConstraintUI): """ Logic class for interacting with MultiConstrainedUI view """
[docs] def __init__(self, parent=None, params=None, constraint=None): """ parent: ConstraintWidget object params: tuple of strings describing model parameters """ super(MultiConstraint, self).__init__(parent) self.setupUi(self) self.setModal(True) # disable the context help icon windowFlags = self.windowFlags() self.setWindowFlags(windowFlags & ~QtCore.Qt.WindowContextHelpButtonHint) self.params = params self.parent = parent # Text of the constraint self.function = None # Should this constraint be validated? self.validate = True self.input_constraint = constraint if self.input_constraint is not None: variable = constraint.value self.function = constraint.func self.params.append(variable) self.model_name = constraint.value_ex # Passed constraint may be too complex for simple validation self.validate = constraint.validate else: self.model_name = self.params[1] self.setupLabels() self.setupTooltip() # Set param text control to the second parameter passed if self.input_constraint is None: self.txtConstraint.setText(self.params[1]) else: self.txtConstraint.setText(self.function) self.cmdOK.clicked.connect(self.accept) self.cmdHelp.clicked.connect(self.onHelp) self.cmdRevert.clicked.connect(self.revert) self.txtConstraint.editingFinished.connect(self.validateFormula) # Default focus is on OK self.cmdOK.setFocus()
[docs] def revert(self): """ Swap parameters in the view """ # Switch parameters self.params[1], self.params[0] = self.params[0], self.params[1] # change fully qualified param name (e.g. M1.sld -> M1.sld_solvent) self.model_name = self.model_name.replace(self.params[0], self.params[1]) # Try to swap parameter names in the line edit current_text = self.txtConstraint.text() new_text = current_text.replace(self.params[0], self.params[1]) self.txtConstraint.setText(new_text) # Update labels and tooltips self.setupLabels() self.setupTooltip()
[docs] def setupLabels(self): """ Setup labels based on current parameters """ l1 = str(self.params[0]) l2 = str(self.params[1]) self.txtParam1.setText(l1) self.txtParam1_2.setText(l1) self.txtParam2.setText(l2)
[docs] def setupTooltip(self): """ Tooltip for txtConstraint """ tooltip = "E.g.\n%s = 2.0 * (%s)\n" %(self.params[0], self.params[1]) tooltip += "%s = sqrt(%s) + 5"%(self.params[0], self.params[1]) self.txtConstraint.setToolTip(tooltip)
[docs] def validateFormula(self): """ Add visual cues when formula is incorrect """ # Don't validate if requested if not self.validate: return formula_is_valid = False formula_is_valid = self.validateConstraint(self.txtConstraint.text()) if not formula_is_valid: self.cmdOK.setEnabled(False) self.txtConstraint.setStyleSheet("QLineEdit {background-color: red;}") else: self.cmdOK.setEnabled(True) self.txtConstraint.setStyleSheet("QLineEdit {background-color: white;}")
[docs] def validateConstraint(self, constraint_text): """ Ensure the constraint has proper form """ # 0. none or empty if not constraint_text or not isinstance(constraint_text, str): return False param_str = self.model_name # 1. just the parameter if param_str == constraint_text: return True # 2. ensure the text contains parameter name parameter_string_start = constraint_text.find(param_str) if parameter_string_start < 0: return False parameter_string_end = parameter_string_start + len(param_str) # 3. parameter name should be a separate word, but can have "()[]*+-/ " around #valid_neighbours = "()[]*+-/ " #start_loc = parameter_string_start -1 #end_loc = parameter_string_end #if not any([constraint_text[start_loc] == ch for ch in valid_neighbours]): # return False #if end_loc < len(constraint_text): # if not any([constraint_text[end_loc] == ch for ch in valid_neighbours]): # return False # 4. replace parameter name with "1" and try to evaluate the expression try: expression_to_evaluate = constraint_text.replace(param_str, "1.0") eval(expression_to_evaluate) except Exception: # Too many cases to cover individually, just a blanket # Exception should be sufficient # Note that in current numpy things like sqrt(-1) don't # raise but just return warnings return False return True
[docs] def onHelp(self): """ Display related help section """ try: help_location = GuiUtils.HELP_DIRECTORY_LOCATION + \ "/user/qtgui/Perspectives/Fitting/fitting_help.html#simultaneous-fits-with-constraints" webbrowser.open('file://' + os.path.realpath(help_location)) except AttributeError: # No manager defined - testing and standalone runs pass