Setting dac names for CTB (C++ and Python) (#413)

# Setting DAC names for CTB
* Introduced new shared memory for CTB only
* Prepared for additional functionality 
* Works from C++ and Python

Co-authored-by: Dhanya Thattil <dhanya.thattil@psi.ch>

python/slsdet/ctb.py

@@ -1,43 +1,45 @@
 # SPDX-License-Identifier: LGPL-3.0-or-other
 # Copyright (C) 2021 Contributors to the SLS Detector Package
-from .detector import Detector
+from .detector import Detector, freeze
 from .utils import element_if_equal
-from .dacs import DetectorDacs
+from .dacs import DetectorDacs, NamedDacs
 import _slsdet
 dacIndex = _slsdet.slsDetectorDefs.dacIndex
 from .detector_property import DetectorProperty
 
-class CtbDacs(DetectorDacs):
-    """
-    Ctb dacs
-    """
-    _dacs = [('dac0',  dacIndex(0), 0, 4000,    1400),
-             ('dac1',  dacIndex(1), 0, 4000,    1200),
-             ('dac2',  dacIndex(2), 0, 4000,    900),
-             ('dac3',  dacIndex(3), 0, 4000,    1050),
-             ('dac4',  dacIndex(4), 0, 4000,     1400),
-             ('dac5',  dacIndex(5), 0, 4000,    655),
-             ('dac6',  dacIndex(6), 0, 4000,    2000),
-             ('dac7',  dacIndex(7), 0, 4000,     1400),
-             ('dac8',  dacIndex(8), 0, 4000,    850),
-             ('dac9',  dacIndex(9), 0, 4000,    2000),
-             ('dac10', dacIndex(10), 0, 4000,    2294),
-             ('dac11', dacIndex(11), 0, 4000,    983),
-             ('dac12', dacIndex(12), 0, 4000,    1475),
-             ('dac13', dacIndex(13), 0, 4000,    1200),
-             ('dac14', dacIndex(14), 0, 4000,    1600),
-             ('dac15', dacIndex(15), 0, 4000,    1455),
-             ('dac16', dacIndex(16), 0, 4000,       0),
-             ('dac17', dacIndex(17), 0, 4000,    1000),
-            ]
-    _dacnames = [_d[0] for _d in _dacs]
+# class CtbDacs(DetectorDacs):
+#     """
+#     Ctb dacs
+#     """
+#     _dacs = [('dac0',  dacIndex(0), 0, 4000,    1400),
+#              ('dac1',  dacIndex(1), 0, 4000,    1200),
+#              ('dac2',  dacIndex(2), 0, 4000,    900),
+#              ('dac3',  dacIndex(3), 0, 4000,    1050),
+#              ('dac4',  dacIndex(4), 0, 4000,     1400),
+#              ('dac5',  dacIndex(5), 0, 4000,    655),
+#              ('dac6',  dacIndex(6), 0, 4000,    2000),
+#              ('dac7',  dacIndex(7), 0, 4000,     1400),
+#              ('dac8',  dacIndex(8), 0, 4000,    850),
+#              ('dac9',  dacIndex(9), 0, 4000,    2000),
+#              ('dac10', dacIndex(10), 0, 4000,    2294),
+#              ('dac11', dacIndex(11), 0, 4000,    983),
+#              ('dac12', dacIndex(12), 0, 4000,    1475),
+#              ('dac13', dacIndex(13), 0, 4000,    1200),
+#              ('dac14', dacIndex(14), 0, 4000,    1600),
+#              ('dac15', dacIndex(15), 0, 4000,    1455),
+#              ('dac16', dacIndex(16), 0, 4000,       0),
+#              ('dac17', dacIndex(17), 0, 4000,    1000),
+#             ]
+#     _dacnames = [_d[0] for _d in _dacs]
 
 from .utils import element
+@freeze
 class Ctb(Detector):
     def __init__(self, id = 0):
         super().__init__(id)
         self._frozen = False 
-        self._dacs = CtbDacs(self)
+        # self._dacs = CtbDacs(self)
+        self._dacs = NamedDacs(self)
     
     @property
     def dacs(self):

python/slsdet/dacs.py

@@ -36,6 +36,79 @@ class Dac(DetectorProperty):
         dacstr = ''.join([f'{item:5d}' for item in self.get()])
         return f'{self.__name__:15s}:{dacstr}'
 
+class NamedDacs:
+    """
+    New implementation of the detector dacs. Used at the momen for 
+    Ctb but should replace the old one for all detectors
+    """
+    _frozen = False
+    _direct_access = ['_detector', '_current', '_dacnames']
+    def __init__(self, detector):
+        self._detector = detector
+        self._current = 0
+
+        self._dacnames = [n.replace(" ", "") for n in detector.getDacNames()]
+        # # Populate the dacs
+        for i,name in enumerate(self._dacnames):
+            #name, enum, low, high, default, detector
+            setattr(self, name, Dac(name, dacIndex(i), 0, 4000, 1000, detector))
+
+        self._frozen = True
+
+    # def __getattr__(self, name):
+    #     return self.__getattribute__('_' + name)
+
+    def __setattr__(self, name, value):
+        if not self._frozen:
+            #durining init we need to be able to set up the class
+            super().__setattr__(name, value)
+        else:
+            #Later we restrict us to manipulate dacs and a few fields
+            if name in self._direct_access:
+                super().__setattr__(name, value)
+            elif name in self._dacnames:
+                return self.__getattribute__(name).__setitem__(slice(None, None, None), value)
+            else:
+                raise AttributeError(f'Dac not found: {name}')
+
+    def __next__(self):
+        if self._current >= len(self._dacnames):
+            self._current = 0
+            raise StopIteration
+        else:
+            self._current += 1
+            return self.__getattribute__(self._dacnames[self._current-1])
+            # return self.__getattr__(self._dacnames[self._current-1])
+
+    def __iter__(self):
+        return self
+
+    def __repr__(self):
+        r_str = ['========== DACS =========']
+        r_str += [repr(dac) for dac in self]
+        return '\n'.join(r_str)
+    def get_asarray(self):
+        """
+        Read the dacs into a numpy array with dimensions [ndacs, nmodules]
+        """
+        dac_array = np.zeros((len(self._dacnames), len(self._detector)))
+        for i, _d in enumerate(self):
+            dac_array[i,:] = _d[:]
+        return dac_array
+
+    def to_array(self):
+        return self.get_asarray()       
+
+    def set_from_array(self, dac_array):
+        """
+        Set the dacs from an numpy array with dac values. [ndacs, nmodules]
+        """
+        dac_array = dac_array.astype(np.int)
+        for i, _d in enumerate(self):
+            _d[:] = dac_array[i]
+
+    def from_array(self, dac_array):
+        self.set_from_array(dac_array)
 
 class DetectorDacs:
     _dacs = []
@@ -50,7 +123,7 @@ class DetectorDacs:
         # Index to support iteration
         self._current = 0
 
-        # Populate the dacs
+        # Name the attributes? 
         for _d in self._dacs:
             setattr(self, '_'+_d[0], Dac(*_d, detector))
 
@@ -59,7 +132,10 @@ class DetectorDacs:
     def __getattr__(self, name):
         return self.__getattribute__('_' + name)
 
-
+    @property
+    def dacnames(self):
+        return [_d[0] for _d in _dacs]
+        
     def __setattr__(self, name, value):
         if name in self._dacnames:
             return self.__getattribute__('_' + name).__setitem__(slice(None, None, None), value)

python/slsdet/detector.py

@@ -1571,8 +1571,16 @@ class Detector(CppDetectorApi):
 
     @property
     def daclist(self):
-        """Gets the list of enums for every dac for this detector."""
-        return self.getDacList()
+        """
+        List of enums for every dac for this detector.
+        :setter: Only implemented for Chiptestboard
+        
+        """
+        return self.getDacNames()
+
+    @daclist.setter
+    def daclist(self, value):
+        self.setDacNames(value)
 
     @property
     def dacvalues(self):

python/src/detector.cpp

@@ -1427,6 +1427,19 @@ void init_det(py::module &m) {
              (void (Detector::*)(bool, sls::Positions)) &
                  Detector::setLEDEnable,
              py::arg(), py::arg() = Positions{})
+        .def("setDacNames",
+             (void (Detector::*)(const std::vector<std::string>)) &
+                 Detector::setDacNames,
+             py::arg())
+        .def("getDacNames", (std::vector<std::string>(Detector::*)() const) &
+                                Detector::getDacNames)
+        .def("getDacIndex",
+             (defs::dacIndex(Detector::*)(const std::string &)) &
+                 Detector::getDacIndex,
+             py::arg())
+        .def("getDacName",
+             (std::string(Detector::*)(defs::dacIndex)) & Detector::getDacName,
+             py::arg())
         .def("setPattern",
              (void (Detector::*)(const std::string &, sls::Positions)) &
                  Detector::setPattern,