merged developer into feature and solved merge conflicts

python/slsdet/PatternGenerator.py

@@ -0,0 +1,226 @@
+from . import Detector, Pattern
+from .bits import setbit, clearbit
+import textwrap
+from pathlib import Path
+
+
+class PatternGenerator:
+    """
+    Class to generate a pattern for the SLS detector. Intents to as closely as possible 
+    mimic the old pattern generation in the C code.
+    """
+    def __init__(self):
+        self.pattern = Pattern()
+        self.iaddr = 0
+
+    def SB(self, *bits):
+        """
+        Set one or several bits. Change will take affect with the next PW.
+        """
+        for bit in bits:
+            self.pattern.word[self.iaddr] = setbit(bit, self.pattern.word[self.iaddr])
+        return self.pattern.word[self.iaddr]
+ 
+    def CB(self, *bits):
+        """
+        Clear one or several bits. Change will take affect with the next PW.
+        """
+        for bit in bits:
+            self.pattern.word[self.iaddr] = clearbit(bit, self.pattern.word[self.iaddr])
+        return self.pattern.word[self.iaddr]
+    
+
+    def _pw(self, verbose = False):
+        if verbose:
+            print(f'{self.iaddr:#06x} {self.pattern.word[self.iaddr]:#018x}') 
+        
+        #Limits are inclusive so we need to increment the address before writing the next word
+        self.pattern.limits[1] = self.iaddr
+        self.iaddr += 1
+        self.pattern.word[self.iaddr] = self.pattern.word[self.iaddr-1]
+
+    def PW(self, x = 1, verbose = False):
+        for i in range(x):
+            self._pw(verbose)
+            
+    # def REPEAT(self, x, verbose = False):
+    #     for i in range(x):
+    #         self._pw(verbose)
+
+    # def PW2(self, verbose = 0):
+    #     self.REPEAT(2, verbose)
+
+
+    def CLOCKS(self, bit, times = 1, length = 1, verbose = False):
+        """
+        clocks "bit" n "times", every half clock is long "length"
+        length is optional, default value is 1
+        """
+        for i in range(0, times):
+            self.SB(bit); self.PW(length, verbose)
+            self.CB(bit); self.PW(length, verbose)
+
+    def CLOCK(self, bit, length = 1, verbose = 0):
+        self.CLOCKS(bit, 1, length ,verbose)
+
+    def serializer(self, value, serInBit, clkBit, nbits, msbfirst = True, length = 1):
+        """serializer(value,serInBit,clkBit,nbits,msbfirst=1,length=1)
+        Produces the .pat file needed to serialize a word into a shift register.
+        value: value to be serialized
+        serInBit: control bit corresponding to serial in 
+        clkBit: control bit corresponding to the clock 
+        nbits: number of bits of the target register to load
+        msbfirst: if 1 pushes in the MSB first (default), 
+        if 0 pushes in the LSB first
+        length: length of all the PWs in the pattern
+        It produces no output because it modifies directly the members of the class pat via SB and CB"""
+        
+        c = value
+        self.CB(serInBit, clkBit)
+        self.PW(length) #generate initial line with clk and serIn to 0
+        
+        start = 0
+        stop = nbits
+        step = 1
+
+        if msbfirst:
+            start = nbits - 1
+            stop = -1
+            step =- 1 #reverts loop if msb has to be pushed in first
+
+        for i in range(start, stop, step):
+            if c & (1<<i): 
+                self.SB(serInBit)
+                self.PW(length)
+            else:
+                self.CB(serInBit)
+                self.PW(length)
+            self.SB(clkBit)
+            self.PW(length)
+            self.CB(clkBit)
+            self.PW(length)
+
+        self.CB(serInBit, clkBit)
+        self.PW(length) #generate final line with clk and serIn to 0   
+
+
+    #NOT IMPLEMENTED YET
+    #TODO! What should setstop do? Or can we remove it? 
+    #def setstop():    
+    #
+
+    def setoutput(self, bit):
+       self.pattern.ioctrl = setbit(bit, self.pattern.ioctrl)
+    
+    def setinput(self, bit):
+       self.pattern.ioctrl= clearbit(bit, self.pattern.ioctrl)
+    
+    #TODO! What should setclk do? Or can we remove it?
+    # def setclk(bit):
+    #    self.clkctrl=self.setbit(bit,self.clkctrl)
+
+    def setinputs(self, *args):
+       for i in args:
+          self.setinput(i)
+
+    def setoutputs(self, *args):
+      for i in args:
+         self.setoutput(i)
+        
+    #def setclks(self, *args):
+    #    for i in args:
+    #        self.setclk(i)
+
+    def setnloop(self, i, reps):
+        self.pattern.nloop[i] = reps
+
+    def setstartloop(self, i):
+        """
+        Set startloop[i] to the current address.
+        """
+        self.pattern.startloop[i] = self.iaddr
+
+    def setstoploop(self, i):
+        """
+        Set stoploop[i] to the current address.
+        """
+        self.pattern.stoploop[i] = self.iaddr
+        
+
+    def setstart(self):
+        """
+        Set start of pattern to the current address.
+        """
+        self.pattern.limits[0]=self.iaddr
+
+
+    def setstop(self,l):
+        """
+        Set stop of pattern to the current address.
+        """
+        self.pattern.limits[1] = self.iaddr
+
+        
+    def setwaitpoint(self, i):
+        """
+        Set wait[i] to the current address.
+        """
+        self.pattern.wait[i] = self.iaddr
+
+
+    def setwaittime(self, i, t):
+        """
+        Set waittime[i] to t.
+        """
+        self.pattern.waittime[i] = t
+
+
+    def setwait(self, i, t):
+        """
+        Set wait[i] to the current address and waittime[i] to t.
+        """
+        self.setwait(i)
+        self.setwaittime(i, t)
+
+    
+    def __repr__(self):
+        return textwrap.dedent(f"""\
+                            PatternBuilder:
+                                patlimits: {self.pattern.limits}
+                                startloop: {self.pattern.startloop}
+                                stoploop: {self.pattern.stoploop}
+                                nloop: {self.pattern.nloop}
+                                wait: {self.pattern.wait}
+                                waittime: {self.pattern.waittime}""")
+
+    def __str__(self):
+        return self.pattern.str()
+    
+    def print(self):
+        print(self)
+
+    def save(self, fname):
+        """Save pattern to text file"""
+        fname = str(fname) #Accept also Path objects, but C++ code needs a string
+        self.pattern.save(fname)
+
+    def load(self, fname):
+        """Load pattern from text file"""
+        fname = str(fname) #Accept also Path objects, but C++ code needs a string
+        n = self.pattern.load(fname)
+
+        #If the firs and only word is 0 we assume an empty pattern
+        if n == 1 and self.pattern.word[0] == 0:
+            n = 0
+        self.iaddr = n
+
+        #To make PW work as expected we need to set 1+last word to the last word
+        if n > 0:
+            self.pattern.word[n] = self.pattern.word[n-1]
+
+        
+    def send_to_detector(self, det):
+        """
+        Load the pattern into the detector.
+        """
+        det.setPattern(self.pattern)

python/slsdet/__init__.py

@@ -12,8 +12,9 @@ from .gotthard2 import Gotthard2
 from .moench import Moench
 from .pattern import Pattern, patternParameters
 from .gaincaps import Mythen3GainCapsWrapper
+from .PatternGenerator import PatternGenerator
 
-import _slsdet
+from . import _slsdet
 xy = _slsdet.xy
 defs = _slsdet.slsDetectorDefs
 
@@ -40,3 +41,6 @@ def read_version():
     
 __version__ = read_version()
 
+
+
+

python/slsdet/bits.py

@@ -0,0 +1,31 @@
+import numpy as np
+
+
+def setbit(bit, word):
+    if isinstance(word, np.generic):
+        mask = word.dtype.type(1)
+        mask = mask << bit
+    else:
+        mask = 1 << bit
+    return word | mask
+
+
+def setbit_arr(bit, arr):
+    arr |= arr.dtype.type(1 << bit)
+
+
+def clearbit(bit, word):
+    """
+    Clear the bit at position bit in word.
+    Two paths to avoid converting the types.  
+    """
+    if isinstance(word, np.generic):
+        mask = word.dtype.type(1)
+        mask = ~(mask << bit)
+    else:
+        mask = ~(1 << bit)
+    return word & mask
+
+
+def clearbit_arr(bit, arr):
+    arr &= arr.dtype.type(~(1 << bit))

python/slsdet/ctb.py

@@ -4,7 +4,7 @@ from .detector import Detector, freeze
 from .utils import element_if_equal
 from .dacs import DetectorDacs, NamedDacs
 from .powers import DetectorPowers, NamedPowers
-import _slsdet
+from . import _slsdet
 dacIndex = _slsdet.slsDetectorDefs.dacIndex
 from .detector_property import DetectorProperty
 

python/slsdet/dacs.py

@@ -3,7 +3,7 @@
 from .detector_property import DetectorProperty
 from functools import partial
 import numpy as np
-import _slsdet
+from . import _slsdet
 from .detector import freeze
 dacIndex = _slsdet.slsDetectorDefs.dacIndex
 class Dac(DetectorProperty):

python/slsdet/detector.py

@@ -1,8 +1,8 @@
 # SPDX-License-Identifier: LGPL-3.0-or-other
 # Copyright (C) 2021 Contributors to the SLS Detector Package
-from _slsdet import CppDetectorApi
-from _slsdet import slsDetectorDefs
-from _slsdet import IpAddr, MacAddr
+from ._slsdet import CppDetectorApi
+from ._slsdet import slsDetectorDefs
+from ._slsdet import IpAddr, MacAddr
 
 runStatus = slsDetectorDefs.runStatus
 timingMode = slsDetectorDefs.timingMode
@@ -15,7 +15,7 @@ defs = slsDetectorDefs
 
 from .utils import element_if_equal, all_equal, get_set_bits, list_to_bitmask
 from .utils import Geometry, to_geo, element, reduce_time, is_iterable, hostname_list
-from _slsdet import xy
+from ._slsdet import xy
 from .gaincaps import Mythen3GainCapsWrapper
 from . import utils as ut
 from .proxy import JsonProxy, SlowAdcProxy, ClkDivProxy, MaxPhaseProxy, ClkFreqProxy, PatLoopProxy, PatNLoopProxy, PatWaitProxy, PatWaitTimeProxy 

python/slsdet/eiger.py

@@ -11,7 +11,7 @@ Created on Wed Dec  6 11:51:18 2017
 from .detector import Detector
 from .temperature import Temperature, DetectorTemperature
 from .dacs import DetectorDacs
-import _slsdet
+from . import _slsdet
 dacIndex = _slsdet.slsDetectorDefs.dacIndex
 from .detector_property import DetectorProperty
 

python/slsdet/enums.py

@@ -15,8 +15,8 @@ if dt === detectorType.EIGER:
 """
 
 
-import _slsdet
+from . import _slsdet
 for name, cls in _slsdet.slsDetectorDefs.__dict__.items():
     if isinstance(cls, type):
-        exec(f'{name} = {cls.__module__}.{cls.__qualname__}')
+        exec(f'{name} = _slsdet.{cls.__qualname__}')
 

python/slsdet/gaincaps.py

@@ -1,6 +1,6 @@
 
 
-import _slsdet
+from . import _slsdet
 gc = _slsdet.slsDetectorDefs.M3_GainCaps
 
 

python/slsdet/gotthard2.py

@@ -11,7 +11,7 @@ from .detector import Detector, freeze
 
 # from .adcs import Adc, DetectorAdcs
 from .dacs import DetectorDacs
-import _slsdet
+from . import _slsdet
 dacIndex = _slsdet.slsDetectorDefs.dacIndex
 from .detector_property import DetectorProperty
 

python/slsdet/jungfrau.py

@@ -11,7 +11,7 @@ from .detector import Detector, freeze
 
 # from .adcs import Adc, DetectorAdcs
 from .dacs import DetectorDacs
-import _slsdet
+from . import _slsdet
 dacIndex = _slsdet.slsDetectorDefs.dacIndex
 from .detector_property import DetectorProperty
 

python/slsdet/moench.py

@@ -9,7 +9,7 @@ This file contains the specialization for the Moench detector
 
 from .detector import Detector, freeze
 from .dacs import DetectorDacs
-import _slsdet
+from . import _slsdet
 dacIndex = _slsdet.slsDetectorDefs.dacIndex
 from .detector_property import DetectorProperty
 

python/slsdet/mythen3.py

@@ -11,7 +11,7 @@ from .detector import Detector, freeze
 
 # from .adcs import Adc, DetectorAdcs
 from .dacs import DetectorDacs
-import _slsdet
+from . import _slsdet
 dacIndex = _slsdet.slsDetectorDefs.dacIndex
 gc_enums = _slsdet.slsDetectorDefs.M3_GainCaps
 from .detector_property import DetectorProperty

python/slsdet/pattern.py

@@ -1,8 +1,8 @@
 # SPDX-License-Identifier: LGPL-3.0-or-other
 # Copyright (C) 2021 Contributors to the SLS Detector Package
-import _slsdet
+from . import _slsdet
 
-from _slsdet import Pattern
+from ._slsdet import Pattern
 
 
 class patternParameters(_slsdet.patternParameters):

python/slsdet/powers.py

@@ -3,7 +3,7 @@
 from .detector_property import DetectorProperty
 from functools import partial
 import numpy as np
-import _slsdet
+from . import _slsdet
 from .detector import freeze
 dacIndex = _slsdet.slsDetectorDefs.dacIndex
 class Power(DetectorProperty):

python/slsdet/proxy.py

@@ -3,7 +3,7 @@
 from .utils import element_if_equal
 from .enums import dacIndex
 from .defines import M3_MAX_PATTERN_LEVELS, MAX_PATTERN_LEVELS
-from _slsdet import slsDetectorDefs
+from ._slsdet import slsDetectorDefs
 detectorType = slsDetectorDefs.detectorType
 
 

python/slsdet/utils.py

@@ -6,7 +6,7 @@ but not directly used in controlling the detector
 """
 
 from collections import namedtuple
-import _slsdet  #C++ lib
+from . import _slsdet  #C++ lib
 import functools
 import datetime as dt
 import pathlib