added light command to lamni

csaxs_bec/bec_ipython_client/plugins/LamNI/gui_tools.py

@@ -0,0 +1,188 @@
+import builtins
+
+from bec_widgets.cli.client import BECDockArea
+
+# from csaxs_bec.bec_ipython_client.plugins.cSAXS import epics_get, epics_put, fshopen, fshclose
+
+if builtins.__dict__.get("bec") is not None:
+    bec = builtins.__dict__.get("bec")
+    dev = builtins.__dict__.get("dev")
+    scans = builtins.__dict__.get("scans")
+
+def umv(*args):
+    return scans.umv(*args, relative=False)
+
+
+class LamniGuiToolsError(Exception):
+    pass
+
+
+class LamniGuiTools:
+
+    def __init__(self):
+        self.text_box = None
+        self.progressbar = None
+
+    def set_client(self, client):
+        self.client = client
+        self.gui = self.client.gui
+
+    def lamnigui_show_gui(self):
+        if "lamni" in self.gui.windows:
+            self.gui.lamni.show()
+        else:
+            self.gui.new("lamni")
+
+    def lamnigui_stop_gui(self):
+        self.gui.lamni.hide()
+
+    def lamnigui_raise(self):
+        self.gui.lamni.raise_window()
+
+    def lamnigui_show_xeyealign(self):
+        self.lamnigui_show_gui()
+        if self._lamnigui_check_attribute_not_exists("xeyegui"):
+            self.lamnigui_remove_all_docks()
+            self.xeyegui = self.gui.lamni.new("xeyegui").new("XRayEye")
+            # start live
+            if not dev.cam_xeye.live_mode:
+                dev.cam_xeye.live_mode = True
+
+
+    def _lamnigui_check_attribute_not_exists(self, attribute_name):
+        if hasattr(self.gui,"lamni"):
+            if hasattr(self.gui.lamni,attribute_name):
+                return False
+        return True
+
+    def lamnigui_remove_all_docks(self):
+        self.gui.lamni.delete_all() 
+        self.progressbar = None
+        self.text_box = None
+
+    def lamnigui_idle(self):
+        self.lamnigui_show_gui()
+        if self._lamnigui_check_attribute_not_exists("idle_text_box"):
+            self.lamnigui_remove_all_docks()
+            idle_text_box = self.gui.lamni.new("idle_textbox").new("TextBox")
+        text = (
+            "<pre>"
+            + "██████╗ ███████╗ ██████╗     ██╗      █████╗ ███╗   ███╗███╗   ██╗██╗\n"
+            + "██╔══██╗██╔════╝██╔════╝     ██║     ██╔══██╗████╗ ████║████╗  ██║██║\n"
+            + "██████╔╝█████╗  ██║          ██║     ███████║██╔████╔██║██╔██╗ ██║██║\n"
+            + "██╔══██╗██╔══╝  ██║          ██║     ██╔══██║██║╚██╔╝██║██║╚██╗██║██║\n"
+            + "██████╔╝███████╗╚██████╗     ███████╗██║  ██║██║ ╚═╝ ██║██║ ╚████║██║\n"
+            + "╚═════╝ ╚══════╝ ╚═════╝     ╚══════╝╚═╝  ╚═╝╚═╝     ╚═╝╚═╝  ╚═══╝╚═╝\n"
+            + "</pre>"
+        )
+        idle_text_box.set_html_text(text)
+
+    def lamnigui_docs(self, filename: str | None = None):
+        import csaxs_bec
+        from pathlib import Path
+
+        print("The general lamni documentation is at \nhttps://sls-csaxs.readthedocs.io/en/latest/user/ptychography/lamni.html#user-ptychography-lamni")
+
+        csaxs_bec_basepath = Path(csaxs_bec.__file__).parent
+        docs_folder = (
+            csaxs_bec_basepath /
+            "bec_ipython_client" / "plugins" / "lamni" / "docs"
+        )
+
+        if not docs_folder.is_dir():
+            raise NotADirectoryError(f"Docs folder not found: {docs_folder}")
+
+        pdfs = sorted(docs_folder.glob("*.pdf"))
+        if not pdfs:
+            raise FileNotFoundError(f"No PDF files found in {docs_folder}")
+
+        # --- Resolve PDF ------------------------------------------------------
+        if filename is not None:
+            pdf_file = docs_folder / filename
+            if not pdf_file.exists():
+                raise FileNotFoundError(f"Requested file not found: {filename}")
+        else:
+            print("\nAvailable lamni documentation PDFs:\n")
+            for i, pdf in enumerate(pdfs, start=1):
+                print(f"  {i:2d}) {pdf.name}")
+            print()
+
+            while True:
+                try:
+                    choice = int(input(f"Select a file (1–{len(pdfs)}): "))
+                    if 1 <= choice <= len(pdfs):
+                        pdf_file = pdfs[choice - 1]
+                        break
+                    print(f"Enter a number between 1 and {len(pdfs)}.")
+                except ValueError:
+                    print("Invalid input. Please enter a number.")
+
+        # --- GUI handling (active existence check) ----------------------------
+        self.lamnigui_show_gui()
+
+        if self._lamnigui_check_attribute_not_exists("PdfViewerWidget"):
+            self.lamnigui_remove_all_docks()
+            self.pdf_viewer = self.gui.lamni.new(widget="PdfViewerWidget")
+
+        # --- Load PDF ---------------------------------------------------------
+        self.pdf_viewer.PdfViewerWidget.load_pdf(str(pdf_file.resolve()))
+        print(f"\nLoaded: {pdf_file.name}\n")
+
+
+    def _lamnicam_check_device_exists(self, device):
+        try:
+            device
+        except:
+            return False
+        else:
+            return True
+
+    def lamnigui_show_progress(self):
+        self.lamnigui_show_gui()
+        if self._lamnigui_check_attribute_not_exists("progressbar"):
+            self.lamnigui_remove_all_docks()
+            # Add a new dock with a RingProgressBar widget
+            self.progressbar = self.gui.lamni.new("progressbar").new("RingProgressBar")
+            # Customize the size of the progress ring
+            self.progressbar.set_line_widths(20)
+            # Disable automatic updates and manually set the self.progressbar value
+            self.progressbar.enable_auto_updates(False)
+            # Set precision for the self.progressbar display
+            self.progressbar.set_precision(1)  # Display self.progressbar with one decimal places
+            # Setting multiple rigns with different values
+            self.progressbar.set_number_of_bars(3)
+            self.progressbar.rings[0].set_update("manual")
+            self.progressbar.rings[1].set_update("manual")
+            self.progressbar.rings[2].set_update("scan")
+            # Set the values of the rings to 50, 75, and 25 from outer to inner ring
+            # self.progressbar.set_value([50, 75])
+            # Add a new dock with a TextBox widget
+            self.text_box = self.gui.lamni.new(name="progress_text").new("TextBox")
+
+        self._lamnigui_update_progress()
+
+    def _lamnigui_update_progress(self):
+        if self.progressbar is not None:
+            progress = self.progress["projection"] / self.progress["total_projections"] * 100
+            subtomo_progress = (
+                self.progress["subtomo_projection"]
+                / self.progress["subtomo_total_projections"]
+                * 100
+            )
+            self.progressbar.set_value([progress, subtomo_progress, 0])
+            if self.text_box is not None:
+                text = f"Progress report:\n Tomo type: ....................... {self.progress['tomo_type']}\n Projection: ...................... {self.progress['projection']:.0f}\n Total projections expected ....... {self.progress['total_projections']}\n Angle: ........................... {self.progress['angle']}\n Current subtomo: ................. {self.progress['subtomo']}\n Current projection within subtomo: {self.progress['subtomo_projection']}\n Total projections per subtomo: ... {self.progress['subtomo_total_projections']}"
+                self.text_box.set_plain_text(text)
+
+
+if __name__ == "__main__":
+    from bec_lib.client import BECClient
+    from bec_widgets.cli.client_utils import BECGuiClient
+
+    client = BECClient()
+    client.start()
+    client.gui = BECGuiClient()
+
+    lamni_gui = LamniGuiTools(client)
+    lamni_gui.lamnigui_show_gui()
+    lamni_gui.lamnigui_show_progress()

csaxs_bec/bec_ipython_client/plugins/LamNI/lamni.py

@@ -13,6 +13,7 @@ from bec_lib.pdf_writer import PDFWriter
 from typeguard import typechecked
 
 from csaxs_bec.bec_ipython_client.plugins.omny.omny_general_tools import OMNYTools
+from csaxs_bec.bec_ipython_client.plugins.LamNI.gui_tools import LamniGuiTools
 
 from .alignment import XrayEyeAlign
 from .lamni_optics_mixin import LaMNIInitStages, LamNIOpticsMixin
@@ -26,7 +27,7 @@ if builtins.__dict__.get("bec") is not None:
     umvr = builtins.__dict__.get("umvr")
 
 
-class LamNI(LamNIOpticsMixin):
+class LamNI(LamNIOpticsMixin,LamniGuiTools):
     def __init__(self, client):
         super().__init__()
         self.client = client
@@ -221,7 +222,12 @@ class LamNI(LamNIOpticsMixin):
 
     def show_analog_signals(self):
         return self.device_manager.devices.rtx.controller.show_analog_signals()
+    
+    def lights_off(self):
+        self.device_manager.devices.lsamx.controller.lights_off()
 
+    def lights_on(self):
+        self.device_manager.devices.lsamx.controller.lights_on()
     # ------------------------------------------------------------------
     # Global parameters (backed by BEC global vars)
     # ------------------------------------------------------------------

csaxs_bec/bec_ipython_client/plugins/LamNI/lamni_optics_mixin.py

@@ -51,7 +51,7 @@ class LaMNIInitStages:
             self.drive_axis_to_limit(dev.lsamrot, "forward")
             dev.lsamrot.enabled = False
             print("Now hard reboot the controller and run the initialization routine again.")
-            print("The controller will be disabled in bec. To enable dev.lsamrot.enabled=True")
+            print("Remark: The controller will be disabled in bec. It will be enabled by running the init route, \nbut in case needed, to enable manually set dev.lsamrot.enabled=True")
             return
 
         if self.OMNYTools.yesno(

csaxs_bec/bec_ipython_client/plugins/flomni/gui_tools.py

@@ -107,11 +107,12 @@ class flomniGuiTools:
             idle_text_box = self.gui.flomni.new("idle_textbox").new("TextBox")
         text = (
             "<pre>"
-            + " ,---.,--. ,-----. ,--.   ,--.,--.  ,--.,--. \n"
-            + "/  .-'|  |'  .-.  '|   `.'   ||  ,'.|  ||  | \n"
-            + "|  `-,|  ||  | |  ||  |'.'|  ||  |' '  ||  | \n"
-            + "|  .-'|  |'  '-'  '|  |   |  ||  | `   ||  | \n"
-            + "`--'  `--' `-----' `--'   `--'`--'  `--'`--' \n"
+            + "██████╗ ███████╗ ██████╗     ███████╗██╗      ██████╗ ███╗   ███╗███╗   ██╗██╗\n"
+            + "██╔══██╗██╔════╝██╔════╝     ██╔════╝██║     ██╔═══██╗████╗ ████║████╗  ██║██║\n"
+            + "██████╔╝█████╗  ██║          █████╗  ██║     ██║   ██║██╔████╔██║██╔██╗ ██║██║\n"
+            + "██╔══██╗██╔══╝  ██║          ██╔══╝  ██║     ██║   ██║██║╚██╔╝██║██║╚██╗██║██║\n"
+            + "██████╔╝███████╗╚██████╗     ██║     ███████╗╚██████╔╝██║ ╚═╝ ██║██║ ╚████║██║\n"
+            + "╚═════╝ ╚══════╝ ╚═════╝     ╚═╝     ╚══════╝ ╚═════╝ ╚═╝     ╚═╝╚═╝  ╚═══╝╚═╝\n"
             + "</pre>"
         )
         idle_text_box.set_html_text(text)

csaxs_bec/bec_ipython_client/plugins/omny/gui_tools.py

@@ -83,16 +83,12 @@ class OMNYGuiTools:
                 pass
         text = (
             "<pre>"
-            + "    ,o888888o.           ,8.       ,8.          b.             8 `8.`8888.      ,8' \n"
-            + " . 8888     `88.        ,888.     ,888.         888o.          8  `8.`8888.    ,8'  \n"
-            + ",8 8888       `8b      .`8888.   .`8888.        Y88888o.       8   `8.`8888.  ,8'   \n"
-            + "88 8888        `8b    ,8.`8888. ,8.`8888.       .`Y888888o.    8    `8.`8888.,8'    \n"
-            + "88 8888         88   ,8'8.`8888,8^8.`8888.      8o. `Y888888o. 8     `8.`88888'     \n"
-            + "88 8888         88  ,8' `8.`8888' `8.`8888.     8`Y8o. `Y88888o8      `8. 8888      \n"
-            + "88 8888        ,8P ,8'   `8.`88'   `8.`8888.    8   `Y8o. `Y8888       `8 8888      \n"
-            + "`8 8888       ,8P ,8'     `8.`'     `8.`8888.   8      `Y8o. `Y8        8 8888      \n"
-            + " ` 8888     ,88' ,8'       `8        `8.`8888.  8         `Y8o.`        8 8888      \n"
-            + "    `8888888P'  ,8'         `         `8.`8888. 8            `Yo        8 8888      \n"
+            + "██████╗ ███████╗ ██████╗      ██████╗ ███╗   ███╗███╗   ██╗██╗   ██╗\n"
+            + "██╔══██╗██╔════╝██╔════╝     ██╔═══██╗████╗ ████║████╗  ██║╚██╗ ██╔╝\n"
+            + "██████╔╝█████╗  ██║          ██║   ██║██╔████╔██║██╔██╗ ██║ ╚████╔╝ \n"
+            + "██╔══██╗██╔══╝  ██║          ██║   ██║██║╚██╔╝██║██║╚██╗██║  ╚██╔╝  \n"
+            + "██████╔╝███████╗╚██████╗     ╚██████╔╝██║ ╚═╝ ██║██║ ╚████║   ██║   \n"
+            + "╚═════╝ ╚══════╝ ╚═════╝      ╚═════╝ ╚═╝     ╚═╝╚═╝  ╚═══╝   ╚═╝   \n"
             + "</pre>"
         )
         self.idle_text_box.set_html_text(text)

csaxs_bec/device_configs/ptycho_lamni.yaml

@@ -271,4 +271,20 @@ rty:
   enabled: true
   readOnly: False
 
-
+############################################################
+######################### Cameras ##########################
+############################################################
+cam_xeye:
+  description: Camera LamNI Xray eye ID15
+  deviceClass: csaxs_bec.devices.ids_cameras.ids_camera.IDSCamera
+  deviceConfig:
+    camera_id: 15
+    bits_per_pixel: 24
+    num_rotation_90: 3
+    transpose: false
+    force_monochrome: true
+    m_n_colormode: 1
+  enabled: true
+  onFailure: buffer
+  readOnly: false
+  readoutPriority: async

csaxs_bec/devices/omny/galil/lgalil_ophyd.py

@@ -15,7 +15,6 @@ from csaxs_bec.devices.omny.galil.galil_ophyd import (
     GalilAxesReferenced,
     GalilController,
     GalilMotorIsMoving,
-    GalilMotorResolution,
     GalilSetpointSignal,
     GalilSignalRO,
     retry_once,
@@ -24,6 +23,19 @@ from csaxs_bec.devices.omny.galil.galil_ophyd import (
 logger = bec_logger.logger
 
 
+class GalilMotorResolution(GalilSignalRO):
+    @retry_once
+    @threadlocked
+    def _socket_get(self):
+        if self.parent.axis_Id_numeric < 6:
+            return float(
+                self.controller.socket_put_and_receive(f"MG encpermm[{self.parent.axis_Id_numeric}]")
+            )
+        else:
+            return float(
+                self.controller.socket_put_and_receive(f"MG stppermm[{self.parent.axis_Id_numeric}]")
+            )
+
 class LamniGalilController(GalilController):
 
 
@@ -154,11 +166,18 @@ class LamniGalilReadbackSignal(GalilSignalRO):
         Returns:
             float: Readback value after adjusting for sign and motor resolution.
         """
-        current_pos = float(self.controller.socket_put_and_receive(f"TD{self.parent.axis_Id}"))
-        current_pos *= self.parent.sign
-        step_mm = self.parent.motor_resolution.get()
-        return current_pos / step_mm
-
+        if self.parent.axis_Id_numeric < 6:
+            current_pos = float(self.controller.socket_put_and_receive(f"TP{self.parent.axis_Id}"))
+            current_pos *= self.parent.sign
+            encoder_resolution = self.parent.motor_resolution.get()
+            logger.info(f"Read galil encoder position of axis {self.parent.axis_Id_numeric} to be TP {current_pos} with resolution {encoder_resolution}")
+            return current_pos / encoder_resolution
+        else:
+            current_pos = float(self.controller.socket_put_and_receive(f"TD{self.parent.axis_Id}"))
+            current_pos *= self.parent.sign
+            step_mm = self.parent.motor_resolution.get()
+            return current_pos / step_mm
+        
     def read(self):
         self._metadata["timestamp"] = time.time()
         val = super().read()

csaxs_bec/scans/LamNIFermatScan.py

@@ -169,6 +169,9 @@ class LamNIMixin:
 
         self.device_manager.devices.lsamx.read_only = True
         self.device_manager.devices.lsamy.read_only = True
+        
+        #update angle readback before start of the scan
+        yield from self.stubs.send_rpc_and_wait("lsamrot", "readback.get")
 
         yield from self.stubs.send_rpc_and_wait("rtx", "controller.feedback_enable_without_reset")
 

docs/user/ptychography/flomni.md

@@ -108,12 +108,17 @@ The nano-positioning is controlled by a feedback loop running on a real-time lin
 
 Once the loop has started, it is possible to start bec with the flOMNI configuration file.
 
+Starting bec with session will load the scripts
+`bec --session flomni`
+
+The flOMNI scripts can be loaded manually by  
+`from csaxs_bec.bec_ipython_client.plugins.flomni import Flomni`  
+`flomni =  Flomni(bec)`
+
 Loading the flOMNI configuration (this command will load the OMNY configuration only - isolated from the beamline)  
 `bec.config.update_session_with_file("/bec/csaxs_bec/csaxs_bec/device_configs/flomni_config.yaml")`
 
-Loading the flOMNI scripts  
-`from csaxs_bec.bec_ipython_client.plugins.flomni import Flomni`  
-`flomni =  Flomni(bec)`
+
 
 If the realtime system is restarted, bec will lose communication. To restart:  
 `flomni.rt_off()` … then wait a few seconds  
@@ -138,10 +143,14 @@ This script will first verify that the stages are not in an initialized state, a
 The positions of the optics stages are stored as stage parameters and are thus linked to the configuration file.  
 Example: The OSAx “in” position can be reviewed by `dev.fosax.user_parameter`  
 Update the value by (example "fosax", "in") by `dev.fosax.update_user_parameter({"in":value})`
+Important note: if these values are changed, they are not automatically stored to the config file and will only be available in the current session.
 
 `flomni.ffzp_info()` shows info about the available FZPs at the current energy of the beamline. Optional parameter is the photon _energy_ in keV.  
 Example: `flomni.ffzp_info(6.2)`
 
+Documents about availabe optics can be accessed by
+`flomni.flomnigui_docs`
+
 The [laser feedback](user.ptychography.flomni.laser_feedback) will be disabled and fine alignment lost if foptx/y are moved!
 
 Following functions exist to move the optics in and out, with self-explaining naming.

docs/user/ptychography/lamni.md

@@ -102,13 +102,16 @@ The nano-positioning is controlled by a feedback loop running on a real-time lin
 
 Once the loop has started, it is possible to start bec with the LamNI configuration file.
 
-Loading the LamNI configuration (this command will load the LamNI configuration only - isolated from the beamline)  
-`bec.config.update_session_with_file("/bec/csaxs_bec/csaxs_bec/device_configs/lamni_config.yaml")`
+Loading the LamNI scripts is done by starting bec as
+`bec --session lamni`
 
-Loading the LamNI scripts  
+The scripts can alternatively manually be loaded by  
 `from csaxs_bec.bec_ipython_client.plugins.LamNI import LamNI`
 `lamni = LamNI(bec)`
 
+Loading the LamNI configuration (this command will load the LamNI configuration only - isolated from the beamline)  
+`bec.config.update_session_with_file("/bec/csaxs_bec/csaxs_bec/device_configs/lamni_config.yaml")`
+
 If the realtime system is restarted, BEC will lose communication. To restart:  
 `lamni.rt_off()` … then wait a 10 seconds  
 `lamni.rt_on()`
@@ -152,6 +155,12 @@ The underlying scan function can be called as
 
 Use `scans.lamni_fermat_scan?`for detailed information. A prerequisite for scanning is a running feedback system.
 
+### GUI tools
+
+During operation the BEC GUI will show the relevant cameras or progress information. To manually switch view TAB completion on 'lamni.lamnigui_' will show all options to control the GUI. Most useful
+'lamni.lamnigui_show_progress()' will show the measurement progress GUI
+'lamnigui_show_xeyealign()' will show the XrayEye alignment GUI
+
 ### X-ray optics alignment
 
 The positions of the optics stages are stored as stage parameters and are thus linked to the configuration file.