Minor bugs and doc fixes

Author: AlexShkarin

docs/dataproc.rst

@@ -100,6 +100,7 @@ There are several functions present for filtering the data to smooth it or reduc
 
     - Next are convolution filters which operate by convolving the trace with a given kernel function. These involve :func:`.filters.gaussian_filter` (and :func:`.filters.gaussian_filter_nd`, which is simply a wrapper around :func:`scipy.ndimage.gaussian_filter`), and a more generic :func:`.filters.convolution_filter`. Related are infinite impulse response (IIR) filter :func:`.filters.low_pass_filter` and :func:`.filters.high_pass_filter`, which mimic standard single-pole low-pass and high-pass filters. In principle, they can be modelled as a convolution with an exponential decay, but the implementation using the recursive filters is more efficient for large widths.
     - Finally, there are Fourier filters, which Fourier-transform the trace, scale the transform values, and transform it back to the real domain. These involve the main function :func:`.filters.fourier_filter`, which takes a generic frequency response function, as well as two specific response function generators :func:`.filters.fourier_filter_bandpass` and :func:`.filters.fourier_filter_bandstop`, both generating hard frequency cutoff filters.
+    - In addition to "post-processing" filters described above, there are also "real-time" filters which serve to fitler data as it is acquired, e.g., to filter out temporary noise or spikes. There are two filters of this kind: :class:`.filters.RunningDecimationFilter` and :class:`.filters.RunningDebounceFilter`. They are implemented as classes, and both have methods to add a new datapoint, to get the current filter value, and to reset the filter.
 
 
 .. _dataproc_fourier:

pylablib/core/dataproc/filters.py

@@ -196,9 +196,8 @@ def _sliding_func(trace, filtering_function, width, mode="reflect", cval=0.):
     if width is None or width<=1:
         return trace
     l=len(trace)
-    width=(int(width)//2)*2+1
-    trace=utils.pad_trace(np.asarray(trace),pad=width//2,mode=mode,cval=cval)
-    return np.array([filtering_function(trace[i-width//2:i+width//2+1]) for i in range(width//2,l+width//2)])
+    trace=utils.pad_trace(np.asarray(trace),pad=(width-1)//2,mode=mode,cval=cval)
+    return np.array([filtering_function(trace[i-width//2:i+(width+1)//2]) for i in range(width//2,l+width//2)])
 
 def sliding_filter(trace, n, dec="bin", mode="reflect", cval=0.):
     """
@@ -604,24 +603,32 @@ def __init__(self, n, precision=None, initial=None):
         self.initial=initial
         self.value=self.initial
         self._candidate=None
-        self._cnt=0
+        self._cnt=None
     def get(self):
         """Get the filtered result"""
         return self.value
+    def _newval(self, v, x):
+        return abs(x-v)>self.precision if self.precision is not None else x!=v
     def add(self, x):
         """Add a new sample"""
         if self.value is None:
-            self.value=self._candidate=x
+            self.value=x
         else:
-            cont=abs(x-self._candidate)<self.precision if self.precision is not None else x==self._candidate
-            if cont:
-                self._cnt+=1
-            else:
-                self._cnt=0
-                self._candidate=x
-            if self._cnt+1>=self.n:
-                self.value=self._candidate=x
+            newc=self._newval(x,self._candidate) if self._candidate is not None else True
+            if newc:
                 self._cnt=0
+                self._candidate=None
+            if self._candidate is None:
+                newv=self._newval(x,self.value)
+                if newv:
+                    self._cnt=0
+                    self._candidate=x
+            else:
+                self._cnt+=1
+                if self._cnt>=self.n:
+                    self.value=x
+                    self._candidate=None
+                    self._cnt=0
         return self.get()
     def reset(self):
         """Reset the filter"""

pylablib/core/utils/general.py

@@ -33,6 +33,20 @@ def get_props(obj, prop_names):
     """
     return [getattr(obj,p) for p in prop_names]
 
+def getattr_multivar(obj, attrs, **kwargs):
+    """
+    Try to get an attribute of `obj` given a list `attrs` of its potential names.
+
+    If no attributes are found and ``default`` keyword argument is supplied, return this default value; otherwise, raise :exc:`AttributeError`.
+    """
+    for a in attrs:
+        try:
+            return getattr(obj,a)
+        except AttributeError:
+            pass
+    if "default" in kwargs:
+        return kwargs["default"]
+    raise AttributeError("{} object has no attributes {}".format(type(obj).__name__,attrs))
 
 
 ### Defaulting to method call in a function ###

pylablib/devices/NI/daq.py

@@ -224,15 +224,11 @@ def get_export_clock_terminal(self):
         return self._strip_channel_name(term) if term else None
 
     if nidaqmx is not None:
-        try:
-            _diff_cfg=nidaqmx.constants.TerminalConfiguration.DIFFERENTIAL  # pylint: disable=no-member
-        except AttributeError:
-            _diff_cfg=nidaqmx.constants.TerminalConfiguration.BAL_DIFF  # pylint: disable=no-member
         _voltage_input_terminal_cfgs={  "default":nidaqmx.constants.TerminalConfiguration.DEFAULT,
                                         "rse":nidaqmx.constants.TerminalConfiguration.RSE,
                                         "nrse":nidaqmx.constants.TerminalConfiguration.NRSE,
-                                        "diff":_diff_cfg,
-                                        "pseudodiff":nidaqmx.constants.TerminalConfiguration.PSEUDODIFFERENTIAL}
+                                        "diff":general.getattr_multivar(nidaqmx.constants.TerminalConfiguration,["DIFFERENTIAL","BAL_DIFF","DIFF"],default=10106),
+                                        "pseudodiff":general.getattr_multivar(nidaqmx.constants.TerminalConfiguration,["PSEUDODIFFERENTIAL","PSEUDO_DIFF"],default=12529)}
     else:
         _voltage_input_terminal_cfgs={}
     _p_voltage_input_terminal_cfg=interface.EnumParameterClass("voltage_input_terminal_cfg",_voltage_input_terminal_cfgs)

pylablib/devices/Thorlabs/elliptec.py

@@ -86,11 +86,12 @@ def get_connected_addrs(self):
         """Get a list of all connected device addresses"""
         return list(self._addrs)
     def _change_addr(self, addr, newaddr):
-        self._addrs[self._addrs.index(addr)]=newaddr
-        if self._default_addr==addr:
-            self._default_addr=newaddr
-        for d in [self._model_no,self._stage_scale,self._scale]:
-            d[newaddr]=d.pop(addr)
+        if addr in self._addrs:
+            self._addrs[self._addrs.index(addr)]=newaddr
+            if self._default_addr==addr:
+                self._default_addr=newaddr
+            for d in [self._model_no,self._stage_scale,self._scale]:
+                d[newaddr]=d.pop(addr)
     def get_default_addr(self):
         """Get the current default address"""
         return self._default_addr

tests/core/dataproc/test_dataproc.py

@@ -140,6 +140,15 @@ def asarr(data, check_index=True, l=None):
     compare_tables(filters.fourier_filter(data,resp),ffldata,decimal=6)
     resp=filters.fourier_filter_bandstop(0.1-1E-5,0.2-1E-5)
     compare_tables(filters.fourier_filter(data,resp),data-ffldata,decimal=6)
+    # Running
+    for dec in ["mean","min"]:
+        flt=filters.RunningDecimationFilter(10,mode=dec)
+        pfdata=filters.sliding_filter(adata[:,0],10,dec=dec)[5:-5]
+        rfdata=np.array([flt.add(x) for x in adata[:,0]][10:])
+        compare_tables(rfdata,pfdata,decimal=6)
+        flt.reset()
+        rfdata=np.array([flt.add(x) for x in adata[:,0]][10:])
+        compare_tables(rfdata,pfdata,decimal=6)
 
 def test_fourier(table_loader):
     builder=table_loader.builder

tox.ini

@@ -4,14 +4,15 @@
 # and then run "tox" from this directory.
 
 [tox]
-envlist = lpy{36,37,38,39}, lpy{36,37,38,39}_32
+envlist = lpy{36,37,38,39,310}, lpy{36,37,38,39}_32
 
 [testenv]
 basepython =
     lpy36: ../Distribs/Unpacked/python-3.6.8.amd64/python.exe
     lpy37: ../Distribs/Unpacked/python-3.7.7.amd64/python.exe
     lpy38: ../Distribs/Unpacked/python-3.8.9.amd64/python.exe
     lpy39: ../Distribs/Unpacked/python-3.9.4.amd64/python.exe
+    lpy310: ../Distribs/Unpacked/python-3.10.5.amd64/python.exe
     lpy36_32: ../Distribs/Unpacked/python-3.6.8/python.exe
     lpy37_32: ../Distribs/Unpacked/python-3.7.7/python.exe
     lpy38_32: ../Distribs/Unpacked/python-3.8.9/python.exe
@@ -34,6 +35,7 @@ deps =
     ft232_7: pyft232==0.7
     ft232_6: pyft232==0.6
     ft232_5: pyft232==0.5
+    visa_1_11: pyvisa<1.12
     visa_1_10: pyvisa<1.11
     visa_1_9: pyvisa<1.10
     visa_1_8: pyvisa<1.09
@@ -50,6 +52,7 @@ deps =
     np_1_17: numpy==1.17.0
     np_1_16: numpy==1.16.0
     np_1_15: numpy==1.15.0
+    scp_1_8: scipy==1.8.0
     scp_1_7: scipy==1.7.0
     scp_1_6: scipy==1.6.0
     scp_1_5: scipy==1.5.0