Rename compute_addition to compute_sum in image and signal processing modules for consistency

Author: PierreRaybaut

cdl/computation/image/__init__.py

@@ -168,7 +168,7 @@ 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(src_list: list[ImageObj]) -> ImageObj:
+def compute_sum(src_list: list[ImageObj]) -> ImageObj:
     """Add images in the list and return the result image object
 
     Args:

cdl/computation/signal.py

@@ -139,7 +139,7 @@ def __call__(self, src: SignalObj) -> SignalObj:
 # the modified object from the worker processes.
 
 
-def compute_addition(src_list: list[SignalObj]) -> SignalObj:
+def compute_sum(src_list: list[SignalObj]) -> SignalObj:
     """Add **src** signals and return a new result signal object
 
     Args:

cdl/core/gui/processor/image.py

@@ -54,8 +54,8 @@ def compute_normalize(self, param: cpb.NormalizeParam | None = None) -> None:
 
     @qt_try_except()
     def compute_sum(self) -> None:
-        """Compute sum with :py:func:`cdl.computation.image.compute_addition`"""
-        self.compute_n_to_1(cpi.compute_addition, title=_("Sum"))
+        """Compute sum with :py:func:`cdl.computation.image.compute_sum`"""
+        self.compute_n_to_1(cpi.compute_sum, title=_("Sum"))
 
     @qt_try_except()
     def compute_addition_constant(self, param: cpb.ConstantParam | None = None) -> None:
@@ -70,7 +70,7 @@ def compute_addition_constant(self, param: cpb.ConstantParam | None = None) -> N
 
     @qt_try_except()
     def compute_average(self) -> None:
-        """Compute average with :py:func:`cdl.computation.image.compute_addition`
+        """Compute average with :py:func:`cdl.computation.image.compute_sum`
         and dividing by the number of images"""
         self.compute_n_to_1(cpi.compute_average, title=_("Average"))
 

cdl/core/gui/processor/signal.py

@@ -39,8 +39,8 @@ class SignalProcessor(BaseProcessor[SignalROI]):
 
     @qt_try_except()
     def compute_sum(self) -> None:
-        """Compute sum with :py:func:`cdl.computation.signal.compute_addition`"""
-        self.compute_n_to_1(cps.compute_addition, title=_("Sum"))
+        """Compute sum with :py:func:`cdl.computation.signal.compute_sum`"""
+        self.compute_n_to_1(cps.compute_sum, title=_("Sum"))
 
     @qt_try_except()
     def compute_addition_constant(self, param: cpb.ConstantParam | None = None) -> None:
@@ -55,7 +55,7 @@ def compute_addition_constant(self, param: cpb.ConstantParam | None = None) -> N
 
     @qt_try_except()
     def compute_average(self) -> None:
-        """Compute average with :py:func:`cdl.computation.signal.compute_addition`
+        """Compute average with :py:func:`cdl.computation.signal.compute_sum`
         and divide by the number of signals"""
         self.compute_n_to_1(cps.compute_average, title=_("Average"))
 

cdl/tests/features/images/operation_unit_test.py

@@ -68,23 +68,23 @@ def __create_n_images(n: int = 100) -> list[cdl.obj.ImageObj]:
 
 
 @pytest.mark.validation
-def test_image_addition() -> None:
-    """Image addition test."""
-    execenv.print("*** Testing image addition:")
+def test_image_sum() -> None:
+    """Image sum test."""
+    execenv.print("*** Testing image sum:")
     for ima1, ima2 in __iterate_image_couples():
         dtype1, dtype2 = ima1.data.dtype, ima2.data.dtype
         execenv.print(f"  {dtype1} += {dtype2}: ", end="")
         exp = ima1.data.astype(float) + ima2.data.astype(float)
-        ima3 = cpi.compute_addition([ima1, ima2])
-        check_array_result("Image addition", ima3.data, exp)
+        ima3 = cpi.compute_sum([ima1, ima2])
+        check_array_result("Image sum", ima3.data, exp)
     imalist = __create_n_images()
     n = len(imalist)
-    ima3 = cpi.compute_addition(imalist)
+    ima3 = cpi.compute_sum(imalist)
     res = ima3.data
     exp = np.zeros_like(ima3.data)
     for ima in imalist:
         exp += ima.data
-    check_array_result(f"  Addition of {n} images", res, exp)
+    check_array_result(f"  Sum of {n} images", res, exp)
 
 
 @pytest.mark.validation

cdl/tests/features/signals/operation_unit_test.py

@@ -53,16 +53,16 @@ def __create_one_signal_and_constant() -> tuple[
 
 
 @pytest.mark.validation
-def test_signal_addition() -> None:
-    """Signal addition test."""
+def test_signal_sum() -> None:
+    """Signal sum test."""
     slist = __create_n_signals()
     n = len(slist)
-    s3 = cps.compute_addition(slist)
+    s3 = cps.compute_sum(slist)
     res = s3.y
     exp = np.zeros_like(s3.y)
     for s in slist:
         exp += s.y
-    check_array_result(f"Signal addition ({n} signals)", res, exp)
+    check_array_result(f"Sum of {n} signals", res, exp)
 
 
 @pytest.mark.validation
@@ -76,7 +76,7 @@ def test_signal_average() -> None:
     for s in slist:
         exp += s.y
     exp /= n
-    check_array_result(f"Signal average ({n} signals)", res, exp)
+    check_array_result(f"Average of {n} signals", res, exp)
 
 
 @pytest.mark.validation
@@ -89,7 +89,7 @@ def test_signal_product() -> None:
     exp = np.ones_like(s3.y)
     for s in slist:
         exp *= s.y
-    check_array_result(f"Signal multiplication ({n} signals)", res, exp)
+    check_array_result(f"Product of {n} signals", res, exp)
 
 
 @pytest.mark.validation

doc/locale/fr/LC_MESSAGES/api/proxy.po

@@ -578,7 +578,7 @@ msgstr ""
 msgid ":py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_average`"
 msgstr ""
 
-msgid "Compute average with :py:func:`cdl.computation.signal.compute_addition`"
+msgid "Compute average with :py:func:`cdl.computation.signal.compute_sum`"
 msgstr ""
 
 msgid ":py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_bandpass`"
@@ -917,7 +917,7 @@ msgstr ""
 msgid ":py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_sum`"
 msgstr ""
 
-msgid "Compute sum with :py:func:`cdl.computation.signal.compute_addition`"
+msgid "Compute sum with :py:func:`cdl.computation.signal.compute_sum`"
 msgstr ""
 
 msgid ":py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_swap_axes`"
@@ -1049,7 +1049,7 @@ msgstr ""
 msgid ":py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_average`"
 msgstr ""
 
-msgid "Compute average with :py:func:`cdl.computation.image.compute_addition`"
+msgid "Compute average with :py:func:`cdl.computation.image.compute_sum`"
 msgstr ""
 
 msgid ":py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_average_profile`"
@@ -1475,7 +1475,7 @@ msgstr ""
 msgid ":py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_sum`"
 msgstr ""
 
-msgid "Compute sum with :py:func:`cdl.computation.image.compute_addition`"
+msgid "Compute sum with :py:func:`cdl.computation.image.compute_sum`"
 msgstr ""
 
 msgid ":py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_swap_axes`"
@@ -1543,4 +1543,3 @@ msgstr ""
 
 msgid ":py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_zero_padding`"
 msgstr ""
-

doc/locale/fr/LC_MESSAGES/features/general/remote.po

@@ -518,13 +518,13 @@ msgstr "Lorsque vous travaillez avec des signaux, les méthodes de :class:`cdl.c
 msgid "Object handling signal processing: operations, processing, analysis"
 msgstr "Objet de traitement de signal : opérations, traitement, analyse"
 
-msgid "Compute sum with :py:func:`cdl.computation.signal.compute_addition`"
+msgid "Compute sum with :py:func:`cdl.computation.signal.compute_sum`"
 msgstr ""
 
 msgid "Compute sum with a constant with :py:func:`cdl.computation.signal.compute_addition_constant`"
 msgstr ""
 
-msgid "Compute average with :py:func:`cdl.computation.signal.compute_addition` and divide by the number of signals"
+msgid "Compute average with :py:func:`cdl.computation.signal.compute_sum` and divide by the number of signals"
 msgstr ""
 
 msgid "Compute product with :py:func:`cdl.computation.signal.compute_product`"
@@ -778,13 +778,13 @@ msgstr "Objet de traitement d'image : opérations, traitement, analyse"
 msgid "Normalize data with :py:func:`cdl.computation.image.compute_normalize`"
 msgstr ""
 
-msgid "Compute sum with :py:func:`cdl.computation.image.compute_addition`"
+msgid "Compute sum with :py:func:`cdl.computation.image.compute_sum`"
 msgstr ""
 
 msgid "Compute sum with a constant using :py:func:`cdl.computation.image.compute_addition_constant`"
 msgstr ""
 
-msgid "Compute average with :py:func:`cdl.computation.image.compute_addition` and dividing by the number of images"
+msgid "Compute average with :py:func:`cdl.computation.image.compute_sum` and dividing by the number of images"
 msgstr ""
 
 msgid "Compute product with :py:func:`cdl.computation.image.compute_product`"
@@ -1174,4 +1174,3 @@ msgstr ""
 
 msgid "Compute blob detection using OpenCV with :py:func:`cdl.computation.image.detection.compute_blob_opencv`"
 msgstr ""
-

doc/locale/fr/LC_MESSAGES/features/validation/status.po

@@ -136,7 +136,7 @@ msgstr ""
 msgid "`test_signal_abs <https://github.com/DataLab-Platform/DataLab/blob/v0.20.0/cdl/tests/features/signals/operation_unit_test.py#L132>`_"
 msgstr ""
 
-msgid ":py:func:`compute_addition <cdl.computation.signal.compute_addition>`"
+msgid ":py:func:`compute_sum <cdl.computation.signal.compute_sum>`"
 msgstr ""
 
 msgid "Add **dst** and **src** signals and return **dst** signal modified in place"
@@ -688,7 +688,7 @@ msgstr ""
 msgid "`test_image_abs <https://github.com/DataLab-Platform/DataLab/blob/v0.20.0/cdl/tests/features/images/operation_unit_test.py#L239>`_"
 msgstr ""
 
-msgid ":py:func:`compute_addition <cdl.computation.image.compute_addition>`"
+msgid ":py:func:`compute_sum <cdl.computation.image.compute_sum>`"
 msgstr ""
 
 msgid "Add **dst** and **src** images and return **dst** image modified in place"
@@ -1467,4 +1467,3 @@ msgstr ""
 
 msgid "`test_threshold_yen <https://github.com/DataLab-Platform/DataLab/blob/v0.20.0/cdl/tests/features/images/processing_unit_test.py#L253>`_"
 msgstr ""
-

doc/processor_methods_image.csv

@@ -1,5 +1,5 @@
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_abs`,Compute absolute value with :py:func:`cdl.computation.image.compute_abs`
-:py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_addition_constant`,Compute sum with a constant 
+:py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_addition_constant`,Compute sum with a constant
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_adjust_gamma`,Compute gamma correction
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_adjust_log`,Compute log correction
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_adjust_sigmoid`,Compute sigmoid correction
@@ -9,7 +9,7 @@
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_all_threshold`,Compute all threshold algorithms
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_arithmetic`,Compute arithmetic operation between two images
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_astype`,Convert data type with :py:func:`cdl.computation.image.compute_astype`
-:py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_average`,Compute average with :py:func:`cdl.computation.image.compute_addition`
+:py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_average`,Compute average with :py:func:`cdl.computation.image.compute_sum`
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_average_profile`,Compute average profile
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_binning`,Binning image with :py:func:`cdl.computation.image.compute_binning`
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_black_tophat`,Compute Black Top-Hat
@@ -43,7 +43,7 @@
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_farid_v`,Compute Farid filter (vertical)
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_fft`,Compute FFT with :py:func:`cdl.computation.image.compute_fft`
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_flatfield`,Compute flat field correction
-:py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_fliph`,Flip data horizontally 
+:py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_fliph`,Flip data horizontally
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_flipv`,Flip data vertically with :py:func:`cdl.computation.image.compute_flipv`
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_gaussian_filter`,Compute gaussian filter
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_histogram`,Compute histogram with :py:func:`cdl.computation.image.compute_histogram`
@@ -54,7 +54,7 @@
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_laplace`,Compute Laplace filter
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_line_profile`,Compute profile along a vertical or horizontal line
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_log10`,Compute Log10 with :py:func:`cdl.computation.image.compute_log10`
-:py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_logp1`,Compute base 10 logarithm 
+:py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_logp1`,Compute base 10 logarithm
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_magnitude_spectrum`,Compute magnitude spectrum
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_moving_average`,Compute moving average
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_moving_median`,Compute moving median
@@ -67,16 +67,16 @@
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_prewitt_h`,Compute Prewitt filter (horizontal)
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_prewitt_v`,Compute Prewitt filter (vertical)
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_product`,Compute product with :py:func:`cdl.computation.image.compute_product`
-:py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_product_constant`,Compute product with a constant 
+:py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_product_constant`,Compute product with a constant
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_psd`,Compute Power Spectral Density (PSD)
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_quadratic_difference`,Compute quadratic difference between two images
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_radial_profile`,Compute radial profile
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_re`,Compute real part with :py:func:`cdl.computation.image.compute_re`
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_rescale_intensity`,Rescale image intensity levels
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_resize`,Resize image with :py:func:`cdl.computation.image.compute_resize`
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_roberts`,Compute Roberts filter
-:py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_roi_extraction`,Extract Region Of Interest (ROI) from data 
-:py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_rotate`,Rotate data arbitrarily 
+:py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_roi_extraction`,Extract Region Of Interest (ROI) from data
+:py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_rotate`,Rotate data arbitrarily
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_rotate270`,Rotate data 270° with :py:func:`cdl.computation.image.compute_rotate270`
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_rotate90`,Rotate data 90° with :py:func:`cdl.computation.image.compute_rotate90`
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_scharr`,Compute Scharr filter
@@ -87,7 +87,7 @@
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_sobel_h`,Compute Sobel filter (horizontal)
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_sobel_v`,Compute Sobel filter (vertical)
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_stats`,Compute data statistics
-:py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_sum`,Compute sum with :py:func:`cdl.computation.image.compute_addition`
+:py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_sum`,Compute sum with :py:func:`cdl.computation.image.compute_sum`
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_swap_axes`,Swap data axes with :py:func:`cdl.computation.image.compute_swap_axes`
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_threshold`,Compute parametric threshold
 :py:func:`~cdl.core.gui.processor.image.ImageProcessor.compute_threshold_isodata`,Compute threshold using Isodata algorithm

doc/processor_methods_signal.csv

@@ -6,7 +6,7 @@
 :py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_allan_variance`,Compute Allan variance
 :py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_arithmetic`,Compute arithmetic operation between two signals
 :py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_astype`,Convert data type with :py:func:`cdl.computation.signal.compute_astype`
-:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_average`,Compute average with :py:func:`cdl.computation.signal.compute_addition`
+:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_average`,Compute average with :py:func:`cdl.computation.signal.compute_sum`
 :py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_bandpass`,Compute band-pass filter
 :py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_bandstop`,Compute band-stop filter
 :py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_bandwidth_3db`,Compute bandwidth at -3dB
@@ -59,11 +59,11 @@
 :py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_re`,Compute real part with :py:func:`cdl.computation.signal.compute_re`
 :py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_resampling`,Compute resampling
 :py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_reverse_x`,Reverse X axis with :py:func:`cdl.computation.signal.compute_reverse_x`
-:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_roi_extraction`,Extract Region Of Interest (ROI) from data 
+:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_roi_extraction`,Extract Region Of Interest (ROI) from data
 :py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_sampling_rate_period`,Compute sampling rate and period (mean and std)
 :py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_sqrt`,Compute square root with :py:func:`cdl.computation.signal.compute_sqrt`
 :py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_stats`,Compute data statistics
-:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_sum`,Compute sum with :py:func:`cdl.computation.signal.compute_addition`
+:py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_sum`,Compute sum with :py:func:`cdl.computation.signal.compute_sum`
 :py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_swap_axes`,Swap data axes with :py:func:`cdl.computation.signal.compute_swap_axes`
 :py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_time_deviation`,Compute time deviation
 :py:func:`~cdl.core.gui.processor.signal.SignalProcessor.compute_total_variance`,Compute total variance