Fix support for enum/bool auxiliary signals in NX Line visualization

axelboc · axelboc · commit 3eba27e93856 · 2025-01-23T16:15:03.000+01:00
diff --git a/packages/app/src/providers/mock/mock-file.ts b/packages/app/src/providers/mock/mock-file.ts
@@ -284,11 +284,21 @@ export function makeMockFile(): GroupWithChildren {
           }),
           nxGroup('numeric-like', 'NXprocess', {
             children: [
-              nxData('bool', { signal: array('twoD_bool') }),
+              nxData('bool', {
+                signal: array('twoD_bool'),
+                auxiliary: { secondary_bool: array('secondary_bool') },
+                auxAttr: ['secondary_bool'],
+              }),
               nxData('enum', {
                 signal: array('twoD_enum', {
                   type: enumType(intType(false, 8), ENUM_MAPPING),
                 }),
+                auxiliary: {
+                  secondary_enum: array('secondary_enum', {
+                    type: enumType(intType(false, 8), ENUM_MAPPING),
+                  }),
+                },
+                auxAttr: ['secondary_enum'],
               }),
             ],
           }),
diff --git a/packages/app/src/vis-packs/core/hooks.ts b/packages/app/src/vis-packs/core/hooks.ts
@@ -4,6 +4,7 @@ import {
   type ArrayShape,
   type ArrayValue,
   type Dataset,
+  type NumericLikeType,
   type ScalarShape,
   type Value,
 } from '@h5web/shared/hdf5-models';
@@ -25,6 +26,12 @@ import {
 
 export const useToNumArray = createMemo(toNumArray);
 
+export function useToNumArrays(
+  arrays: ArrayValue<NumericLikeType>[],
+): NumArray[] {
+  return useMemo(() => arrays.map(toNumArray), arrays); // eslint-disable-line react-hooks/exhaustive-deps
+}
+
 export function useValuesInCache(
   ...datasets: (Dataset<ScalarShape | ArrayShape> | undefined)[]
 ): (dimMapping: DimensionMapping) => boolean {
@@ -129,23 +136,23 @@ export function useMappedArray(
   return useMemo(() => applyMapping(baseArray, mapping), [baseArray, mapping]);
 }
 
-export function useMappedArrays(
-  values: NumArray[],
+export function useMappedArrays<T extends ArrayValue>(
+  values: T[],
   dims: number[],
   mapping: DimensionMapping,
-): NdArray<NumArray>[];
+): NdArray<T>[];
 
-export function useMappedArrays(
-  values: (NumArray | undefined)[],
+export function useMappedArrays<T extends ArrayValue>(
+  values: (T | undefined)[],
   dims: number[],
   mapping: DimensionMapping,
-): (NdArray<NumArray> | undefined)[];
+): (NdArray<T> | undefined)[];
 
 export function useMappedArrays(
-  values: (NumArray | undefined)[],
+  values: (ArrayValue | undefined)[],
   dims: number[],
   mapping: DimensionMapping,
-): (NdArray<NumArray> | undefined)[] {
+): (NdArray<ArrayValue> | undefined)[] {
   const baseArrays = useMemo(
     () => values.map((arr) => getBaseArray(arr, dims)),
     [dims, ...values], // eslint-disable-line react-hooks/exhaustive-deps
diff --git a/packages/app/src/vis-packs/core/line/MappedLineVis.tsx b/packages/app/src/vis-packs/core/line/MappedLineVis.tsx
@@ -8,9 +8,9 @@ import {
 } from '@h5web/lib';
 import {
   type ArrayShape,
-  type ArrayValue,
   type Dataset,
   type NumericLikeType,
+  type Value,
 } from '@h5web/shared/hdf5-models';
 import { type AxisMapping } from '@h5web/shared/nexus-models';
 import { type NumArray } from '@h5web/shared/vis-models';
@@ -24,18 +24,19 @@ import {
   useMappedArrays,
   useSlicedDimsAndMapping,
   useToNumArray,
+  useToNumArrays,
 } from '../hooks';
 import { DEFAULT_DOMAIN, formatNumLikeType, getSliceSelection } from '../utils';
 import { type LineConfig } from './config';
 import LineToolbar from './LineToolbar';
 
 interface Props {
-  dataset?: Dataset<ArrayShape, NumericLikeType>;
-  value: ArrayValue<NumericLikeType>;
+  dataset: Dataset<ArrayShape, NumericLikeType>;
+  value: Value<Props['dataset']>;
   valueLabel?: string;
   errors?: NumArray;
   auxLabels?: string[];
-  auxValues?: NumArray[];
+  auxValues?: Value<Props['dataset']>[];
   auxErrors?: (NumArray | undefined)[];
   dims: number[];
   dimMapping: DimensionMapping;
@@ -76,12 +77,13 @@ function MappedLineVis(props: Props) {
   } = config;
 
   const numArray = useToNumArray(value);
+  const numAuxArrays = useToNumArrays(auxValues);
   const [slicedDims, slicedMapping] = useSlicedDimsAndMapping(dims, dimMapping);
 
   const hookArgs = [slicedDims, slicedMapping] as const;
   const dataArray = useMappedArray(numArray, ...hookArgs);
   const errorArray = useMappedArray(errors, ...hookArgs);
-  const auxArrays = useMappedArrays(auxValues, ...hookArgs);
+  const auxArrays = useMappedArrays(numAuxArrays, ...hookArgs);
   const auxErrorsArrays = useMappedArrays(auxErrors, ...hookArgs);
 
   const dataDomain = useDomain(
@@ -114,7 +116,6 @@ function MappedLineVis(props: Props) {
             config={config}
             getExportURL={
               getExportURL &&
-              dataset &&
               ((format) => getExportURL(format, dataset, selection, value))
             }
           />,
@@ -135,7 +136,7 @@ function MappedLineVis(props: Props) {
         }}
         ordinateLabel={valueLabel}
         title={title}
-        dtype={dataset && formatNumLikeType(dataset.type)}
+        dtype={formatNumLikeType(dataset.type)}
         errorsArray={errorArray}
         showErrors={showErrors}
         auxiliaries={auxArrays.map((array, i) => ({
diff --git a/packages/app/src/vis-packs/nexus/NxSignalPicker.tsx b/packages/app/src/vis-packs/nexus/NxSignalPicker.tsx
@@ -1,14 +1,19 @@
-import { type ComplexType, type NumericType } from '@h5web/shared/hdf5-models';
+import {
+  type ComplexType,
+  type NumericLikeType,
+} from '@h5web/shared/hdf5-models';
 
 import { type DatasetDef } from './models';
 import styles from './NxSignalPicker.module.css';
 
-interface Props<T extends NumericType | ComplexType> {
+interface Props<T extends NumericLikeType | ComplexType> {
   definitions: DatasetDef<T>[];
   onChange: (def: DatasetDef<T>) => void;
 }
 
-function NxSignalPicker<T extends NumericType | ComplexType>(props: Props<T>) {
+function NxSignalPicker<T extends NumericLikeType | ComplexType>(
+  props: Props<T>,
+) {
   const { definitions, onChange } = props;
 
   return (
diff --git a/packages/app/src/vis-packs/nexus/NxValuesFetcher.tsx b/packages/app/src/vis-packs/nexus/NxValuesFetcher.tsx
@@ -1,4 +1,7 @@
-import { type ComplexType, type NumericType } from '@h5web/shared/hdf5-models';
+import {
+  type ComplexType,
+  type NumericLikeType,
+} from '@h5web/shared/hdf5-models';
 import { type ReactNode } from 'react';
 
 import {
@@ -8,13 +11,15 @@ import {
 } from '../core/hooks';
 import { type NxData, type NxValues } from './models';
 
-interface Props<T extends NumericType | ComplexType> {
+interface Props<T extends NumericLikeType | ComplexType> {
   nxData: NxData<T>;
   selection?: string; // for slice-by-slice fetching
   render: (val: NxValues<T>) => ReactNode;
 }
 
-function NxValuesFetcher<T extends NumericType | ComplexType>(props: Props<T>) {
+function NxValuesFetcher<T extends NumericLikeType | ComplexType>(
+  props: Props<T>,
+) {
   const { nxData, selection, render } = props;
   const { signalDef, axisDefs, auxDefs, titleDataset } = nxData;
 
diff --git a/packages/app/src/vis-packs/nexus/guards.ts b/packages/app/src/vis-packs/nexus/guards.ts
@@ -2,37 +2,72 @@ import {
   assertComplexType,
   assertNumericLikeType,
   assertNumericType,
+  isDefined,
 } from '@h5web/shared/guards';
-import { type ComplexType, type NumericType } from '@h5web/shared/hdf5-models';
+import {
+  type ComplexType,
+  type NumericLikeType,
+  type NumericType,
+} from '@h5web/shared/hdf5-models';
 
 import { type NxData } from './models';
 
 export function assertNumericLikeNxData(
   nxData: NxData,
-): asserts nxData is NxData<NumericType> {
-  const { signalDef, auxDefs } = nxData;
+): asserts nxData is NxData<NumericLikeType> {
+  const { signalDef, auxDefs, axisDefs } = nxData;
+
   assertNumericLikeType(signalDef.dataset);
+
   auxDefs.forEach((def) => {
     assertNumericLikeType(def.dataset);
   });
+
+  if (signalDef.errorDataset) {
+    assertNumericType(signalDef.errorDataset);
+  }
+
+  axisDefs.filter(isDefined).forEach((def) => {
+    assertNumericType(def.dataset);
+  });
 }
 
 export function assertNumericNxData(
   nxData: NxData,
 ): asserts nxData is NxData<NumericType> {
-  const { signalDef, auxDefs } = nxData;
+  const { signalDef, auxDefs, axisDefs } = nxData;
+
   assertNumericType(signalDef.dataset);
+
   auxDefs.forEach((def) => {
     assertNumericType(def.dataset);
   });
+
+  if (signalDef.errorDataset) {
+    assertNumericType(signalDef.errorDataset);
+  }
+
+  axisDefs.filter(isDefined).forEach((def) => {
+    assertNumericType(def.dataset);
+  });
 }
 
 export function assertComplexNxData(
   nxData: NxData,
 ): asserts nxData is NxData<ComplexType> {
-  const { signalDef, auxDefs } = nxData;
+  const { signalDef, auxDefs, axisDefs } = nxData;
+
   assertComplexType(signalDef.dataset);
+
   auxDefs.forEach((def) => {
     assertComplexType(def.dataset);
   });
+
+  if (signalDef.errorDataset) {
+    assertNumericType(signalDef.errorDataset);
+  }
+
+  axisDefs.filter(isDefined).forEach((def) => {
+    assertNumericType(def.dataset);
+  });
 }
diff --git a/packages/app/src/vis-packs/nexus/hooks.ts b/packages/app/src/vis-packs/nexus/hooks.ts
@@ -1,7 +1,7 @@
 import {
   type ComplexType,
   type GroupWithChildren,
-  type NumericType,
+  type NumericLikeType,
 } from '@h5web/shared/hdf5-models';
 
 import { type DimensionMapping } from '../../dimension-mapper/models';
@@ -48,7 +48,7 @@ export function useNxData(group: GroupWithChildren): NxData {
   };
 }
 
-export function useNxImageDataToFetch<T extends NumericType | ComplexType>(
+export function useNxImageDataToFetch<T extends NumericLikeType | ComplexType>(
   nxData: NxData<T>,
   selectedDef: DatasetDef<T>,
 ): NxData<T> {
diff --git a/packages/app/src/vis-packs/nexus/models.ts b/packages/app/src/vis-packs/nexus/models.ts
@@ -56,7 +56,7 @@ export interface NxData<
   silxStyle: SilxStyle;
 }
 
-export interface NxValues<T extends NumericType | ComplexType> {
+export interface NxValues<T extends NumericLikeType | ComplexType> {
   title: string;
   signal: ArrayValue<T>;
   errors?: NumArray;
diff --git a/packages/shared/src/mock-values.ts b/packages/shared/src/mock-values.ts
@@ -266,6 +266,24 @@ export const mockValues = {
       ].flat(1),
       [2, 2],
     ),
+  secondary_bool: () => {
+    const { data: dataOneDBool } = oneD_bool();
+    return ndarray(
+      dataOneDBool.flatMap((rowBool) =>
+        dataOneDBool.map((colBool) => (rowBool ? !colBool : colBool)),
+      ),
+      [10, 10],
+    );
+  },
+  secondary_enum: () => {
+    const { data: dataOneDEnum } = oneD_enum();
+    return ndarray(
+      dataOneDEnum.flatMap((rowEnum) =>
+        dataOneDEnum.map((colEnum, j) => (j % 2 === 0 ? colEnum : rowEnum)),
+      ),
+      [10, 10],
+    );
+  },
   tertiary: () =>
     ndarray(
       twoD().data.map((v) => v / 2),

Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ export interface NxData<`
`56`	`56`	`silxStyle: SilxStyle;`
`57`	`57`	`}`
`58`	`58`
`59`		`-export interface NxValues<T extends NumericType \| ComplexType> {`
	`59`	`+export interface NxValues<T extends NumericLikeType \| ComplexType> {`
`60`	`60`	`title: string;`
`61`	`61`	`signal: ArrayValue<T>;`
`62`	`62`	`errors?: NumArray;`