deapi 5.3b3__tar.gz → 5.3b4__tar.gz

{deapi-5.3b3 → deapi-5.3b4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deapi
-Version: 5.3b3
+Version: 5.3b4
 Summary: API for DE Server
 Author: Direct Electron
 Project-URL: Bug Reports, https://github.com/directelectron/deapi/issues

{deapi-5.3b3 → deapi-5.3b4}/deapi/client.py

@@ -15,6 +15,9 @@ import mmap
 from datetime import datetime
 from time import sleep
 import re
+import win32event
+import win32api
+import threading
 from typing import List, Union, Tuple
 
 import numpy as np
@@ -80,7 +83,7 @@ class Client:
         return
 
     def __str__(self):
-        return f"Client(host={self.host}, port={self.port}, camera={self.get_current_camera()})"
+        return f"Client(host={self.host}, port={self.port}, camera={self.camera})"
 
     def _ipython_key_completions_(self):
         return self.list_properties()
@@ -91,12 +94,12 @@ class Client:
 			<tr>
 				<th>Host</th>
 				<th>Port</th>
-				<th>Current Camera</th>
+				<th>Camera</th>
 			</tr>
 			<tr>
 				<td>{self.host}</td>
 				<td>{self.port}</td>
-				<td>{self.currCamera}</td>
+				<td>{self.camera}</td>
 			</tr>
 		</table>
         <details>
@@ -176,12 +179,13 @@ class Client:
         self.socket.setblocking(False)
         self.socket.settimeout(2)
 
-        self.cameras = self.__getStrings(self.LIST_CAMERAS)
-        if logLevel == logging.DEBUG:
-            log.debug("Available cameras: %s", self.cameras)
-        self.currCamera = self.cameras[0]
+        command = self._addSingleCommand(self.LIST_CAMERAS, None)
+        response = self._sendCommand(command)
+        if response != False:
+            self.camera = self.__getParameters(response.acknowledge[0])[0]
+        
         if logLevel == logging.DEBUG:
-            log.debug("Current camera: %s", self.currCamera)
+            log.debug("Camera: %s", self.camera)
 
         self.connected = True
         self.host = host
@@ -259,9 +263,12 @@ class Client:
 
     def list_cameras(self) -> List[str]:
         """
+        Deprecated function.
         List the available cameras on the server.
         """
-        return self.cameras
+        log.warning("list_cameras is deprecated.")
+
+        return [self.camera]
 
     def get_virtual_mask(self, index):
         mask_name = f"virtual_mask{index}"
@@ -275,35 +282,29 @@ class Client:
             _,
         ) = self.get_result(mask_name, DataType.DE8u, attributes=a)
         return res
-
+    
     def get_current_camera(self) -> str:
         """
         Get the current camera on the server.
         """
-        if self.currCamera is None:
+        if self.camera == "":
             return "No current camera"
         else:
-            return self.currCamera
-
+            return self.camera
+        
     @write_only
     def set_current_camera(self, camera_name: str = None):
         """
+        Deprecated function.
         Set the current camera on the server.
         """
-        if camera_name is None:
-            return False
+        log.warning("set_current_camera is deprecated.")
 
-        self.currCamera = camera_name
-
-        if logLevel == logging.DEBUG:
-            log.debug("current camera: %s", camera_name)
-
-        self.refreshProperties = True
         return True
 
     def list_properties(self, options=None, search=None):
         """
-        Get a list of property names from the current camera on DE-Server
+        Get a list of property names from the camera on DE-Server
 
         Parameters
         ----------
@@ -322,7 +323,7 @@ class Client:
 
     def list_registers(self, options=None, search=None):
         """
-        Get a list of register names from the current camera on DE-Server
+        Get a list of register names from the camera on DE-Server
         for each register, it contains attributes: name of the register, address, Read only, value of the register
 
         Parameters
@@ -345,7 +346,7 @@ class Client:
     )
     def get_property_spec(self, property_name: str):
         """
-        Get a list of allowed values for a property of the current camera on DE-Server
+        Get a list of allowed values for a property of the camera on DE-Server
         Deprecated since DE-MC 2.7.4
 
         Parameters
@@ -410,7 +411,7 @@ class Client:
     )
     def get_property_specifications(self, property_name):
         """
-        Get a list of allowed values for a property of the current camera on DE-Server
+        Get a list of allowed values for a property of the camera on DE-Server
         Only works for DE-MC version greater or equal to 2.7.4
 
         Parameters
@@ -420,10 +421,10 @@ class Client:
         """
         t0 = self.GetTime()
         values = False
-        command = self.__addSingleCommand(
+        command = self._addSingleCommand(
             self.GET_PROPERTY_SPECIFICATIONS, property_name
         )
-        response = self.__sendCommand(command)
+        response = self._sendCommand(command)
         if response == False:
             return None
 
@@ -477,7 +478,7 @@ class Client:
     )
     def get_property(self, property_name: str):
         """
-        Get the value of a property of the current camera on DE-Server
+        Get the value of a property of the camera on DE-Server
 
         Parameters
         ----------
@@ -510,7 +511,7 @@ class Client:
     
     def get_register(self, register_name: str):
         """
-        Get the value of a register of the current camera on DE-Server
+        Get the value of a register of the camera on DE-Server
 
         Parameters
         ----------
@@ -565,7 +566,7 @@ class Client:
     @write_only
     def set_property(self, name: str, value):
         """
-        Set the value of a property of the current camera on DE-Server
+        Set the value of a property of the camera on DE-Server
 
         Parameters
         ----------
@@ -601,7 +602,7 @@ class Client:
     )
     def set_property_and_get_changed_properties(self, name, value, changed_properties):
         """
-        Set the value of a property of the current camera on DE-Server and get all
+        Set the value of a property of the camera on DE-Server and get all
         the changed properties.  This is useful for testing and determining how certain
         properties affect others.
 
@@ -643,7 +644,7 @@ class Client:
     @write_only
     def set_register(self, name: str, value):
         """
-        Set the value of a register of the current camera on DE-Server
+        Set the value of a register of the camera on DE-Server
 
         Parameters
         ----------
@@ -677,7 +678,7 @@ class Client:
     @write_only
     def set_engineering_mode(self, enable, password):
         """
-        Set the engineering mode of the current camera on DE-Server. Mostly for internal testing.
+        Set the engineering mode of the camera on DE-Server. Mostly for internal testing.
 
         Parameters
         ----------
@@ -700,10 +701,10 @@ class Client:
 
         ret = False
 
-        command = self.__addSingleCommand(
+        command = self._addSingleCommand(
             self.SET_ENG_MODE_GET_CHANGED_PROPERTIES, None, [enable, password]
         )
-        response = self.__sendCommand(command)
+        response = self._sendCommand(command)
         if response != False:
             ret = response.acknowledge[0].error != True
             self.refreshProperties = True
@@ -720,7 +721,7 @@ class Client:
     @deprecated_argument(name="sizeY", since="5.2.0", alternative="size_y")
     def set_hw_roi(self, offset_x: int, offset_y: int, size_x: int, size_y: int):
         """
-        Set the hardware region of interest (ROI) of the current camera on DE-Server.
+        Set the hardware region of interest (ROI) of the camera on DE-Server.
 
         Parameters
         ----------
@@ -762,14 +763,14 @@ class Client:
     @deprecated_argument(name="sizeY", since="5.2.0", alternative="size_y")
     def SetScanSize(self, size_x, size_y):
         """
-        Set the scan size of the current camera on DE-Server.
+        Set the scan size of the camera on DE-Server.
         """
 
         t0 = self.GetTime()
         ret = False
 
-        command = self.__addSingleCommand(self.SET_SCAN_SIZE, None, [size_x, size_y])
-        response = self.__sendCommand(command)
+        command = self._addSingleCommand(self.SET_SCAN_SIZE, None, [size_x, size_y])
+        response = self._sendCommand(command)
         if response != False:
             ret = response.acknowledge[0].error != True
             self.refreshProperties = True
@@ -794,10 +795,10 @@ class Client:
         t0 = self.GetTime()
         ret = False
 
-        command = self.__addSingleCommand(
+        command = self._addSingleCommand(
             self.SET_SCAN_SIZE_AND_GET_CHANGED_PROPERTIES, None, [size_x, size_y]
         )
-        response = self.__sendCommand(command)
+        response = self._sendCommand(command)
         if response != False:
             ret = response.acknowledge[0].error != True
             self.refreshProperties = True
@@ -820,10 +821,10 @@ class Client:
         t0 = self.GetTime()
         ret = False
 
-        command = self.__addSingleCommand(
+        command = self._addSingleCommand(
             self.SET_SCAN_ROI, None, [enable, offsetX, offsetY, sizeX, sizeY]
         )
-        response = self.__sendCommand(command)
+        response = self._sendCommand(command)
         if response != False:
             ret = response.acknowledge[0].error != True
             self.refreshProperties = True
@@ -848,12 +849,12 @@ class Client:
         t0 = self.GetTime()
         ret = False
 
-        command = self.__addSingleCommand(
+        command = self._addSingleCommand(
             self.SET_SCAN_ROI__AND_GET_CHANGED_PROPERTIES,
             None,
             [enable, offsetX, offsetY, sizeX, sizeY],
         )
-        response = self.__sendCommand(command)
+        response = self._sendCommand(command)
         if response != False:
             ret = response.acknowledge[0].error != True
             self.refreshProperties = True
@@ -878,7 +879,7 @@ class Client:
         self, offsetX: int, offsetY: int, sizeX: int, sizeY: int, changedProperties
     ):
         """
-        Set the hardware region of interest (ROI) of the current camera on DE-Server and get all
+        Set the hardware region of interest (ROI) of the camera on DE-Server and get all
         the changed properties.  This is useful for testing and determining how certain
         properties affect others.
 
@@ -927,7 +928,7 @@ class Client:
     @write_only
     def set_sw_roi(self, offsetX: int, offsetY: int, sizeX: int, sizeY: int):
         """
-        Set the software region of interest (ROI) of the current camera on DE-Server.
+        Set the software region of interest (ROI) of the camera on DE-Server.
 
         Parameters
         ----------
@@ -970,7 +971,7 @@ class Client:
     @deprecated_argument(name="useHW", since="5.2.0", alternative="use_hw")
     def set_binning(self, bin_x, bin_y, use_hw=True):
         """
-        Set the binning of the current camera on DE-Server. If useHW is True, the binning will
+        Set the binning of the camera on DE-Server. If useHW is True, the binning will
         use hardware binning. If useHW is False, the binning will use software binning only.
 
         Note
@@ -1012,10 +1013,8 @@ class Client:
             if prop_hw_bin_y is not False:
                 hw_bin_y = int(prop_hw_bin_y)
 
-            if bin_x > 2:
-                retval &= self.SetProperty("Binning X", bin_x / hw_bin_x)
-            if bin_y > 2:
-                retval &= self.SetProperty("Binning Y", bin_y / hw_bin_y)
+            retval &= self.SetProperty("Binning X", bin_x / hw_bin_x)
+            retval &= self.SetProperty("Binning Y", bin_y / hw_bin_y)
 
             if commandVersion >= 13:
                 retval &= self.SetProperty("Server Normalize Properties", "On")
@@ -1027,7 +1026,7 @@ class Client:
         self, offsetX, offsetY, sizeX, sizeY, changedProperties
     ):
         """
-        Set the software region of interest (ROI) of the current camera on DE-Server and get all of
+        Set the software region of interest (ROI) of the camera on DE-Server and get all of
         the changed properties.  This is useful for testing and determining how certain
         properties affect others.
 
@@ -1078,7 +1077,7 @@ class Client:
         self, size_x: int, size_y: int, offset_x: int = None, offset_y: int = None
     ):
         """
-        Automatically choose the proper HW ROI and set SW ROI of the current camera on DE-Server.
+        Automatically choose the proper HW ROI and set SW ROI of the camera on DE-Server.
 
         If offset_x and offset_y are not provided, they will be centered on the camera.
 
@@ -1126,7 +1125,7 @@ class Client:
         self, offsetX, offsetY, sizeX, sizeY, changedProperties, timeoutMsec=5000
     ):
         """
-        Automatically choose the proper HW ROI and set SW ROI of the current camera on DE-Server and get all of
+        Automatically choose the proper HW ROI and set SW ROI of the camera on DE-Server and get all of
         the changed properties.  This is useful for testing and determining how certain
         properties affect others.
 
@@ -1147,12 +1146,12 @@ class Client:
         t0 = self.GetTime()
         ret = False
 
-        command = self.__addSingleCommand(
+        command = self._addSingleCommand(
             self.SET_ADAPTIVE_ROI_AND_GET_CHANGED_PROPERTIES,
             None,
             [offsetX, offsetY, sizeX, sizeY],
         )
-        response = self.__sendCommand(command)
+        response = self._sendCommand(command)
         if response != False:
             ret = response.acknowledge[0].error != True
             self.refreshProperties = True
@@ -1735,7 +1734,7 @@ class Client:
     @write_only
     def set_virtual_mask(self, id, w, h, mask):
         """
-        Set the virtual mask of the current camera on DE-Server.
+        Set the virtual mask of the camera on DE-Server.
 
         Parameters
         ----------
@@ -1776,7 +1775,7 @@ class Client:
     @write_only
     def setROI(self, offsetX, offsetY, sizeX, sizeY, useHWROI=False):
         """
-        Set the region of interest (ROI) of the current camera on DE-Server.
+        Set the region of interest (ROI) of the camera on DE-Server.
 
         Parameters
         ----------
@@ -1831,7 +1830,7 @@ class Client:
 
     def get_movie_buffer_info(self, movieBufferInfo=None, timeoutMsec=5000):
         """
-        Get the movie buffer information of the current camera on DE-Server.
+        Get the movie buffer information of the camera on DE-Server.
 
         Parameters
         ----------
@@ -1866,7 +1865,7 @@ class Client:
         self, movieBuffer, movieBufferSize, numFrames, timeoutMsec=5000
     ):
         """
-        Get the movie buffer of the current camera on DE-Server. The movie buffer
+        Get the movie buffer of the camera on DE-Server. The movie buffer
         is a series of frames that are stored in memory and can be retrieved as
         a single buffer for faster processing.
 
@@ -2477,6 +2476,125 @@ class Client:
             return time.clock()
         else:
             return time.perf_counter()
+        
+    def enable_get_event(self):
+        """
+        Enable event retrieval from the server.
+        
+        Creates a Windows semaphore to handle event notifications and enables
+        the getEventEnabled flag. This must be called before get_event() can be used.
+        
+        Returns
+        -------
+        bool
+            True if event retrieval was successfully enabled, False otherwise.
+        """
+        with self.eventMutex:
+            command = self._addSingleCommand(self.ENABLE_GET_EVENT, None, None)
+            response = self._sendCommand(command)
+
+            if response != False:
+                semaphoreName = self.__getParameters(response.acknowledge[0])[0]
+                if semaphoreName is not None:
+                    self.sdkEventSemaphore = win32event.CreateSemaphore(None, 0, 999, semaphoreName)
+                else:
+                    return False
+                
+                self.getEventEnabled = True
+                return True
+            else:
+                return False
+        
+    def get_event(self):
+        """
+        Retrieve the next event from the server.
+
+        Waits for an event signal on the semaphore and retrieves the event specification
+        from the server. This method blocks until an event is signaled. If the client
+        is not connected or event retrieval was not enabled via `enable_get_event()`,
+        an empty list is returned instead of attempting to fetch an event.
+
+        Returns
+        -------
+        list
+            A list of 5 strings that represent the specification for 1 event with the following order:
+            [event_type, name, value, lower_limit, upper_limit].
+            * event_type can be "Property", "AllowedValues", or "Readonly".
+              - "Property" means the event was triggered by a change in a property's value or its limits.
+              - "AllowedValues" means the event was triggered by a change in the options of a property.
+                Please use get_property_specifications after an "AllowedValues" event to get the updated specifications
+                for the property that triggered the event.
+              - "Readonly" means the event was triggered by a property changing between read-only and read-write.
+            * name is the name of the property that triggered the event.
+            * value is the new value of the property that triggered the event.
+              It can also indicate if a property is now read-only ("1") or read-write ("0") for a "Readonly" event.
+              For "AllowedValues" events, value may be an empty string.
+            * lower_limit and upper_limit are the new limits of the property that triggered a "Property" event.
+              If they are empty strings, then the limits did not change.
+            If event retrieval is disabled or the client is disconnected, an empty list is returned.
+        """
+        if self.sdkEventSemaphore is not None:
+            win32event.WaitForSingleObject(self.sdkEventSemaphore, win32event.INFINITE)
+        else:
+            return []
+
+        with self.eventMutex:
+            if not self.connected or not self.getEventEnabled:
+                return []
+                
+            command = self._addSingleCommand(self.GET_EVENT, None, None)
+            response = self._sendCommand(command)
+
+            eventSpec = []
+            if response != False:
+                values = self.__getParameters(response.acknowledge[0])
+                if type(values) is list:
+                    eventSpec.append(values[0])
+                    eventSpec.append(values[1])
+                    eventSpec.append(values[2])
+                    eventSpec.append(values[3])
+                    eventSpec.append(values[4])
+
+            return eventSpec
+    
+    def disable_get_event(self):
+        """
+        Disable event retrieval from the server.
+        
+        Releases and closes the Windows semaphore used for event notification,
+        and disables the getEventEnabled flag. After calling this, get_event()
+        will no longer function.
+        
+        Returns
+        -------
+        bool
+            True if event retrieval was successfully disabled, False otherwise.
+        """
+        with self.eventMutex:
+            command = self._addSingleCommand(self.DISABLE_GET_EVENT, None, None)
+            response = self._sendCommand(command)
+
+            if response != False:
+                if self.sdkEventSemaphore is not None:
+                    win32event.ReleaseSemaphore(self.sdkEventSemaphore, 1)
+                    win32api.CloseHandle(self.sdkEventSemaphore)
+                    self.sdkEventSemaphore = None
+                self.getEventEnabled = False
+                return True
+            else:
+                return False
+        
+    def is_get_event_enabled(self):
+        """
+        Check if event retrieval from the server is currently enabled.
+
+        Returns
+        -------
+        bool
+            True if event retrieval is enabled, False otherwise.
+        """
+        with self.eventMutex:
+            return self.getEventEnabled
 
     # private methods
 
@@ -2557,10 +2675,10 @@ class Client:
 
         if command is None:
             return False
-
+        
         if len(command.camera_name) == 0:
             command.camera_name = (
-                self.currCamera
+                self.camera
             )  # append the current camera name if necessary
 
         try:
@@ -2787,6 +2905,10 @@ class Client:
     GetImage = get_image
     TakeDarkReference = take_dark_reference
     GetTime = get_time
+    EnableGetEvent = enable_get_event
+    GetEvent = get_event
+    DisableGetEvent = disable_get_event
+    IsGetEventEnabled = is_get_event_enabled
 
     # method setProperty was renamed to SetProperty. please use SetProperty
     setProperty = SetProperty
@@ -2799,13 +2921,15 @@ class Client:
     usingMmf = True
     debugImagesFolder = "D:\\DebugImages\\"
     connected = False
-    cameras = None
-    currCamera = ""
+    camera = ""
     refreshProperties = True
     exposureTime = 1
     host = 0
     port = 0
     read_only = False
+    sdkEventSemaphore = None
+    getEventEnabled = False
+    eventMutex = threading.Lock()
 
     # command lists
     LIST_CAMERAS = 0
@@ -2816,6 +2940,7 @@ class Client:
     GET_IMAGE_16U = 5
     GET_IMAGE_32F = 10
     STOP_ACQUISITION = 11
+    GET_EVENT = 12
     GET_RESULT = 14
     START_ACQUISITION = 15
     SET_HW_ROI = 16
@@ -2838,6 +2963,8 @@ class Client:
     SET_ADAPTIVE_ROI = 33
     SET_ADAPTIVE_ROI_AND_GET_CHANGED_PROPERTIES = 34
     GET_PROPERTY_SPECIFICATIONS = 35
+    ENABLE_GET_EVENT = 36
+    DISABLE_GET_EVENT = 37
     GET_REGISTER = 38
     SET_REGISTER = 39
     LIST_REGISTERS = 40 

{deapi-5.3b3 → deapi-5.3b4}/deapi/tests/original_tests/01_fps.py

@@ -9,9 +9,6 @@ from deapi.tests.original_tests import func, propertyName
 deClient = DEAPI.Client()
 deClient.Connect()
 
-cameras = deClient.ListCameras()
-camera = cameras[0]
-deClient.SetCurrentCamera(camera)
 serverVersion = deClient.GetProperty(propertyName.PROP_SERVER_SOFTWARE_VERSION)
 cameraName = deClient.GetProperty(propertyName.PROP_CAMERA_NAME)
 print(f"Camera Name: {cameraName}, Server Software Version is: {serverVersion}")

{deapi-5.3b3 → deapi-5.3b4}/deapi/tests/original_tests/02_hwRoisize.py

@@ -7,9 +7,6 @@ from deapi.tests.original_tests import func, propertyName
 # Connect to the server
 deClient = DEAPI.Client()
 deClient.Connect()
-cameras = deClient.ListCameras()
-camera = cameras[0]
-deClient.SetCurrentCamera(camera)
 serverVersion = deClient.GetProperty(propertyName.PROP_SERVER_SOFTWARE_VERSION)
 cameraName = deClient.GetProperty(propertyName.PROP_CAMERA_NAME)
 print(f"Camera Name: {cameraName}, Server Software Version is: {serverVersion}")

{deapi-5.3b3 → deapi-5.3b4}/deapi/tests/original_tests/03_hwBinning.py

@@ -8,9 +8,6 @@ from deapi.tests.original_tests import func, propertyName
 # Connect to the server
 deClient = DEAPI.Client()
 deClient.Connect()
-cameras = deClient.ListCameras()
-camera = cameras[0]
-deClient.SetCurrentCamera(camera)
 serverVersion = deClient.GetProperty(propertyName.PROP_SERVER_SOFTWARE_VERSION)
 cameraName = deClient.GetProperty(propertyName.PROP_CAMERA_NAME)
 print(f"Camera Name: {cameraName}, Server Software Version is: {serverVersion}")

{deapi-5.3b3 → deapi-5.3b4}/deapi/tests/original_tests/04_swBinning.py

@@ -9,9 +9,6 @@ from deapi.tests.original_tests import func, propertyName
 # Connect to the server
 deClient = DEAPI.Client()
 deClient.Connect()
-cameras = deClient.ListCameras()
-camera = cameras[0]
-deClient.SetCurrentCamera(camera)
 serverVersion = deClient.GetProperty(propertyName.PROP_SERVER_SOFTWARE_VERSION)
 cameraName = deClient.GetProperty(propertyName.PROP_CAMERA_NAME)
 print(f"Camera Name: {cameraName}, Server Software Version is: {serverVersion}")

{deapi-5.3b3 → deapi-5.3b4}/deapi/tests/original_tests/05_swhwBinning.py

@@ -9,9 +9,6 @@ from deapi.tests.original_tests import func, propertyName
 # Connect to the server
 deClient = DEAPI.Client()
 deClient.Connect()
-cameras = deClient.ListCameras()
-camera = cameras[0]
-deClient.SetCurrentCamera(camera)
 serverVersion = deClient.GetProperty(propertyName.PROP_SERVER_SOFTWARE_VERSION)
 cameraName = deClient.GetProperty(propertyName.PROP_CAMERA_NAME)
 print(f"Camera Name: {cameraName}, Server Software Version is: {serverVersion}")

{deapi-5.3b3 → deapi-5.3b4}/deapi/tests/original_tests/06_patternPixel.py

@@ -11,9 +11,6 @@ from deapi.tests.original_tests import func, propertyName
 deClient = DEAPI.Client()
 # Connect to the Server
 deClient.Connect()
-cameras = deClient.ListCameras()
-camera = cameras[0]
-deClient.SetCurrentCamera(camera)
 serverVersion = deClient.GetProperty(propertyName.PROP_SERVER_SOFTWARE_VERSION)
 cameraName = deClient.GetProperty(propertyName.PROP_CAMERA_NAME)
 print(f"Camera Name: {cameraName}, Server Software Version is: {serverVersion}")

{deapi-5.3b3 → deapi-5.3b4}/deapi/tests/original_tests/07_reference.py

@@ -9,9 +9,6 @@ from deapi.tests.original_tests import func, propertyName
 # Connect to the server
 deClient = DEAPI.Client()
 deClient.Connect()
-cameras = deClient.ListCameras()
-camera = cameras[0]
-deClient.SetCurrentCamera(camera)
 serverVersion = deClient.GetProperty(propertyName.PROP_SERVER_SOFTWARE_VERSION)
 cameraName = deClient.GetProperty(propertyName.PROP_CAMERA_NAME)
 print(f"Camera Name: {cameraName}, Server Software Version is: {serverVersion}")

{deapi-5.3b3 → deapi-5.3b4}/deapi/tests/original_tests/08_virtmask.py

@@ -10,9 +10,6 @@ from deapi.tests.original_tests import func, propertyName
 # Connect to the server
 deClient = DEAPI.Client()
 deClient.Connect()
-cameras = deClient.ListCameras()
-camera = cameras[0]
-deClient.SetCurrentCamera(camera)
 serverVersion = deClient.GetProperty(propertyName.PROP_SERVER_SOFTWARE_VERSION)
 cameraName = deClient.GetProperty(propertyName.PROP_CAMERA_NAME)
 print(f"Camera Name: {cameraName}, Server Software Version is: {serverVersion}")

{deapi-5.3b3 → deapi-5.3b4}/deapi/tests/original_tests/09_scanRoi.py

@@ -8,9 +8,6 @@ from deapi.tests.original_tests import func, propertyName
 # Connect to the server
 deClient = DEAPI.Client()
 deClient.Connect()
-cameras = deClient.ListCameras()
-camera = cameras[0]
-deClient.SetCurrentCamera(camera)
 serverVersion = deClient.GetProperty(propertyName.PROP_SERVER_SOFTWARE_VERSION)
 cameraName = deClient.GetProperty(propertyName.PROP_CAMERA_NAME)
 print(f"Camera Name: {cameraName}, Server Software Version: {serverVersion}")

{deapi-5.3b3 → deapi-5.3b4}/deapi/tests/original_tests/10_imageStatistics.py

@@ -1,3 +1,4 @@
+import math
 import sys
 import unittest
 import deapi as DEAPI
@@ -22,8 +23,6 @@ from deapi.tests.original_tests import func, propertyName
 
 deClient = DEAPI.Client()
 deClient.Connect()
-cameras = deClient.ListCameras()
-camera = cameras[0]
 
 serverVersion = deClient.GetProperty(propertyName.PROP_SERVER_SOFTWARE_VERSION)
 cameraName = deClient.GetProperty(propertyName.PROP_CAMERA_NAME)
@@ -75,8 +74,7 @@ fps = 10
 numPrecision = 6
 frameCount = 1
 
-deClient.SetCurrentCamera(camera)
-# deClient.SetProperty("Test Pattern", testPattern)
+deClient.SetProperty("Test Pattern", testPattern)
 deClient.SetProperty(propertyName.PROP_INSTRUMENT_CLIENT_ADDRESS, "Manual")
 deClient.SetProperty(
     propertyName.PROP_INSTRUMENT_PROJECT_MAGNIFICATION, instrumentProjectMagnification
@@ -139,6 +137,7 @@ class Stats:
 
 
 def statisticsValueCheck(imageProcessingMode, correctionMode):
+    ret = True
     deClient.SetProperty(propertyName.PROP_IMAGE_PROCESSING_MODE, imageProcessingMode)
     deClient.SetProperty(
         propertyName.PROP_IMAGE_PROCESSING_FLATFIELD_CORRECTION, correctionMode
@@ -163,14 +162,17 @@ def statisticsValueCheck(imageProcessingMode, correctionMode):
     print(f"imagemean: {attributes.imageMean}")
     print(stats.eppix)
     print(stats.epa2)
-    # Sometimes the float number are not equal due to the
-    func.compare2FloatValue(stats.eppix, attributes.eppix, numPrecision, "e-/pix")
-    func.compare2FloatValue(stats.eppixps, attributes.eppixps, numPrecision, "e-/pix/s")
-    func.compare2FloatValue(stats.eps, attributes.eps, numPrecision, "e-/s")
-    func.compare2FloatValue(stats.epa2, attributes.epa2, numPrecision, "e-/a^2")
+    # precision issue, we will compare the float number with a tolerance value. The tolerance value is set to 10**-numPrecision * frameCount for e-/pix, 10**-numPrecision * fps for e-/pix/s and 10**-numPrecision * fps * numPhysicalPixels for e-/s.
+    ret &= math.isclose(stats.eppix, attributes.eppix, rel_tol=0, abs_tol=10**-numPrecision * frameCount)
+    ret &= math.isclose(stats.eppixps, attributes.eppixps, rel_tol=0, abs_tol=10**-numPrecision * fps)
+    ret &= math.isclose(stats.eps, attributes.eps, rel_tol=0, abs_tol=10**-numPrecision * fps * numPhysicalPixels)
+
+    ret &= func.compare2FloatValue(stats.epa2, attributes.epa2, numPrecision, "e-/a^2")
+    return ret
 
 
 def compareBin1Bin2(imageProcessingMode, correctionMode, swBinningFactor):
+    ret = True
     deClient.SetProperty(propertyName.PROP_IMAGE_PROCESSING_MODE, imageProcessingMode)
     deClient.SetProperty(
         propertyName.PROP_IMAGE_PROCESSING_FLATFIELD_CORRECTION, correctionMode
@@ -210,12 +212,11 @@ def compareBin1Bin2(imageProcessingMode, correctionMode, swBinningFactor):
         swBinY,
     )
 
-    func.compare2FloatValue(statsBin1.eppix, statsBin2.eppix, numPrecision, "e-/pix")
-    func.compare2FloatValue(
-        statsBin1.eppixps, statsBin2.eppixps, numPrecision, "e-/pix/s"
-    )
-    func.compare2FloatValue(statsBin1.eps, statsBin2.eps, numPrecision, "e-/s")
-    func.compare2FloatValue(statsBin1.epa2, statsBin2.epa2, numPrecision, "e-/a^2")
+    ret &= func.compare2FloatValue(statsBin1.eppix, statsBin2.eppix, numPrecision, "e-/pix")
+    ret &= func.compare2FloatValue(statsBin1.eppixps, statsBin2.eppixps, numPrecision, "e-/pix/s")
+    ret &= func.compare2FloatValue(statsBin1.eps, statsBin2.eps, numPrecision, "e-/s")
+    ret &= func.compare2FloatValue(statsBin1.epa2, statsBin2.epa2, numPrecision, "e-/a^2")
+    return ret
 
 
 class TestPatternPixelValues(unittest.TestCase):

{deapi-5.3b3 → deapi-5.3b4}/deapi/tests/original_tests/func.py

@@ -18,6 +18,8 @@ def compare2FloatValue(expectVal, actualVal, numPrecision, name):
             f"{name}: expect {round(expectVal, numPrecision)} actual {round(actualVal, numPrecision)}"
         )
         return False
+    else:
+        return True
 
 
 def writeLogFile(caseName, scriptName):

{deapi-5.3b3 → deapi-5.3b4}/deapi/tests/test_client.py

@@ -34,15 +34,6 @@ class TestClient:
     def test_client_connection(self, client):
         assert client.connected
 
-    def test_list_cameras(self, client):
-        cameras = client.list_cameras()
-        assert isinstance(cameras, list)
-
-    def test_set_current_camera(self, client):
-        cameras = client.list_cameras()
-        client.set_current_camera(cameras[0])
-        assert client.get_current_camera() == cameras[0]
-
     def test_list_properties(self, client):
         properties = client.list_properties()
         assert isinstance(properties, list)

{deapi-5.3b3 → deapi-5.3b4}/deapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deapi
-Version: 5.3b3
+Version: 5.3b4
 Summary: API for DE Server
 Author: Direct Electron
 Project-URL: Bug Reports, https://github.com/directelectron/deapi/issues

{deapi-5.3b3 → deapi-5.3b4}/pyproject.toml

@@ -25,7 +25,7 @@ dependencies = [
     "sympy",
 ]
 description = "API for DE Server"
-version = "5.3b3"
+version = "5.3b4"
 keywords = [
     "EELS",
     "STEM",