Going further: waiting for a user validation#
In this chapter we will:
avoid downstream propagation until a ‘ok’ button is pressed
add a ‘ok’ button which trigger downstrean processing with the current result
Avoid downstream propagation#
To avoid downstream processing we can replace ewoks execution calls from execute_ewoks_task to execute_ewoks_task_without_propagation.
We also need to reimplement the handleNewSignals function that will call by default the execute_ewoks_task instead of execute_ewoks_task_without_propagation
class OWClipData(
OWEwoksWidgetOneThread,
ewokstaskclass=ClipDataTask,
):
...
def _percentileChanged(self):
self.set_dynamic_input("percentiles", self._myWidget.getPercentiles())
data = self.get_task_output_value("data")
if not is_missing_data(data):
self.execute_ewoks_task_without_propagation()
def handleNewSignals(self):
self.execute_ewoks_task_without_propagation()
Add a ok button that triggers downstream processing#
for this we will take the shortest way to do it:
append a QPushButton to the control widget MyWidget
connect the clicked signal to the ewoks orange function trigger_downstream
class MyWidget(qt.QWidget):
def __init__(self, parent):
...
# ok button
self._okButton = qt.QPushButton("ok", self)
self.layout().addRow(self._okButton)
class OWClipData(
OWEwoksWidgetOneThread,
ewokstaskclass=ClipDataTask,
):
def __init__(self, parent):
...
# connect signal / slot
...
self._myWidget._okButton.clicked.connect(self.trigger_downstream)
Now your workflow should look like:
Warning
Be careful that when user trigger downstream processing (click on the button) nothing makes sure all required input are defined.
This is up to you to make it clear to the user.
Either displaying a clear warning about missing input or disabling the ‘ok’ button until all required input are provided can be good solution to avoid user confusion.
Results
"""
clipdata.py: Core code for the ClipDataTask, which is a task to rescale 'data' (numpy array) to the given percentiles.
Includes the ewoks task and the pydantic models.
"""
import numpy
from ewokscore.model import BaseInputModel
from ewokscore.model import BaseOutputModel
from ewokscore.task import Task
from pydantic import Field
class InputModel(BaseInputModel):
data: numpy.ndarray = Field(..., description="data to rescale")
percentiles: tuple[float, float] = Field(
...,
description="""percentiles to use for rescaling, must be a tuple of two values (p_min, p_max) with p_min <= p_max""",
)
class OutputModel(BaseOutputModel):
data: numpy.ndarray = Field(..., description="rescaled data")
class ClipDataTask(
Task,
input_model=InputModel,
output_model=OutputModel,
):
"""
Task to rescale 'data' (numpy array) to the given percentiles.
"""
def run(self):
data = self.inputs.data
# compute data min and max
percentiles = self.inputs.percentiles
self.outputs.data = numpy.clip(
data,
a_min=numpy.percentile(data, percentiles[0]),
a_max=numpy.percentile(data, percentiles[1]),
)
"""MyWidget.py: contains GUI specific code"""
from silx.gui import qt
class MyWidget(qt.QWidget):
def __init__(self, parent):
super().__init__(parent)
self.setLayout(qt.QFormLayout())
self._minPercentiles = qt.QSlider(qt.Qt.Orientation.Horizontal)
self._minPercentiles.setTickPosition(qt.QSlider.TickPosition.TicksBelow)
self._minPercentiles.setRange(0, 100)
self._minPercentiles.setTickInterval(10)
self.layout().addRow(
"min percentiles",
self._minPercentiles,
)
# max percentiles
self._maxPercentiles = qt.QSlider(qt.Qt.Orientation.Horizontal)
self._maxPercentiles.setTickPosition(qt.QSlider.TickPosition.TicksBelow)
self._maxPercentiles.setRange(0, 100)
self._maxPercentiles.setTickInterval(10)
self.layout().addRow(
"max percentiles",
self._maxPercentiles,
)
# ok button
self._okButton = qt.QPushButton("ok", self)
self.layout().addRow(self._okButton)
def setPercentiles(self, percentiles: tuple):
self._minPercentiles.setValue(percentiles[0])
self._maxPercentiles.setValue(percentiles[1])
def getPercentiles(self) -> tuple:
return (self._minPercentiles.value(), self._maxPercentiles.value())
"""
OWClipData.py: Code for the orange add-on binding.
"""
import numpy
from ewokscore.missing_data import is_missing_data
from ewokstesttuto.gui.MyWidget import MyWidget
from ewokstesttuto.tasks.clipdata import ClipDataTask
from silx.gui.plot import Plot1D
from ewoksorange.gui.owwidgets.threaded import OWEwoksWidgetOneThread
class OWClipData(
OWEwoksWidgetOneThread,
ewokstaskclass=ClipDataTask,
):
name = "rescale data"
id = "orange.widgets.my_project.ClipDataTask"
description = "widget to clip data (numpy array) within a percentile range."
want_main_area = True
want_control_area = True
_ewoks_inputs_to_hide_from_orange = ("percentiles",)
def __init__(self, parent=None):
super().__init__(parent)
self._plot = Plot1D(self)
self.mainArea.layout().addWidget(self._plot)
self._myWidget = MyWidget(self)
self.controlArea.layout().addWidget(self._myWidget)
# set up percentiles
self._myWidget.setPercentiles((10, 90))
self._percentileChanged()
# connect signal / slot
self._myWidget._minPercentiles.valueChanged.connect(self._percentileChanged)
self._myWidget._maxPercentiles.valueChanged.connect(self._percentileChanged)
self._myWidget._okButton.clicked.connect(self.trigger_downstream)
def _percentileChanged(self):
self.set_dynamic_input("percentiles", self._myWidget.getPercentiles())
data = self.get_task_output_value("data")
if not is_missing_data(data):
self.execute_ewoks_task()
def handleNewSignals(self):
self.execute_ewoks_task_without_propagation()
def task_output_changed(self):
data = self.get_task_output_value("data")
if is_missing_data(data):
self._plot.clear()
else:
# compute histogram
histogram, _ = numpy.histogram(data, bins=100, range=(0.0, 1.0))
self._plot.addCurve(
x=numpy.linspace(0.0, 1.0, num=100), y=histogram, legend="histogram"
)
return super().task_output_changed()