feat: improve signal kinds for ranges and integrals

close #2600
cheminfo · Sep 13, 2023 · a8ca174 · a8ca174
1 parent 53fff90
commit a8ca174
Show file tree

Hide file tree

Showing 15 changed files with 70 additions and 67 deletions.
diff --git a/src/component/2d/zones/IndicationLines.tsx b/src/component/2d/zones/IndicationLines.tsx
@@ -3,7 +3,7 @@ import { css } from '@emotion/react';
 import { Spectrum1D } from 'nmr-load-save';
 import { useState, useEffect, useMemo } from 'react';
 
-import { SignalKindsToInclude } from '../../../data/constants/SignalsKinds';
+import { SIGNAL_INLCUDED_KINDS } from '../../../data/constants/signalsKinds';
 import { isSpectrum1D } from '../../../data/data1d/Spectrum1D';
 import { useChartData } from '../../context/ChartContext';
 import { get2DXScale, get2DYScale } from '../utilities/scale';
@@ -52,7 +52,7 @@ function IndicationLines({ axis, show }: IndicationLinesProps) {
       const deltas = ranges.flatMap((_range) =>
         _range.signals
           .filter((_signal) =>
-            SignalKindsToInclude.includes(_signal.kind as string),
+            SIGNAL_INLCUDED_KINDS.includes(_signal.kind as string),
           )
           .map((_signal) => _signal.delta),
       );

diff --git a/src/component/panels/IntegralsPanel/IntegralTable.tsx b/src/component/panels/IntegralsPanel/IntegralTable.tsx
@@ -3,7 +3,7 @@ import { Info1D, Integral } from 'nmr-processing';
 import { useCallback, useMemo, memo } from 'react';
 import { FaRegTrashAlt } from 'react-icons/fa';
 
-import { SignalKinds } from '../../../data/constants/SignalsKinds';
+import { SIGNAL_KINDS } from '../../../data/constants/signalsKinds';
 import { checkIntegralKind } from '../../../data/data1d/Spectrum1D';
 import { useDispatch } from '../../context/DispatchContext';
 import EditableColumn from '../../elements/EditableColumn';
@@ -139,7 +139,7 @@ function IntegralTable({ activeTab, data, info }: IntegralTableProps) {
         Cell: ({ row }) => (
           <Select
             onChange={(value) => changeIntegralDataHandler(value, row)}
-            items={SignalKinds}
+            items={SIGNAL_KINDS}
             style={selectStyle}
             defaultValue={row.original.kind}
           />

diff --git a/src/component/panels/RangesPanel/TableColumns/ActionsColumn.tsx b/src/component/panels/RangesPanel/TableColumns/ActionsColumn.tsx
@@ -3,7 +3,7 @@ import { css } from '@emotion/react';
 import { Fragment, CSSProperties } from 'react';
 import { FaRegTrashAlt, FaSearchPlus, FaEdit } from 'react-icons/fa';
 
-import { SignalKinds } from '../../../../data/constants/SignalsKinds';
+import { SIGNAL_KINDS } from '../../../../data/constants/signalsKinds';
 import Select from '../../../elements/Select';
 import {
   OnHoverEvent,
@@ -64,7 +64,7 @@ function ActionsColumn({
         <td {...onHoverSignal}>
           <Select
             onChange={changeRangeSignalKind}
-            items={SignalKinds}
+            items={SIGNAL_KINDS}
             defaultValue={row.tableMetaInfo.signal.kind}
             style={selectBoxStyle}
           />

diff --git a/src/component/panels/ZonesPanel/TableColumns/ActionsColumn.tsx b/src/component/panels/ZonesPanel/TableColumns/ActionsColumn.tsx
@@ -1,7 +1,7 @@
 import { CSSProperties, Fragment, useCallback } from 'react';
 import { FaEdit, FaRegTrashAlt, FaSearchPlus } from 'react-icons/fa';
 
-import { SignalKinds } from '../../../../data/constants/SignalsKinds';
+import { SIGNAL_KINDS } from '../../../../data/constants/signalsKinds';
 import { useAssignmentData } from '../../../assignment/AssignmentsContext';
 import { useDispatch } from '../../../context/DispatchContext';
 import Select from '../../../elements/Select';
@@ -128,7 +128,7 @@ function ActionsColumn({
             onChange={(value) => {
               changeSignalKindHandler(value);
             }}
-            items={SignalKinds}
+            items={SIGNAL_KINDS}
             defaultValue={rowData.tableMetaInfo.signal.kind}
             style={selectBoxStyle}
           />

diff --git a/src/component/reducer/actions/RangesActions.ts b/src/component/reducer/actions/RangesActions.ts
@@ -6,9 +6,9 @@ import { RangesViewState, Spectrum, Spectrum1D } from 'nmr-load-save';
 import { Signal1D, Range, Filters, FiltersManager } from 'nmr-processing';
 
 import {
-  DatumKind,
-  SignalKindsToInclude,
-} from '../../../data/constants/SignalsKinds';
+  DATUM_KIND,
+  SIGNAL_INLCUDED_KINDS,
+} from '../../../data/constants/signalsKinds';
 import {
   addRange,
   changeRangeSignal,
@@ -279,9 +279,9 @@ function handleChangeRangeSignalKind(
     const _range = (draft.data[index] as Spectrum1D).ranges.values[rangeIndex];
     if (_range?.signals) {
       _range.signals[range.tableMetaInfo.signalIndex].kind = kind;
-      _range.kind = SignalKindsToInclude.includes(kind)
-        ? DatumKind.signal
-        : DatumKind.mixed;
+      _range.kind = SIGNAL_INLCUDED_KINDS.includes(kind)
+        ? DATUM_KIND.signal
+        : DATUM_KIND.mixed;
       updateRangesRelativeValues(draft.data[index] as Spectrum1D);
       handleUpdateCorrelations(draft);
     }

diff --git a/src/component/reducer/actions/ZonesActions.ts b/src/component/reducer/actions/ZonesActions.ts
@@ -7,9 +7,9 @@ import type { Signal2D, Zone } from 'nmr-processing';
 import { Filters, FiltersManager } from 'nmr-processing';
 
 import {
-  DatumKind,
-  SignalKindsToInclude,
-} from '../../../data/constants/SignalsKinds';
+  DATUM_KIND,
+  SIGNAL_INLCUDED_KINDS,
+} from '../../../data/constants/signalsKinds';
 import {
   changeZoneSignal,
   detectZones,
@@ -245,9 +245,9 @@ function handleChangeZoneSignalKind(
     const zoneIndex = getZoneIndex(state, index, zoneData.id);
     const _zone = (draft.data[index] as Spectrum2D).zones.values[zoneIndex];
     _zone.signals[zoneData.tableMetaInfo.signalIndex].kind = kind;
-    _zone.kind = SignalKindsToInclude.includes(kind)
-      ? DatumKind.signal
-      : DatumKind.mixed;
+    _zone.kind = SIGNAL_INLCUDED_KINDS.includes(kind)
+      ? DATUM_KIND.signal
+      : DATUM_KIND.mixed;
     handleUpdateCorrelations(draft);
   }
 }

diff --git a/src/data/PredictionManager.ts b/src/data/PredictionManager.ts
@@ -18,7 +18,7 @@ import {
 } from 'nmr-processing';
 import OCL from 'openchemlib/full';
 
-import { DatumKind } from './constants/SignalsKinds';
+import { DATUM_KIND } from './constants/signalsKinds';
 import {
   initiateDatum1D,
   mapRanges,
@@ -306,7 +306,7 @@ function mapZones(zones: Array<Partial<Zone>>) {
       id: v4(),
       ...resZone,
       signals: newSignals,
-      kind: DatumKind.signal,
+      kind: DATUM_KIND.signal,
     };
   });
 }

diff --git a/src/data/constants/SignalsKinds.ts b/src/data/constants/SignalsKinds.ts
diff --git a/src/data/constants/signalsKinds.ts b/src/data/constants/signalsKinds.ts
@@ -0,0 +1,26 @@
+import { stringCapitalize } from '../../utils/stringCapitalize';
+import { SignalKind } from '../types/common/SignalKind';
+
+const KINDS: SignalKind[] = [
+  'undefined',
+  'signal',
+  'reference',
+  'solvent',
+  'standard',
+  'p1',
+  'p2',
+  'p3',
+];
+
+interface SignalKindItem {
+  value: SignalKind;
+  label: string;
+}
+
+export const SIGNAL_KINDS: SignalKindItem[] = KINDS.map((key) => ({
+  value: key,
+  label: stringCapitalize(key),
+}));
+
+export const SIGNAL_INLCUDED_KINDS: SignalKind[] = ['signal'];
+export const DATUM_KIND = { signal: 'signal', mixed: 'mixed' } as const;
diff --git a/src/data/data1d/Spectrum1D/ranges/addRange.ts b/src/data/data1d/Spectrum1D/ranges/addRange.ts
@@ -3,7 +3,7 @@ import { xyIntegration } from 'ml-spectra-processing';
 import { Spectrum1D } from 'nmr-load-save';
 import { Signal1D, mapRanges } from 'nmr-processing';
 
-import { DatumKind } from '../../../constants/SignalsKinds';
+import { DATUM_KIND } from '../../../constants/signalsKinds';
 
 import detectSignal from './detectSignal';
 
@@ -24,7 +24,7 @@ export function createRangeObj({
     to,
     absolute, // the real value,
     signals: [{ id: v4(), ...signal }],
-    kind: DatumKind.signal,
+    kind: DATUM_KIND.signal,
     integration: 0,
   };
 }

diff --git a/src/data/data1d/Spectrum1D/ranges/checkRangeKind.ts b/src/data/data1d/Spectrum1D/ranges/checkRangeKind.ts
@@ -1,8 +1,8 @@
 import { Range } from 'nmr-processing';
 
-import { SignalKindsToInclude } from '../../../constants/SignalsKinds';
+import { SIGNAL_INLCUDED_KINDS } from '../../../constants/signalsKinds';
 import { checkSignalKinds } from '../../../utilities/RangeUtilities';
 
 export function checkRangeKind(range: Range): boolean {
-  return range.signals && checkSignalKinds(range, SignalKindsToInclude);
+  return range.signals && checkSignalKinds(range, SIGNAL_INLCUDED_KINDS);
 }
diff --git a/src/data/types/common/SignalKind.ts b/src/data/types/common/SignalKind.ts
@@ -0,0 +1,11 @@
+export type SignalKind =
+  | 'undefined'
+  | 'signal'
+  | 'reference'
+  | 'impurity'
+  | 'standard'
+  | 'p1'
+  | 'p2'
+  | 'p3'
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  | (string & {});
diff --git a/src/data/utilities/RangeUtilities.ts b/src/data/utilities/RangeUtilities.ts
@@ -1,7 +1,7 @@
 import omit from 'lodash/omit';
 import { Range, Signal1D } from 'nmr-processing';
 
-import { DatumKind } from '../constants/SignalsKinds';
+import { DATUM_KIND } from '../constants/signalsKinds';
 
 export function getDiaIDs(range: Range): string[] {
   return ([] as string[]).concat(
@@ -88,7 +88,7 @@ export function addDefaultSignal(range) {
 }
 
 export function checkRangeKind(range) {
-  return range.kind === DatumKind.signal;
+  return range.kind === DATUM_KIND.signal;
 }
 
 export function checkSignalKinds(range, kinds) {

diff --git a/src/data/utilities/ZoneUtilities.ts b/src/data/utilities/ZoneUtilities.ts
@@ -1,6 +1,6 @@
 import { Zone } from 'nmr-processing';
 
-import { DatumKind } from '../constants/SignalsKinds';
+import { DATUM_KIND } from '../constants/signalsKinds';
 
 export function getDiaIDs(zone: Zone, axis: string): string[] {
   return ([] as string[]).concat(
@@ -39,7 +39,7 @@ export function resetDiaIDs(zone: Zone, axis: string) {
 }
 
 export function checkZoneKind(zone: Zone): boolean {
-  return zone.kind === DatumKind.signal;
+  return zone.kind === DATUM_KIND.signal;
 }
 
 export function checkSignalKinds(zone: Zone, kinds: string[]): boolean {

diff --git a/src/utils/stringCapitalize.ts b/src/utils/stringCapitalize.ts
@@ -0,0 +1,3 @@
+export function stringCapitalize(str: string) {
+  return str.charAt(0).toUpperCase() + str.slice(1);
+}