Added more plugin examples

Author: PierreRaybaut

cdl/__init__.py

@@ -5,7 +5,7 @@
 
 """
 DataLab
-============
+=======
 
 DataLab is a generic signal and image processing software based on Python
 scientific libraries (such as NumPy, SciPy or scikit-image) and Qt graphical

plugins/examples/cdl_example_empty.py

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+
+"""
+Empty plugin example
+====================
+
+This is an empty example of a DataLab plugin.
+
+It adds a new menu entry in "Plugins" menu, with a sub-menu "Empty plugin (example)".
+This sub-menu contains one action, "Do nothing".
+"""
+
+import cdl.plugins
+
+
+class EmptyPlugin(cdl.plugins.PluginBase):
+    """DataLab Example Plugin"""
+
+    PLUGIN_INFO = cdl.plugins.PluginInfo(
+        name="Empty plugin (example)",
+        version="1.0.0",
+        description="This is an empty example plugin",
+    )
+
+    def do_nothing(self) -> None:
+        """Do nothing"""
+        self.show_info("Do nothing")
+
+    def create_actions(self) -> None:
+        """Create actions"""
+        acth = self.imagepanel.acthandler
+        with acth.new_menu(self.PLUGIN_INFO.name):
+            # Note: in the following call, `select_condition` is by default `None`,
+            # so the action is enabled only if at least one image is selected.
+            acth.new_action("Do nothing", triggered=self.do_nothing)

plugins/examples/cdl_example_imageformat.py

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+
+"""
+Image format Plugin for DataLab (example)
+=========================================
+
+This plugin is an example of how to add a new image file format to DataLab.
+
+It provides a new image file format, Dürr NDT XYZ, from Dürr NDT GmbH & Co. KG
+(see `Dürr NDT website <https://www.duerr-ndt.com/>`_).
+"""
+
+import numpy as np
+
+from cdl.core.io.base import FormatInfo
+from cdl.core.io.image.base import ImageFormatBase
+
+
+class XYZImageFormat(ImageFormatBase):
+    """Object representing Dürr NDT XYZ image file type"""
+
+    FORMAT_INFO = FormatInfo(
+        name="Dürr NDT",
+        extensions="*.xyz",
+        readable=True,
+        writeable=False,
+    )
+
+    @staticmethod
+    def read_data(filename: str) -> np.ndarray:
+        """Read data and return it
+
+        Args:
+            filename (str): path to XYZ file
+
+        Returns:
+            np.ndarray: image data
+        """
+        with open(filename, "rb") as fdesc:
+            cols = int(np.fromfile(fdesc, dtype=np.uint16, count=1)[0])
+            rows = int(np.fromfile(fdesc, dtype=np.uint16, count=1)[0])
+            arr = np.fromfile(fdesc, dtype=np.uint16, count=cols * rows)
+            arr = arr.reshape((rows, cols))
+        return np.fliplr(arr)