feat: 2d apodization

refactor: hide the 2D apodization feature behind the experimental flag

package.json

@@ -88,7 +88,7 @@
     "ml-tree-similarity": "^2.2.0",
     "multiplet-analysis": "^2.1.2",
     "nmr-correlation": "^2.3.3",
-    "nmr-load-save": "^2.0.4",
+    "nmr-load-save": "^2.1.0",
     "nmr-processing": "^14.0.3",
     "nmredata": "^0.9.11",
     "numeral": "^2.0.6",

src/component/header/Header.tsx

@@ -31,6 +31,8 @@ import { options } from '../toolbar/ToolTypes.js';
 import { AutoPeakPickingOptionPanel } from './AutoPeakPickingOptionPanel.js';
 import { HeaderWrapper } from './HeaderWrapper.js';
 import RangesPickingOptionPanel from './RangesPickingOptionPanel.js';
+import { SimpleApodizationDimensionOneOptionsPanel } from './SimpleApodizationDimensionOneOptionsPanel.js';
+import { SimpleApodizationDimensionTwoOptionsPanel } from './SimpleApodizationDimensionTwoOptionsPanel.js';
 import { SimpleApodizationOptionsPanel } from './SimpleApodizationOptionsPanel.js';
 import { SimpleBaseLineCorrectionOptionsPanel } from './SimpleBaseLineCorrectionOptionsPanel.js';
 import { SimplePhaseCorrectionOptionsPanel } from './SimplePhaseCorrectionOptionsPanel.js';
@@ -104,6 +106,10 @@ function HeaderInner(props: HeaderInnerProps) {
     switch (selectedOptionPanel) {
       case options.apodization.id:
         return <SimpleApodizationOptionsPanel />;
+      case options.apodizationDimension1.id:
+        return <SimpleApodizationDimensionOneOptionsPanel />;
+      case options.apodizationDimension2.id:
+        return <SimpleApodizationDimensionTwoOptionsPanel />;
       case options.zeroFilling.id:
         return <SimpleZeroFillingOptionsPanel />;
       case options.phaseCorrection.id:

src/component/header/SimpleApodizationDimensionOneOptionsPanel.tsx

@@ -0,0 +1,54 @@
+import { memo, useCallback } from 'react';
+
+import type { ExtractFilterEntry } from '../../data/types/common/ExtractFilterEntry.js';
+import { useDispatch } from '../context/DispatchContext.js';
+import { useFilter } from '../hooks/useFilter.js';
+
+import { BaseSimpleApodizationOptionsPanel } from './BaseSimpleApodizationOptionsPanel.js';
+
+interface ApodizationOptionsInnerPanelProps {
+  filter: ExtractFilterEntry<'apodizationDimension1'> | null;
+}
+
+function ApodizationOptionsInnerPanel(
+  props: ApodizationOptionsInnerPanelProps,
+) {
+  const dispatch = useDispatch();
+
+  const applyHandler = useCallback(
+    (data) => {
+      const { options } = data;
+      dispatch({
+        type: 'APPLY_APODIZATION_DIMENSION_ONE_FILTER',
+        payload: { options },
+      });
+    },
+    [dispatch],
+  );
+  const changeHandler = useCallback(
+    (data) => {
+      const { livePreview, options } = data;
+
+      dispatch({
+        type: 'CALCULATE_APODIZATION_DIMENSION_ONE_FILTER',
+        payload: { livePreview, options: structuredClone(options) },
+      });
+    },
+    [dispatch],
+  );
+
+  return (
+    <BaseSimpleApodizationOptionsPanel
+      filter={props.filter}
+      onApplyDispatch={applyHandler}
+      onChangeDispatch={changeHandler}
+    />
+  );
+}
+
+const MemoizedApodizationPanel = memo(ApodizationOptionsInnerPanel);
+
+export function SimpleApodizationDimensionOneOptionsPanel() {
+  const filter = useFilter('apodizationDimension1');
+  return <MemoizedApodizationPanel filter={filter} />;
+}

src/component/header/SimpleApodizationDimensionTwoOptionsPanel.tsx

@@ -0,0 +1,54 @@
+import { memo, useCallback } from 'react';
+
+import type { ExtractFilterEntry } from '../../data/types/common/ExtractFilterEntry.js';
+import { useDispatch } from '../context/DispatchContext.js';
+import { useFilter } from '../hooks/useFilter.js';
+
+import { BaseSimpleApodizationOptionsPanel } from './BaseSimpleApodizationOptionsPanel.js';
+
+interface ApodizationOptionsInnerPanelProps {
+  filter: ExtractFilterEntry<'apodizationDimension2'> | null;
+}
+
+function ApodizationOptionsInnerPanel(
+  props: ApodizationOptionsInnerPanelProps,
+) {
+  const dispatch = useDispatch();
+
+  const applyHandler = useCallback(
+    (data) => {
+      const { options } = data;
+      dispatch({
+        type: 'APPLY_APODIZATION_DIMENSION_TWO_FILTER',
+        payload: { options },
+      });
+    },
+    [dispatch],
+  );
+  const changeHandler = useCallback(
+    (data) => {
+      const { livePreview, options } = data;
+
+      dispatch({
+        type: 'CALCULATE_APODIZATION_DIMENSION_TWO_FILTER',
+        payload: { livePreview, options: structuredClone(options) },
+      });
+    },
+    [dispatch],
+  );
+
+  return (
+    <BaseSimpleApodizationOptionsPanel
+      filter={props.filter}
+      onApplyDispatch={applyHandler}
+      onChangeDispatch={changeHandler}
+    />
+  );
+}
+
+const MemoizedApodizationPanel = memo(ApodizationOptionsInnerPanel);
+
+export function SimpleApodizationDimensionTwoOptionsPanel() {
+  const filter = useFilter('apodizationDimension2');
+  return <MemoizedApodizationPanel filter={filter} />;
+}

src/component/modal/setting/settings-tabs/ToolsTabContent.tsx

@@ -67,6 +67,14 @@ const LIST: ListItem[] = [
     label: 'Apodization',
     name: 'apodization',
   },
+  {
+    label: 'Apodization dimension one',
+    name: 'apodizationDimension1',
+  },
+  {
+    label: 'Apodization dimension two',
+    name: 'apodizationDimension2',
+  },
   {
     label: 'Zero filling',
     name: 'zeroFilling',

src/component/panels/filtersPanel/Filters/ApodizationDimensionOneOptionsPanel.tsx

@@ -0,0 +1,51 @@
+import { useCallback } from 'react';
+
+import type { ExtractFilterEntry } from '../../../../data/types/common/ExtractFilterEntry.js';
+import { useDispatch } from '../../../context/DispatchContext.js';
+
+import { BaseApodizationOptions } from './apodization/BaseApodizationOptions.js';
+
+import type { BaseFilterOptionsPanelProps } from './index.js';
+
+export default function ApodizationDimensionOneOptionsPanel(
+  props: BaseFilterOptionsPanelProps<
+    ExtractFilterEntry<'apodizationDimension1'>
+  >,
+) {
+  const dispatch = useDispatch();
+
+  const { filter, enableEdit = true, onCancel, onConfirm } = props;
+
+  const applyHandler = useCallback(
+    (data) => {
+      const { options } = data;
+      dispatch({
+        type: 'APPLY_APODIZATION_DIMENSION_ONE_FILTER',
+        payload: { options },
+      });
+    },
+    [dispatch],
+  );
+  const changeHandler = useCallback(
+    (data) => {
+      const { livePreview, options } = data;
+
+      dispatch({
+        type: 'CALCULATE_APODIZATION_DIMENSION_ONE_FILTER',
+        payload: { livePreview, options: structuredClone(options) },
+      });
+    },
+    [dispatch],
+  );
+
+  return (
+    <BaseApodizationOptions
+      enableEdit={enableEdit}
+      filter={filter}
+      onCancel={onCancel}
+      onConfirm={onConfirm}
+      onApplyDispatch={applyHandler}
+      onChangeDispatch={changeHandler}
+    />
+  );
+}

src/component/panels/filtersPanel/Filters/ApodizationDimensionTwoOptionsPanel.tsx

@@ -0,0 +1,51 @@
+import { useCallback } from 'react';
+
+import type { ExtractFilterEntry } from '../../../../data/types/common/ExtractFilterEntry.js';
+import { useDispatch } from '../../../context/DispatchContext.js';
+
+import { BaseApodizationOptions } from './apodization/BaseApodizationOptions.js';
+
+import type { BaseFilterOptionsPanelProps } from './index.js';
+
+export default function ApodizationDimensionTwoOptionsPanel(
+  props: BaseFilterOptionsPanelProps<
+    ExtractFilterEntry<'apodizationDimension2'>
+  >,
+) {
+  const dispatch = useDispatch();
+
+  const { filter, enableEdit = true, onCancel, onConfirm } = props;
+
+  const applyHandler = useCallback(
+    (data) => {
+      const { options } = data;
+      dispatch({
+        type: 'APPLY_APODIZATION_DIMENSION_TWO_FILTER',
+        payload: { options },
+      });
+    },
+    [dispatch],
+  );
+  const changeHandler = useCallback(
+    (data) => {
+      const { livePreview, options } = data;
+
+      dispatch({
+        type: 'CALCULATE_APODIZATION_DIMENSION_TWO_FILTER',
+        payload: { livePreview, options: structuredClone(options) },
+      });
+    },
+    [dispatch],
+  );
+
+  return (
+    <BaseApodizationOptions
+      enableEdit={enableEdit}
+      filter={filter}
+      onCancel={onCancel}
+      onConfirm={onConfirm}
+      onApplyDispatch={applyHandler}
+      onChangeDispatch={changeHandler}
+    />
+  );
+}

src/component/panels/filtersPanel/Filters/index.tsx

@@ -3,6 +3,8 @@ import { Filters1D, Filters2D } from 'nmr-processing';
 
 import type { LabelStyle } from '../../../elements/Label.js';
 
+import ApodizationDimensionOneOptionsPanel from './ApodizationDimensionOneOptionsPanel.js';
+import ApodizationDimensionTwoOptionsPanel from './ApodizationDimensionTwoOptionsPanel.js';
 import ApodizationOptionsPanel from './ApodizationOptionsPanel.js';
 import BaseLineCorrectionOptionsPanel from './BaseLineCorrectionOptionsPanel.js';
 import ExclusionZonesOptionsPanel from './ExclusionZonesOptionsPanel.js';
@@ -20,10 +22,18 @@ const {
   exclusionZones,
 } = Filters1D;
 
-const { shift2DX, shift2DY, phaseCorrectionTwoDimensions } = Filters2D;
+const {
+  shift2DX,
+  shift2DY,
+  phaseCorrectionTwoDimensions,
+  apodizationDimension1,
+  apodizationDimension2,
+} = Filters2D;
 
 export const filterOptionPanels = {
   [apodization.name]: ApodizationOptionsPanel,
+  [apodizationDimension1.name]: ApodizationDimensionOneOptionsPanel,
+  [apodizationDimension2.name]: ApodizationDimensionTwoOptionsPanel,
   [phaseCorrection.name]: PhaseCorrectionOptionsPanel,
   [zeroFilling.name]: ZeroFillingOptionsPanel,
   [phaseCorrectionTwoDimensions.name]: PhaseCorrectionTwoDimensionsOptionsPanel,

src/component/reducer/Reducer.ts

@@ -5,10 +5,7 @@ import { produce, original } from 'immer';
 import type { CorrelationData } from 'nmr-correlation';
 import { buildCorrelationData } from 'nmr-correlation';
 import type { Spectrum, ViewState } from 'nmr-load-save';
-import type {
-  BaselineCorrectionZone,
-  Apodization1DOptions,
-} from 'nmr-processing';
+import type { BaselineCorrectionZone } from 'nmr-processing';
 import type { Reducer } from 'react';
 
 import type { StateMoleculeExtended } from '../../data/molecules/Molecule.js';
@@ -169,7 +166,6 @@ export const getInitialState = (): State => ({
         zones: [],
         livePreview: true,
       },
-      apodizationOptions: {} as Apodization1DOptions,
       twoDimensionPhaseCorrection: {
         activeTraceDirection: 'horizontal',
         addTracesToBothDirections: true,
@@ -347,7 +343,6 @@ export interface State {
         options: any;
         livePreview: boolean;
       };
-      apodizationOptions: Apodization1DOptions;
       /**
        * pivot point for manual phase correction
        * @default {value:0,index:0}
@@ -463,8 +458,28 @@ function innerSpectrumReducer(draft: Draft<State>, action: Action) {
         return FiltersActions.handleShiftSpectrumAlongXAxis(draft, action);
       case 'APPLY_APODIZATION_FILTER':
         return FiltersActions.handleApplyApodizationFilter(draft, action);
+      case 'APPLY_APODIZATION_DIMENSION_ONE_FILTER':
+        return FiltersActions.handleApplyApodizationDimensionOneFilter(
+          draft,
+          action,
+        );
+      case 'APPLY_APODIZATION_DIMENSION_TWO_FILTER':
+        return FiltersActions.handleApplyApodizationDimensionTwoFilter(
+          draft,
+          action,
+        );
       case 'CALCULATE_APODIZATION_FILTER':
         return FiltersActions.handleCalculateApodizationFilter(draft, action);
+      case 'CALCULATE_APODIZATION_DIMENSION_ONE_FILTER':
+        return FiltersActions.handleCalculateApodizationDimensionOneFilter(
+          draft,
+          action,
+        );
+      case 'CALCULATE_APODIZATION_DIMENSION_TWO_FILTER':
+        return FiltersActions.handleCalculateApodizationDimensionTwoFilter(
+          draft,
+          action,
+        );
       case 'APPLY_ZERO_FILLING_FILTER':
         return FiltersActions.handleApplyZeroFillingFilter(draft, action);
       case 'CALCULATE_ZERO_FILLING_FILTER':