Computing registry mechanism: a step further, still a lot to do

Author: PierreRaybaut

cdl/computation/base.py

@@ -157,6 +157,10 @@ class FFTParam(gds.DataSet):
 
     shift = gds.BoolItem(_("Shift"), help=_("Shift zero frequency to center"))
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.shift = Conf.proc.fft_shift_enabled.get()
+
 
 class SpectrumParam(gds.DataSet):
     """Spectrum parameters"""
@@ -235,14 +239,14 @@ def dst_n_to_1(
     """
     if not isinstance(src_list, list) or len(src_list) <= 1:
         raise ValueError("src_list must be a list of at least 2 objects")
-    all_sigs = all([isinstance(obj, SignalObj) for obj in src_list])
-    all_imgs = all([isinstance(obj, ImageObj) for obj in src_list])
+    all_sigs = all(isinstance(obj, SignalObj) for obj in src_list)
+    all_imgs = all(isinstance(obj, ImageObj) for obj in src_list)
     if not (all_sigs or all_imgs):
         raise ValueError("src_list must be a list of SignalObj or ImageObj objects")
     title = f"{name}({', '.join([obj.short_id for obj in src_list])})"
     if suffix:  # suffix may be None or an empty string
         title += "|" + suffix
-    if any([is_complex_dtype(obj.data.dtype) for obj in src_list]):
+    if any(is_complex_dtype(obj.data.dtype) for obj in src_list):
         dst_dtype = complex
     else:
         dst_dtype = float

cdl/computation/image/__init__.py

@@ -389,6 +389,10 @@ class FlatFieldParam(BaseProcParam):
 
     threshold = gds.FloatItem(_("Threshold"), default=0.0)
 
+    def update_from_obj(self, obj: ImageObj) -> None:
+        """Update parameters from image"""
+        self.set_from_datatype(obj.data.dtype)
+
 
 def compute_flatfield(src1: ImageObj, src2: ImageObj, p: FlatFieldParam) -> ImageObj:
     """Compute flat field correction with :py:func:`cdl.algorithms.image.flatfield`
@@ -951,7 +955,7 @@ def __init__(self, *args, **kwargs) -> None:
         super().__init__(*args, **kwargs)
         self.__obj: ImageObj | None = None
 
-    def update_from_image(self, obj: ImageObj) -> None:
+    def update_from_obj(self, obj: ImageObj) -> None:
         """Update parameters from image"""
         self.__obj = obj
         self.x0 = obj.xc
@@ -1260,7 +1264,7 @@ def __init__(self, *args, **kwargs) -> None:
         super().__init__(*args, **kwargs)
         self.__obj: ImageObj | None = None
 
-    def update_from_image(self, obj: ImageObj) -> None:
+    def update_from_obj(self, obj: ImageObj) -> None:
         """Update parameters from image"""
         self.__obj = obj
         self.choice_callback(None, self.strategy)

cdl/computation/signal.py

@@ -828,7 +828,7 @@ def get_nyquist_frequency(obj: SignalObj) -> float:
         fs = float(obj.x.size - 1) / (obj.x[-1] - obj.x[0])
         return fs / 2.0
 
-    def update_from_signal(self, obj: SignalObj) -> None:
+    def update_from_obj(self, obj: SignalObj) -> None:
         """Update the filter parameters from a signal object
 
         Args:
@@ -919,19 +919,71 @@ def compute_filter(src: SignalObj, p: BaseHighLowBandParam) -> SignalObj:
     return dst
 
 
+def compute_lowpass(src: SignalObj, p: LowPassFilterParam) -> SignalObj:
+    """Compute low-pass filter with :py:func:`scipy.signal.filtfilt`
+
+    Args:
+        src: source signal
+        p: parameters
+
+    Returns:
+        Result signal object
+    """
+    return compute_filter(src, p)
+
+
+def compute_highpass(src: SignalObj, p: HighPassFilterParam) -> SignalObj:
+    """Compute high-pass filter with :py:func:`scipy.signal.filtfilt`
+
+    Args:
+        src: source signal
+        p: parameters
+
+    Returns:
+        Result signal object
+    """
+    return compute_filter(src, p)
+
+
+def compute_bandpass(src: SignalObj, p: BandPassFilterParam) -> SignalObj:
+    """Compute band-pass filter with :py:func:`scipy.signal.filtfilt`
+
+    Args:
+        src: source signal
+        p: parameters
+
+    Returns:
+        Result signal object
+    """
+    return compute_filter(src, p)
+
+
+def compute_bandstop(src: SignalObj, p: BandStopFilterParam) -> SignalObj:
+    """Compute band-stop filter with :py:func:`scipy.signal.filtfilt`
+
+    Args:
+        src: source signal
+        p: parameters
+
+    Returns:
+        Result signal object
+    """
+    return compute_filter(src, p)
+
+
 class ZeroPadding1DParam(gds.DataSet):
     """Zero padding parameters"""
 
     def __init__(self, *args, **kwargs) -> None:
         super().__init__(*args, **kwargs)
         self.__obj: SignalObj | None = None
 
-    def update_from_signal(self, obj: SignalObj) -> None:
+    def update_from_obj(self, obj: SignalObj) -> None:
         """Update parameters from signal"""
         self.__obj = obj
         self.choice_callback(None, self.strategy)
 
-    def choice_callback(self, item, value):
+    def choice_callback(self, item, value):  # pylint: disable=unused-argument
         """Callback for choice item"""
         size = self.__obj.x.size
         if value == "next_pow2":
@@ -1176,6 +1228,17 @@ class ResamplingParam(InterpolationParam):
         "display", active=gds.FuncProp(_prop, lambda x: x == "nbpts")
     )
 
+    def update_from_obj(self, obj: SignalObj) -> None:
+        """Update parameters from a signal object."""
+        if self.xmin is None:
+            self.xmin = obj.x[0]
+        if self.xmax is None:
+            self.xmax = obj.x[-1]
+        if self.dx is None:
+            self.dx = obj.x[1] - obj.x[0]
+        if self.nbpts is None:
+            self.nbpts = len(obj.x)
+
 
 def compute_resampling(src: SignalObj, p: ResamplingParam) -> SignalObj:
     """Resample data with :py:func:`cdl.algorithms.signal.interpolate`
@@ -1229,7 +1292,7 @@ def compute_detrending(src: SignalObj, p: DetrendingParam) -> SignalObj:
     return dst
 
 
-def compute_XY_mode(src1: SignalObj, src2: SignalObj) -> SignalObj:
+def compute_xy_mode(src1: SignalObj, src2: SignalObj) -> SignalObj:
     """Simulate the X-Y mode of an oscilloscope.
 
     Use the first signal as the X-axis and the second signal as the Y-axis.