widgets.py

"""
Created on Jul 20, 2018

@author: Benedikt Ursprung
"""

from qtpy import QtCore, QtWidgets, QtGui
import pyqtgraph as pg
import numpy as np


class MinMaxQSlider(QtWidgets.QWidget):
    """
    Costume QSlider widget designed to work with logged_quantities.
    Two spin boxes allow to dynamically update the min and max value of the slider.
    """

    # Signals
    updated_value = QtCore.Signal((float,), (int,))

    def __init__(
        self,
        name="",
        unit="",
        initial=50,
        vmin=0,
        vmax=100,
        spinbox_decimals=2,
        **QSlider_kwargs,
    ):

        self.SLIDER_MIN = -2147483648
        self.SLIDER_MAX = 2147483647

        self.name = name
        self.unit = unit

        # Setup widget
        QtWidgets.QWidget.__init__(self)

        # slider
        self.slider = QtWidgets.QSlider(
            orientation=QtCore.Qt.Horizontal, **QSlider_kwargs
        )
        self.slider.valueChanged.connect(self.on_slider_value_changed)
        self.slider.valueChanged.connect(self.set_title)

        # min and max spinbox
        self.min_double_spinbox = QtWidgets.QSpinBox()
        self.max_double_spinbox = QtWidgets.QSpinBox()
        self.min_double_spinbox.setRange(self.SLIDER_MIN, self.SLIDER_MAX)
        self.max_double_spinbox.setRange(self.SLIDER_MIN, self.SLIDER_MAX)

        self.set_range(vmin, vmax)

        self.min_double_spinbox.valueChanged[int].connect(self.update_slider_minimum)
        self.max_double_spinbox.valueChanged[int].connect(self.update_slider_maximum)

        self.spinbox_decimals = spinbox_decimals

        # title label
        self.title_label = QtWidgets.QLabel()

        # Setup layout
        self.layout_ = QtWidgets.QGridLayout()
        self.layout_.addWidget(
            self.min_double_spinbox, 0, 0, alignment=QtCore.Qt.AlignLeft
        )
        self.layout_.addWidget(self.title_label, 0, 1, alignment=QtCore.Qt.AlignHCenter)
        self.layout_.addWidget(
            self.max_double_spinbox, 0, 2, alignment=QtCore.Qt.AlignRight
        )
        self.layout_.addWidget(self.slider, 1, 0, 1, 3)

        self.setLayout(self.layout_)
        self.update_value(initial)

    def set_range(self, vmin, vmax):
        val = self.val

        vmin = min(max(vmin, self.SLIDER_MIN), self.SLIDER_MAX)
        vmax = max(min(vmax, self.SLIDER_MAX), self.SLIDER_MIN)

        self.min_double_spinbox.setValue(vmin)
        self.max_double_spinbox.setValue(vmax)

        self.slider.blockSignals(True)
        self.slider.setRange(int(vmin), int(vmax))
        self.slider.blockSignals(False)

        self.update_value(val)

    def set_name(self, name):
        self.name = name
        self.set_title(self.val)

    def value(self):
        return self.val

    @property
    def val(self):
        return self.transform_from_slider(self.slider.value())

    @property
    def vmin(self):
        return self.min_double_spinbox.value()

    @property
    def vmax(self):
        return self.max_double_spinbox.value()

    @property
    def vrange(self):
        return self.vmax - self.vmin

    def transform_to_slider(self, x):
        return int(x)

    def transform_from_slider(self, x):
        return x

    def update_slider_minimum(self, vmin):
        self.set_range(vmin, self.vmax)

    def update_slider_maximum(self, vmax):
        self.set_range(self.vmin, vmax)

    def update_value(self, x):
        self.slider.setValue(self.transform_to_slider(x))

    def on_slider_value_changed(self, x):
        val = self.transform_from_slider(self.slider.value())
        self.updated_value.emit(val)

    def set_title(self, val):
        val = self.transform_from_slider(val)
        self.title_label.setText(f"{self.name} {self.val} {self.unit}")


class RegionSlicer(QtWidgets.QWidget):
    """
    **Bases:** :class: `QWidget <pyqt.QtWidgets.QWidget>`

    Adds a movable <pyqtgraph.LinearRegionItem> to a plot.
    Provides a numpy slice and mask that would slices the x_array according to the region.

    ===============================  =============================================================================
    **Signals:**
    region_changed_signal()          Emitted when region is changed or activated by user
    ===============================  =============================================================================


    ===============================  =============================================================================
    **Properties:**
    slice:                           numpy.slice[start:stop]
    s_:                              :property:slice if activated  else *s_return_on_deactivated*
    mask:                            numpy boolean array of size 'x_array': True for where x is within region
                                     false otherwise (ignores step). Useful if x_array is not ordered.
    m_:                              mask if activated, else a mask equivalent to
                                        *s_return_on_deactivated*
    ===============================  =============================================================================
    """

    region_changed_signal = QtCore.Signal()

    def __init__(
        self,
        plot_item,
        x_array=None,
        name="array_slicer_name",
        slicer_updated_func=lambda: None,
        initial=[0, 100],
        s_return_on_deactivated=np.s_[:],
        brush=QtGui.QColor(0, 255, 0, 70),
        ZValue=10,
        font=QtGui.QFont("Times", 12),
        label_line=1,
        activated=False,
    ):
        """Create a new LinearRegionItem on plot_item.

        ====================== ==============================================================
        **Arguments:**
        plot_item              <pyqtgraph.PlotDataItem> (recommended)
                                or <pyqtgraph.PlotItem>  (does not grab x_array data from plot
                                item: initialize x_array manually
                                or use :func:`set_x_array <self.set_x_array>`)
        x_array                use to initialize x_array if plot_item == <pyqtgraph.PlotItem>.
        name                   <str>
        slicer_updated_func    gets called when region is updated, alternatively use
                               :sig:region_changed_signal().
        initial                initial index values [start,stop,step] or [start,stop]
        s_return_on_deactivated  Object returned if RegionSlicer is not activated.
                                 Slicing with np.s_[:] (default) and np.s_[0] gives the full and
                                 an empty array respectively. Note, <RegionSlicer.slice> always
                                 returns the last determined slice even if slice is deactivated.
        brush,ZValue,          are passed to the LinearRegionItem
        font,                  passed to the label
        label_line             '0' or '1' for placement of label onto 'left' or 'right'
                               bounding line.
        activated              <bool> state at initialization
        ====================== ===============================================================
        """
        QtWidgets.QWidget.__init__(self)

        self.name = name

        self.slicer_updated = slicer_updated_func

        from ScopeFoundry.logged_quantity import LQCollection

        self.settings = LQCollection()
        if len(initial) == 2:
            initial.append(1)
        start, stop, step = initial
        self.start = self.settings.New("start", int, initial=start, vmin=0)
        self.stop = self.settings.New("stop", int, initial=stop, vmin=0)
        self.step = self.settings.New("step", int, initial=step)
        self.activated = self.settings.New("activated", bool, initial=activated)

        self.s_return_on_deactivated = s_return_on_deactivated

        if type(plot_item) == pg.PlotDataItem:
            self.plot_data_item = plot_item
            self.plot_data_item.sigPlotChanged.connect(self.set_x_array_from_data_item)
            self.parent_plot_item = plot_item.parentItem()
        elif type(plot_item) == pg.PlotItem:
            self.plot_data_item = None
            self.parent_plot_item = plot_item

        self.linear_region_item = pg.LinearRegionItem(brush=brush)
        self.linear_region_item.setZValue(ZValue)
        self.parent_plot_item.addItem(self.linear_region_item)

        self.inf_line_label = pg.InfLineLabel(
            self.linear_region_item.lines[label_line],
            self.name,
            position=0.78,
            anchor=(0.5, 0.5),
        )
        # self.inf_line_label = pg.TextItem(self.name, anchor=(0.5, 0.5))
        self.inf_line_label.setFont(font)
        self.set_label("")

        if x_array == None:  # give it something to work with.
            x_array = np.arange(512)
        self.set_x_array(x_array)

        self.start.add_listener(self.on_change_start_stop)
        self.stop.add_listener(self.on_change_start_stop)
        self.activated.add_listener(self.on_change_activated)
        self.linear_region_item.sigRegionChangeFinished.connect(self.on_change_region)

    @QtCore.Slot(object)
    def set_x_array_from_data_item(self):
        x_array, _ = self.plot_data_item.getData()
        if not np.array_equal(x_array, self.x_array):
            self.apply_new_x_array(x_array)
            # print('set_x_array_from_data_item: new x_array()')
        else:
            pass

    def set_x_array(self, x_array):
        """
        use this function to update the x_array
        not required to use if type(plot_item) == pg.PlotDataItem
        """
        self.apply_new_x_array(x_array)

    def apply_new_x_array(self, x_array):
        mn, mx = self.linear_region_item.getRegion()
        self.x_array = x_array
        self.linear_region_item.setBounds([self.x_array.min(), self.x_array.max()])
        self.settings["start"] = np.argmin((x_array - mn) ** 2)
        self.settings["stop"] = np.argmin((x_array - mx) ** 2)

    @property
    def slice(self):
        S = self.settings
        return np.s_[S["start"] : S["stop"] : S["step"]]

    @property
    def s_(self):
        """returns slice based on region if activated else `s_return_on_deactivated`"""
        if self.activated.val:
            return self.slice
        else:
            return self.s_return_on_deactivated

    @property
    def mask(self):
        Xmin = self.x_array[self.settings["start"]]
        Xmax = self.x_array[self.settings["stop"]]
        return (self.x_array >= Xmin) * (self.x_array <= Xmax)

    @property
    def m_(self):
        if self.activated.val:
            return self.mask
        else:
            s = self.s_return_on_deactivated
            Xmin = self.x_array[s.start]
            Xmax = self.x_array[s.stop]
            return (self.x_array >= Xmin) * (self.x_array <= Xmax)

    @QtCore.Slot(object)
    def on_change_region(self):
        """
        updates settings based on region
        """
        print(self.name, "on_change_region")
        self.region_min, self.region_max = mn, mx = self.linear_region_item.getRegion()
        self.settings["start"] = np.argmin((self.x_array - mn) ** 2)
        self.settings["stop"] = np.argmin((self.x_array - mx) ** 2)
        self.region_changed_signal.emit()
        self.slicer_updated()

    def on_change_start_stop(self):
        """
        updates linear_region_item based on settings
        """
        rgn = [0, 0]
        rgn[0] = self.x_array[self.settings["start"]]
        try:
            rgn[1] = self.x_array[self.settings["stop"]]
        except IndexError:
            rgn[1] = self.x_array[self.settings["start"]]
        self.linear_region_item.setRegion(rgn)

    def on_change_activated(self):
        activated = self.activated.val
        self.linear_region_item.setEnabled(activated)
        self.linear_region_item.setAcceptHoverEvents(activated)
        self.linear_region_item.setAcceptTouchEvents(activated)
        self.linear_region_item.setVisible(activated)
        self.region_changed_signal.emit()
        self.slicer_updated()

    def New_UI(self, include=None, exclude=[]):
        ui_widget = self.settings.New_UI(include, exclude)
        ui_widget.layout().insertRow(0, QtWidgets.QLabel(f"<b>{self.name}</b>"))
        return ui_widget

    def set_label(self, text="", title=None, color=(200, 200, 200)):
        if title == None:
            title = self.name
        self.inf_line_label.setHtml(f"<h3>{title}</h3>{text}")
        self.inf_line_label.setColor(color)

    def get_sliced_xar(self, ar=None):
        if ar == None:
            if hasattr(self, "plot_data_item"):
                _, y = self.plot_data_item.getData()
                return (self.x_array[self.s_], y[self.s_])
            else:
                return None
        else:
            return (self.x_array[self.s_], ar[self.s_])