1001/python cmd for roi (#1362)
All checks were successful
Build on RHEL9 / build (push) Successful in 3m0s
Build on RHEL8 / build (push) Successful in 5m9s

* added typecaster for slsdefs::ROI and added setter and getter for ROI

* API also allows single sequence for single ROI

* clear_rx_roi accessible from python API

* added tests

* release notes is a markdown file

* wrapped virtual detector setup in a test fixture

* updated release

* added colorama in github workflows

* disable user id and port test

* changed format to clang-format 17

* formatted with clang format 12

* fixed virtual detector test scripts

* Code Review

* another bug for xilinx in test script

* rx_roi also accepts sequence of 2 ints

* removed tests for eiger

---------

Co-authored-by: Alice <alice.mazzoleni@psi.ch>
This commit is contained in:
2026-01-21 11:06:52 +01:00
committed by GitHub
parent 54e4c46f02
commit ae2e674772
13 changed files with 569 additions and 572 deletions

View File

@@ -24,6 +24,7 @@ import datetime as dt
from functools import wraps
from collections import namedtuple
from collections.abc import Sequence
import socket
import numpy as np
@@ -301,6 +302,46 @@ class Detector(CppDetectorApi):
def rx_arping(self, value):
ut.set_using_dict(self.setRxArping, value)
@property
def rx_roi(self):
"""Gets the list of ROIs configured in the receiver.
Note
-----
Each ROI is represented as a tuple of (x_start, y_start, x_end, y_end). \n
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.
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 sequence of 4 ints (x_start, y_start, x_end, y_end). \n
For mythen3 or gotthard2 pass a sequence of 2 ints (x_start, x_end) \n
For multiple ROI's pass a sequence of sequence \n
Example: [[0, 100, 50, 100], [260, 270, 50,100]] \n
"""
# TODO: maybe better to accept py::object in setRxROI and handle there?
if not isinstance(rois, Sequence):
raise TypeError(
"setRxROI failed: expected a tuple/list of ints x_min, x_max, y_min, y_max "
"or a sequence of such."
)
if(not isinstance(rois[0], Sequence)):
self.setRxROI([rois])
else:
self.setRxROI(rois)
def rx_clearroi(self):
"""Clears all the ROIs configured in the receiver."""
self.clearRxROI()
@property
@element