compute_n_to_1 function func takes now an object list as argument

Author: PierreRaybaut

cdl/computation/base.py

@@ -17,14 +17,13 @@
 import guidata.dataset as gds
 import numpy as np
 
+from cdl.algorithms.datatypes import is_complex_dtype
 from cdl.config import Conf, _
-from cdl.obj import ResultProperties, create_signal
+from cdl.obj import ImageObj, ResultProperties, SignalObj, create_signal
 
 if TYPE_CHECKING:
     from typing import Callable
 
-    from cdl.obj import ImageObj, SignalObj
-
 
 class ArithmeticParam(gds.DataSet):
     """Arithmetic parameters"""
@@ -205,6 +204,59 @@ def dst_1_to_1(
     return dst
 
 
+def dst_n_to_1(
+    src_list: list[SignalObj | ImageObj],
+    name: str,
+    suffix: str | None = None,
+) -> SignalObj | ImageObj:
+    """Create a result object, as returned by the callback function of the
+    :func:`cdl.core.gui.processor.base.BaseProcessor.compute_n_to_1` method
+
+    .. note::
+
+        Data of the result object is copied from the first source object
+        (`src_list[0]`). This initial data is usually replaced by the processing
+        function, but it may also be used to initialize the result object as part
+        of the processing function.
+
+    Args:
+        src_list: list of input signal or image objects
+        name: name of the processing function
+        suffix: suffix to add to the title
+
+    Returns:
+        Result signal or image object
+    """
+    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])
+    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]):
+        dst_dtype = complex
+    else:
+        dst_dtype = float
+    dst = src_list[0].copy(title=title, dtype=dst_dtype)
+    dst.roi = None
+    if not Conf.proc.keep_results.get():
+        dst.delete_results()  # Remove any previous results
+    for src_obj in src_list:
+        if Conf.proc.keep_results.get():
+            dst.update_resultshapes_from(src_obj)
+        if src_obj.roi is not None:
+            if dst.roi is None:
+                dst.roi = src_obj.roi.copy()
+            else:
+                roi = dst.roi
+                roi.add_roi(src_obj.roi)
+                dst.roi = roi
+    return dst
+
+
 def dst_n1n(
     src1: SignalObj | ImageObj,
     src2: SignalObj | ImageObj,

cdl/computation/image/__init__.py

@@ -44,6 +44,7 @@
     calc_resultproperties,
     dst_1_to_1,
     dst_n1n,
+    dst_n_to_1,
     new_signal_result,
 )
 from cdl.config import Conf, _
@@ -167,33 +168,52 @@ def dst_1_to_1_signal(src: ImageObj, name: str, suffix: str | None = None) -> Si
 # the modified object from the worker processes.
 
 
-def compute_addition(dst: ImageObj, src: ImageObj) -> ImageObj:
-    """Add **dst** and **src** images and return **dst** image modified in place
+def compute_addition(src_list: list[ImageObj]) -> ImageObj:
+    """Add images in the list and return the result image object
 
     Args:
-        dst: output image object
-        src: input image object
+        src_list: list of input image objects
 
     Returns:
         Output image object (modified in place)
     """
-    dst.data = np.add(dst.data, src.data, dtype=float)
-    restore_data_outside_roi(dst, src)
+    dst = dst_n_to_1(src_list, "Σ")  # `dst` data is initialized to `src_list[0]` data
+    for src in src_list[1:]:
+        dst.data = np.add(dst.data, src.data, dtype=float)
+    restore_data_outside_roi(dst, src_list[0])
     return dst
 
 
-def compute_product(dst: ImageObj, src: ImageObj) -> ImageObj:
-    """Multiply **dst** and **src** images and return **dst** image modified in place
+def compute_average(src_list: list[ImageObj]) -> ImageObj:
+    """Compute the average of images in the list and return the result image object
 
     Args:
-        dst: output image object
-        src: input image object
+        src_list: list of input image objects
 
     Returns:
         Output image object (modified in place)
     """
-    dst.data = np.multiply(dst.data, src.data, dtype=float)
-    restore_data_outside_roi(dst, src)
+    dst = dst_n_to_1(src_list, "µ")  # `dst` data is initialized to `src_list[0]` data
+    for src in src_list[1:]:
+        dst.data = np.add(dst.data, src.data, dtype=float)
+    dst.data /= len(src_list)
+    restore_data_outside_roi(dst, src_list[0])
+    return dst
+
+
+def compute_product(src_list: list[ImageObj]) -> ImageObj:
+    """Multiply images in the list and return the result image object
+
+    Args:
+        src_list: list of input image objects
+
+    Returns:
+        Output image object (modified in place)
+    """
+    dst = dst_n_to_1(src_list, "Π")  # `dst` data is initialized to `src_list[0]` data
+    for src in src_list[1:]:
+        dst.data = np.multiply(dst.data, src.data, dtype=float)
+    restore_data_outside_roi(dst, src_list[0])
     return dst
 
 

cdl/computation/signal.py

@@ -39,6 +39,7 @@
     calc_resultproperties,
     dst_1_to_1,
     dst_n1n,
+    dst_n_to_1,
     new_signal_result,
 )
 from cdl.config import Conf, _
@@ -138,37 +139,58 @@ def __call__(self, src: SignalObj) -> SignalObj:
 # the modified object from the worker processes.
 
 
-def compute_addition(dst: SignalObj, src: SignalObj) -> SignalObj:
-    """Add **dst** and **src** signals and return **dst** signal modified in place
+def compute_addition(src_list: list[SignalObj]) -> SignalObj:
+    """Add **src** signals and return a new result signal object
 
     Args:
-        dst: destination signal
-        src: source signal
+        src_list: list of source signals
 
     Returns:
         Modified **dst** signal (modified in place)
     """
-    dst.y += np.array(src.y, dtype=dst.y.dtype)
-    if dst.dy is not None:
-        dst.dy = np.sqrt(dst.dy**2 + src.dy**2)
-    restore_data_outside_roi(dst, src)
+    dst = dst_n_to_1(src_list, "Σ")  # `dst` data is initialized to `src_list[0]` data
+    for src in src_list[1:]:
+        dst.y += np.array(src.y, dtype=dst.y.dtype)
+        if dst.dy is not None:
+            dst.dy = np.sqrt(dst.dy**2 + src.dy**2)
+    restore_data_outside_roi(dst, src_list[0])
     return dst
 
 
-def compute_product(dst: SignalObj, src: SignalObj) -> SignalObj:
-    """Multiply **dst** and **src** signals and return **dst** signal modified in place
+def compute_average(src_list: list[SignalObj]) -> SignalObj:
+    """Average **src** signals and return a new result signal object
 
     Args:
-        dst: destination signal
-        src: source signal
+        src_list: list of source signals
 
     Returns:
         Modified **dst** signal (modified in place)
     """
-    dst.y *= np.array(src.y, dtype=dst.y.dtype)
-    if dst.dy is not None:
-        dst.dy = dst.y * np.sqrt((dst.dy / dst.y) ** 2 + (src.dy / src.y) ** 2)
-    restore_data_outside_roi(dst, src)
+    dst = dst_n_to_1(src_list, "µ")  # `dst` data is initialized to `src_list[0]` data
+    for src in src_list[1:]:
+        dst.y += np.array(src.y, dtype=dst.y.dtype)
+        if dst.dy is not None:
+            dst.dy = np.sqrt(dst.dy**2 + src.dy**2)
+    dst.y /= len(src_list)
+    restore_data_outside_roi(dst, src_list[0])
+    return dst
+
+
+def compute_product(src_list: list[SignalObj]) -> SignalObj:
+    """Multiply **dst** by **src** signals and return a new result signal object
+
+    Args:
+        src_list: list of source signals
+
+    Returns:
+        Modified **dst** signal (modified in place)
+    """
+    dst = dst_n_to_1(src_list, "Π")  # `dst` data is initialized to `src_list[0]` data
+    for src in src_list[1:]:
+        dst.y *= np.array(src.y, dtype=dst.y.dtype)
+        if dst.dy is not None:
+            dst.dy = dst.y * np.sqrt((dst.dy / dst.y) ** 2 + (src.dy / src.y) ** 2)
+    restore_data_outside_roi(dst, src_list[0])
     return dst