1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
|
#
# This file is part of the PyMeasure package.
#
# Copyright (c) 2013-2024 PyMeasure Developers
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
import logging
from functools import partial
from ..inputs import BooleanInput, IntegerInput, ListInput, ScientificInput, StringInput
from ..Qt import QtWidgets, QtCore
from ...experiment import parameters
log = logging.getLogger(__name__)
log.addHandler(logging.NullHandler())
class InputsWidget(QtWidgets.QWidget):
"""
Widget wrapper for various :doc:`inputs`
"""
# tuple of Input classes that do not need an external label
NO_LABEL_INPUTS = (BooleanInput,)
def __init__(self, procedure_class, inputs=(), parent=None, hide_groups=True,
inputs_in_scrollarea=False):
super().__init__(parent)
self._procedure_class = procedure_class
self._procedure = procedure_class()
self._inputs = inputs
self._setup_ui()
self._layout(inputs_in_scrollarea)
self._hide_groups = hide_groups
self._setup_visibility_groups()
def _setup_ui(self):
parameter_objects = self._procedure.parameter_objects()
for name in self._inputs:
parameter = parameter_objects[name]
if parameter.ui_class is not None:
element = parameter.ui_class(parameter)
elif isinstance(parameter, parameters.FloatParameter):
element = ScientificInput(parameter)
elif isinstance(parameter, parameters.IntegerParameter):
element = IntegerInput(parameter)
elif isinstance(parameter, parameters.BooleanParameter):
element = BooleanInput(parameter)
elif isinstance(parameter, parameters.ListParameter):
element = ListInput(parameter)
elif isinstance(parameter, parameters.Parameter):
element = StringInput(parameter)
setattr(self, name, element)
def _layout(self, inputs_in_scrollarea):
vbox = QtWidgets.QVBoxLayout(self)
vbox.setSpacing(6)
vbox.setContentsMargins(0, 0, 0, 0)
self.labels = {}
parameters = self._procedure.parameter_objects()
for name in self._inputs:
if not isinstance(getattr(self, name), self.NO_LABEL_INPUTS):
label = QtWidgets.QLabel(self)
label.setText("%s:" % parameters[name].name)
vbox.addWidget(label)
self.labels[name] = label
vbox.addWidget(getattr(self, name))
if inputs_in_scrollarea:
scroll_area = QtWidgets.QScrollArea()
scroll_area.setWidgetResizable(True)
scroll_area.setFrameStyle(QtWidgets.QScrollArea.Shape.NoFrame)
scroll_area.setHorizontalScrollBarPolicy(QtCore.Qt.ScrollBarPolicy.ScrollBarAlwaysOff)
inputs = QtWidgets.QWidget(self)
inputs.setLayout(vbox)
inputs.setSizePolicy(QtWidgets.QSizePolicy.Policy.Minimum,
QtWidgets.QSizePolicy.Policy.Fixed)
scroll_area.setWidget(inputs)
vbox = QtWidgets.QVBoxLayout(self)
vbox.setContentsMargins(0, 0, 0, 0)
vbox.addWidget(scroll_area, 1)
self.setLayout(vbox)
def _setup_visibility_groups(self):
groups = {}
parameters = self._procedure.parameter_objects()
for name in self._inputs:
parameter = parameters[name]
group_state = {g: True for g in parameter.group_by}
for group_name, condition in parameter.group_by.items():
if group_name not in self._inputs or group_name == name:
continue
if isinstance(getattr(self, group_name), BooleanInput):
# Adjust the boolean condition to a condition suitable for a checkbox
condition = bool(condition)
if group_name not in groups:
groups[group_name] = []
groups[group_name].append((name, condition, group_state))
for group_name, group in groups.items():
toggle = partial(self.toggle_group, group_name=group_name, group=group)
group_el = getattr(self, group_name)
if isinstance(group_el, BooleanInput):
group_el.toggled.connect(toggle)
toggle(group_el.isChecked())
elif isinstance(group_el, StringInput):
group_el.textChanged.connect(toggle)
toggle(group_el.text())
elif isinstance(group_el, (IntegerInput, ScientificInput)):
group_el.valueChanged.connect(toggle)
toggle(group_el.value())
elif isinstance(group_el, ListInput):
group_el.currentTextChanged.connect(toggle)
toggle(group_el.currentText())
else:
raise NotImplementedError(
f"Grouping based on {group_name} ({group_el}) is not implemented.")
def toggle_group(self, state, group_name, group):
for (name, condition, group_state) in group:
if callable(condition):
group_state[group_name] = condition(state)
else:
group_state[group_name] = (state == condition)
visible = all(group_state.values())
if self._hide_groups:
getattr(self, name).setHidden(not visible)
else:
getattr(self, name).setDisabled(not visible)
if name in self.labels:
if self._hide_groups:
self.labels[name].setHidden(not visible)
else:
self.labels[name].setDisabled(not visible)
def set_parameters(self, parameter_objects):
for name in self._inputs:
element = getattr(self, name)
element.set_parameter(parameter_objects[name])
def get_procedure(self):
""" Returns the current procedure """
self._procedure = self._procedure_class()
parameter_values = {}
for name in self._inputs:
element = getattr(self, name)
parameter_values[name] = element.parameter.value
self._procedure.set_parameters(parameter_values)
return self._procedure
|