Added simplified DataLab's object model

Author: PierreRaybaut

cdlclient/remote.py

@@ -32,7 +32,9 @@
 from guidata.env import execenv
 from guidata.userconfig import get_config_basedir
 
+from cdlclient import simplemodel
 from cdlclient.baseproxy import SimpleBaseProxy
+from cdlclient.simplemodel import ImageObj, SignalObj
 
 # pylint: disable=invalid-name  # Allows short reference names like x, y, ...
 # pylint: disable=duplicate-code
@@ -111,6 +113,9 @@ def json_to_dataset(param_data: list[str]) -> gds.DataSet:
         guidata DataSet
     """
     param_module, param_clsname, param_json = param_data
+    # Replacing DataLab's model by DataLab Simple Client's model:
+    param_module = param_module.replace("cdl.core.model.signal", simplemodel.__name__)
+    param_module = param_module.replace("cdl.core.model.image", simplemodel.__name__)
     mod = importlib.__import__(param_module, fromlist=[param_clsname])
     klass = getattr(mod, param_clsname)
     param = klass()
@@ -377,6 +382,71 @@ def calc(self, name: str, param: gds.DataSet | None = None) -> gds.DataSet:
             return self._cdl.calc(name)
         return self._cdl.calc(name, dataset_to_json(param))
 
+    def get_object_from_title(
+        self, title: str, panel: str | None = None
+    ) -> SignalObj | ImageObj:
+        """Get object (signal/image) from title
+
+        Args:
+            title (str): object
+            panel (str | None): panel name (valid values: "signal", "image").
+                If None, current panel is used.
+
+        Returns:
+            Union[SignalObj, ImageObj]: object
+
+        Raises:
+            ValueError: if object not found
+            ValueError: if panel not found
+        """
+        param_data = self._cdl.get_object_from_title(title, panel)
+        return json_to_dataset(param_data)
+
+    def get_object(
+        self,
+        index: int | None = None,
+        group_index: int | None = None,
+        panel: str | None = None,
+    ) -> SignalObj | ImageObj:
+        """Get object (signal/image) from index.
+
+        Args:
+            index (int): Object index in current panel. Defaults to None.
+            group_index (int | None): Group index. Defaults to None.
+            panel (str | None): Panel name. Defaults to None.
+
+        If ``index`` is not specified, returns the currently selected object.
+        If ``group_index`` is not specified, return an object from the current group.
+        If ``panel`` is not specified, return an object from the current panel.
+
+        Returns:
+            Union[SignalObj, ImageObj]: object
+
+        Raises:
+            IndexError: if object not found
+        """
+        param_data = self._cdl.get_object(index, group_index, panel)
+        return json_to_dataset(param_data)
+
+    def get_object_from_uuid(
+        self, oid: str, panel: str | None = None
+    ) -> SignalObj | ImageObj:
+        """Get object (signal/image) from uuid
+
+        Args:
+            oid (str): object uuid
+            panel (str | None): panel name (valid values: "signal", "image").
+
+        Returns:
+            Union[SignalObj, ImageObj]: object
+
+        Raises:
+            ValueError: if object not found
+            ValueError: if panel not found
+        """
+        param_data = self._cdl.get_object_from_uuid(oid, panel)
+        return json_to_dataset(param_data)
+
     def get_object_shapes(
         self,
         index: int | None = None,

cdlclient/simplemodel.py

@@ -0,0 +1,124 @@
+# -*- coding: utf-8 -*-
+#
+# Licensed under the terms of the BSD 3-Clause
+# (see cdlclient/LICENSE for details)
+
+"""
+DataLab Simple Model
+"""
+
+# pylint: disable=invalid-name  # Allows short reference names like x, y, ...
+
+from __future__ import annotations
+
+from typing import Any
+
+import guidata.dataset as gds
+from guidata.dataset.io import JSONReader
+
+ROI_KEY = "_roi_"
+ANN_KEY = "_ann_"
+
+
+class BaseObj:
+    """Base object"""
+
+    # This is overriden in children classes with a gds.DictItem instance:
+    metadata: dict[str, Any] = {}
+
+    def __set_annotations(self, annotations: str | None) -> None:
+        """Set object annotations (JSON string describing annotation plot items)
+
+        Args:
+            annotations (str | None): JSON string describing annotation plot items,
+                or None to remove annotations
+        """
+        if annotations is None:
+            if ANN_KEY in self.metadata:
+                self.metadata.pop(ANN_KEY)
+        else:
+            self.metadata[ANN_KEY] = annotations
+
+    def __get_annotations(self) -> str:
+        """Get object annotations (JSON string describing annotation plot items)"""
+        return self.metadata.get(ANN_KEY, "")
+
+    annotations = property(__get_annotations, __set_annotations)
+
+    def get_annotated_shapes(self):
+        """Get annotated shapes"""
+        from plotpy.io import load_items  # pylint: disable=import-outside-toplevel
+
+        if self.annotations:
+            return load_items(JSONReader(self.annotations))
+        return []
+
+
+class SignalObj(gds.DataSet, BaseObj):
+    """Signal object (simplified version of DataLab's Signal object)"""
+
+    _tabs = gds.BeginTabGroup("all")
+
+    _datag = gds.BeginGroup("Data and metadata")
+    title = gds.StringItem("Signal title", default="Untitled")
+    xydata = gds.FloatArrayItem("Data", transpose=True, minmax="rows")
+    metadata = gds.DictItem("Metadata", default={})
+    _e_datag = gds.EndGroup("Data and metadata")
+
+    _unitsg = gds.BeginGroup("Titles and units")
+    title = gds.StringItem("Signal title", default="Untitled")
+    _tabs_u = gds.BeginTabGroup("units")
+    _unitsx = gds.BeginGroup("X-axis")
+    xlabel = gds.StringItem("Title", default="")
+    xunit = gds.StringItem("Unit", default="")
+    _e_unitsx = gds.EndGroup("X-axis")
+    _unitsy = gds.BeginGroup("Y-axis")
+    ylabel = gds.StringItem("Title", default="")
+    yunit = gds.StringItem("Unit", default="")
+    _e_unitsy = gds.EndGroup("Y-axis")
+    _e_tabs_u = gds.EndTabGroup("units")
+    _e_unitsg = gds.EndGroup("Titles and units")
+
+    _e_tabs = gds.EndTabGroup("all")
+
+
+class ImageObj(gds.DataSet, BaseObj):
+    """Image object (simplified version of DataLab's Image object)"""
+
+    _tabs = gds.BeginTabGroup("all")
+
+    _datag = gds.BeginGroup("Data")
+    data = gds.FloatArrayItem("Data")
+    metadata = gds.DictItem("Metadata", default={})
+    _e_datag = gds.EndGroup("Data")
+
+    _dxdyg = gds.BeginGroup("Origin / Pixel spacing")
+    _origin = gds.BeginGroup("Origin")
+    x0 = gds.FloatItem("X<sub>0</sub>", default=0.0)
+    y0 = gds.FloatItem("Y<sub>0</sub>", default=0.0).set_pos(col=1)
+    _e_origin = gds.EndGroup("Origin")
+    _pixel_spacing = gds.BeginGroup("Pixel spacing")
+    dx = gds.FloatItem("Δx", default=1.0, nonzero=True)
+    dy = gds.FloatItem("Δy", default=1.0, nonzero=True).set_pos(col=1)
+    _e_pixel_spacing = gds.EndGroup("Pixel spacing")
+    _e_dxdyg = gds.EndGroup("Origin / Pixel spacing")
+
+    _unitsg = gds.BeginGroup("Titles / Units")
+    title = gds.StringItem("Image title", default="Untitled")
+    _tabs_u = gds.BeginTabGroup("units")
+    _unitsx = gds.BeginGroup("X-axis")
+    xlabel = gds.StringItem("Title", default="")
+    xunit = gds.StringItem("Unit", default="")
+    _e_unitsx = gds.EndGroup("X-axis")
+    _unitsy = gds.BeginGroup("Y-axis")
+    ylabel = gds.StringItem("Title", default="")
+    yunit = gds.StringItem("Unit", default="")
+    _e_unitsy = gds.EndGroup("Y-axis")
+    _unitsz = gds.BeginGroup("Z-axis")
+    zlabel = gds.StringItem("Title", default="")
+    zunit = gds.StringItem("Unit", default="")
+    _e_unitsz = gds.EndGroup("Z-axis")
+    _e_tabs_u = gds.EndTabGroup("units")
+    _e_unitsg = gds.EndGroup("Titles / Units")
+
+    _e_tabs = gds.EndTabGroup("all")

cdlclient/tests/remoteclient_app.py

@@ -175,6 +175,7 @@ def add_additional_buttons(self):
         add_btn("Execute multiple commands", self.exec_multiple_cmd, 10)
         add_btn("Get object titles", self.get_object_titles, 10)
         add_btn("Get object uuids", self.get_object_uuids, 10)
+        add_btn("Get object", self.get_object)
 
     @try_send_command()
     def exec_multiple_cmd(self):
@@ -208,6 +209,18 @@ def get_object_uuids(self):
             else:
                 self.host.log("  Empty.")
 
+    @try_send_command()
+    def get_object(self):
+        """Get object (signal/image) at index for current panel"""
+        if self.cdl is not None:
+            titles = self.cdl.get_object_titles()
+            if titles:
+                obj = self.cdl.get_object()
+                self.host.log(f"Object '{obj.title}'")
+                self.host.log(str(obj))
+            else:
+                self.host.log("🏴‍☠️ Object list is empty!")
+
     def add_signals(self):
         """Add signals to DataLab"""
         if self.cdl is not None:
@@ -266,6 +279,9 @@ def test_remote_client():
                 window.get_object_titles()
             with qt_wait_print(dt, "Getting object uuids"):
                 window.get_object_uuids()
+            with qt_wait_print(dt, "Getting object"):
+                window.cdl.select_objects([0])
+                window.get_object()
             with qt_wait_print(dt, "Adding signals"):
                 window.add_signals()
             with qt_wait_print(dt, "Adding images"):

doc/api.rst

@@ -12,3 +12,19 @@ Base proxy
 
 .. autoclass:: cdlclient.SimpleBaseProxy
     :members:
+
+Simple model
+^^^^^^^^^^^^
+
+DataLab Simple Client provides a simple model for accessing the DataLab
+objects.
+
+.. warning::
+
+    This model is not complete and does not cover all the DataLab features.
+
+.. autoclass:: cdlclient.simplemodel.SignalObj
+    :members:
+
+.. autoclass:: cdlclient.simplemodel.ImageObj
+    :members: