Fix: ensure analysis results are cleared when processing signals or images

Fix #136

Author: PierreRaybaut

CHANGELOG.md

@@ -10,6 +10,9 @@ See DataLab [roadmap page](https://datalab-platform.com/en/contributing/roadmap.
 
 🛠️ Bug fixes:
 
+* Fixed [Issue #136](https://github.com/DataLab-Platform/DataLab/issues/136) - When processing a signal or an image, the analysis result is kept from original object
+  * Before this fix, when processing a signal or an image (e.g. when applying a filter, a threshold, etc.), the analysis result was kept from the original object, and was not updated with the new data. Thus the analysis result was not meaningful anymore, and was misleading the user.
+  * This is now fixed: the analysis result is now removed when processing a signal or an image. However it is not recalculated automatically, because there is no way to know which analysis result should be recalculated (e.g. if the user has applied a filter, should the FWHM be recalculated?) - besides, the current implementation of the analysis features does not allow to recalculate the analysis results automatically when the data is modified. The user has to recalculate the analysis results manually if needed.
 * Fixed [Issue #132](https://github.com/DataLab-Platform/DataLab/issues/132) - Plot analysis results: "One curve per result title" mode ignores ROIs
   * Before this fix, the "One curve per result title" mode was ignoring ROIs, and was plotting the selected result for all objects (signals or images) without taking into account the ROI defined on the objects
   * This is now fixed: the "One curve per result title" mode now takes into account the ROI defined on the objects, and plots the selected result for each object (signal or image) and for each ROI defined on the object

cdl/computation/base.py

@@ -199,7 +199,9 @@ def dst_11(
             title += "|"
     if suffix:  # suffix may be None or an empty string
         title += suffix
-    return src.copy(title=title)
+    dst = src.copy(title=title)
+    dst.delete_results()  # Remove any previous results
+    return dst
 
 
 def dst_n1n(
@@ -225,7 +227,9 @@ def dst_n1n(
         title = f"{name}({src1.short_id}, {src2.short_id})"
     if suffix is not None:
         title += "|" + suffix
-    return src1.copy(title=title)
+    dst = src1.copy(title=title)
+    dst.delete_results()  # Remove any previous results
+    return dst
 
 
 def new_signal_result(

cdl/computation/image/__init__.py

@@ -289,6 +289,7 @@ def compute_arithmetic(src1: ImageObj, src2: ImageObj, p: ArithmeticParam) -> Im
     initial_dtype = src1.data.dtype
     title = p.operation.replace("obj1", src1.short_id).replace("obj2", src2.short_id)
     dst = src1.copy(title=title)
+    dst.delete_results()  # Remove any previous results
     o, a, b = p.operator, p.factor, p.constant
     # Apply operator
     if o in ("×", "/") and a == 0.0:

cdl/computation/signal.py

@@ -251,6 +251,7 @@ def compute_arithmetic(
     initial_dtype = src1.xydata.dtype
     title = p.operation.replace("obj1", src1.short_id).replace("obj2", src2.short_id)
     dst = src1.copy(title=title)
+    dst.delete_results()  # Remove any previous results
     o, a, b = p.operator, p.factor, p.constant
     if o in ("×", "/") and a == 0.0:
         dst.y = np.ones_like(src1.y) * b

cdl/core/gui/processor/base.py

@@ -624,6 +624,7 @@ def compute_n1(
                     src_dtype = src_obj1.data.dtype
                     dst_dtype = complex if is_complex_dtype(src_dtype) else float
                     dst_obj = src_obj1.copy(dtype=dst_dtype)
+                    dst_obj.delete_results()  # Remove any previous results
                     src_objs_pair = [src_obj1]
                     for src_gid in src_gids[1:]:
                         src_obj = src_objs[src_gid][i_pair]
@@ -672,6 +673,7 @@ def compute_n1(
                         src_dtypes[src_gid] = src_dtype = src_obj.data.dtype
                         dst_dtype = complex if is_complex_dtype(src_dtype) else float
                         dst_objs[src_gid] = dst_obj = src_obj.copy(dtype=dst_dtype)
+                        dst_obj.delete_results()  # Remove any previous results
                         dst_obj.roi = None
                         src_objs[src_gid] = [src_obj]
                     else:

scripts/gettext_scan.bat

@@ -9,6 +9,6 @@ call %FUNC% GetVersion CDL_VERSION
 
 set BUILDDIR=%SCRIPTPATH%\..\build\gettext
 cd %SCRIPTPATH%\..\doc
-sphinx-build . %BUILDDIR% -b gettext
-sphinx-intl update -p %BUILDDIR% -l fr --no-obsolete -w 0
+@REM sphinx-build . %BUILDDIR% -b gettext
+@REM sphinx-intl update -p %BUILDDIR% -l fr --no-obsolete -w 0
 call %~dp0gettext rescan