Code Review

RELEASE.md

@@ -35,7 +35,7 @@ This document describes the differences between v10.0.1 and v10.0.0
     -------
 
     * receiver ROI can be set from Python using command ``rx_roi``(it supports any sequence of four ints e.g. a tuple (xmin, xmax, ymin, ymax) or a sequence of such for multiple ROIS)
-    * one can clear all ROI's from Python using command ``clear_rx_roi`` 
+    * one can clear all ROI's from Python using command ``rx_clearroi`` 
 
 
 1.2.1 Breaking API

python/slsdet/detector.py

@@ -309,18 +309,23 @@ class Detector(CppDetectorApi):
         Note
         -----
         Each ROI is represented as a tuple of (x_start, y_start, x_end, y_end). \n
-        If no ROIs are configured, returns an empty list.
+        If no ROIs are configured, returns [[-1,-1,-1,-1]].
         """
         return self.getRxROI() #vector of Roi structs how represented? 
     
     @rx_roi.setter
     def rx_roi(self, rois):
-        """Sets the list of ROIs in the receiver.
+        """
+        Sets the list of ROIs in the receiver.
+        Can only set multiple ROIs at multi module level without gap pixels. If more than 1 ROI per
+        UDP port, it will throw. Setting number of udp interfaces will clear the
+        roi. Cannot be set for CTB or Xilinx CTB.  
 
         Note
         -----
-        Each ROI should be represented as a tuple of (x_start, y_start, x_end, y_end). \n
-        Example: [(0, 100, 50, 100)] \n
+        Each ROI should be represented as a sequence of 4 ints (x_start, y_start, x_end, y_end). \n
+        For multiple ROI's pass a sequence of sequence \n
+        Example: [[0, 100, 50, 100]] \n
         """
         # TODO: maybe better to accept py::object in setRxROI and handle there? 
         if not isinstance(rois, Sequence):
@@ -333,7 +338,7 @@ class Detector(CppDetectorApi):
         else:
             self.setRxROI(rois)
 
-    def clear_rx_roi(self): 
+    def rx_clearroi(self): 
         """Clears all the ROIs configured in the receiver."""
         self.clearRxROI()
 

python/tests/conftest.py

@@ -15,15 +15,11 @@ print(sys.path)
 from utils_for_test import (
     Log,
     LogLevel,
-    RuntimeException,
     cleanup,
-    startProcessInBackground,
     startReceiver,
     startDetectorVirtualServer,
-    connectToVirtualServers,
     loadConfig, 
     loadBasicSettings,
-    runProcessWithLogFile
 )
 
 def pytest_addoption(parser):

python/tests/test_pythonAPI.py

@@ -18,12 +18,12 @@ def test_rx_ROI(test_with_simulators):
 
     assert d.rx_roi == [(5,15,15,25)]
 
-    d.rx_roi = [[0,10,0,20], [5,20,410,420]] #needs to be in second module 
+    d.rx_roi = [[0,10,0,20], [5,20,410,420]] 
 
     roi = d.rx_roi
     assert roi == [(0,10,0,20), (5,20,410,420)]
 
-    d.clear_rx_roi() 
+    d.rx_clearroi() 
     roi = d.rx_roi
     assert roi == [(-1,-1,-1,-1)]