feat: add range in logs of optimization

Author: lpatiny

src/post/optimizePeaks.ts

@@ -13,7 +13,7 @@ export interface OptimizePeaksOptions {
    */
   shape?: Shape1D;
   /**
-   * Number of times the width determining if the peaks have to be grouped and therefore optimized together
+   * Number of times we should multiply the width determining if the peaks have to be grouped and therefore optimized together
    * @default 1
    */
   groupingFactor?: number;

src/post/optimizePeaksWithLogs.ts

@@ -62,6 +62,13 @@ export function optimizePeaksWithLogs(
         ? data.y.subarray(fromIndex, toIndex)
         : data.y.slice(fromIndex, toIndex);
 
+    const log = {
+      range: { from, to },
+      parameters: optimization,
+      groupSize: peakGroup.length,
+      time: Date.now() - start,
+    };
+
     if (x.length > 5) {
       const {
         iterations,
@@ -81,20 +88,17 @@ export function optimizePeaksWithLogs(
         });
       }
       logs.push({
+        ...log,
         iterations,
         error,
-        parameters: optimization,
         message: 'optimization successful',
-        groupSize: peakGroup.length,
-        time: `${Date.now() - start}ms`,
       });
     } else {
       results = results.concat(peaks);
       logs.push({
+        ...log,
         iterations: 0,
         message: 'x length too small for optimization',
-        groupSize: peakGroup.length,
-        time: `${Date.now() - start}ms`,
       });
     }
   });