Merge pull request #1267 from thewtex/test-transform-io-ts

test(transform-io): add node tests

.github/workflows/javascript-typescript.yml

@@ -21,7 +21,7 @@ jobs:
     strategy:
       max-parallel: 3
       matrix:
-        package: [compress-stringify, compare-images, dicom, mesh-io, image-io, downsample]
+        package: [compress-stringify, compare-images, dicom, mesh-io, image-io, transform-io, downsample]
 
     steps:
     - uses: actions/checkout@v4

packages/core/typescript/itk-wasm/src/bindgen/interface-json-type-to-interface-type.js

@@ -19,8 +19,8 @@ const interfaceJsonTypeToInterfaceType = new Map([
   ['OUTPUT_POINT_SET', 'PointSet'],
   ['INPUT_POLYDATA', 'PolyData'],
   ['OUTPUT_POLYDATA', 'PolyData'],
-  ['INPUT_TRANSFORM', 'Transform'],
-  ['OUTPUT_TRANSFORM', 'Transform'],
+  ['INPUT_TRANSFORM', 'TransformList'],
+  ['OUTPUT_TRANSFORM', 'TransformList'],
   ['INPUT_JSON', 'JsonCompatible'],
   ['OUTPUT_JSON', 'JsonCompatible']
 ])

packages/core/typescript/itk-wasm/src/bindgen/python/interface-json-type-to-python-type.js

@@ -19,8 +19,8 @@ const interfaceJsonTypeToPythonType = new Map([
   ['OUTPUT_POINT_SET', 'PointSet'],
   ['INPUT_POLYDATA', 'PolyData'],
   ['OUTPUT_POLYDATA', 'PolyData'],
-  ['INPUT_TRANSFORM', 'Transform'],
-  ['OUTPUT_TRANSFORM', 'Transform'],
+  ['INPUT_TRANSFORM', 'TransformList'],
+  ['OUTPUT_TRANSFORM', 'TransformList'],
   ['BOOL', 'bool'],
   ['TEXT', 'str'],
   ['INT', 'int'],

packages/core/typescript/itk-wasm/src/bindgen/typescript/function-module.js

@@ -471,7 +471,7 @@ function functionModule(
           functionContent += `      inputs.push({ type: InterfaceTypes.${interfaceType}, data: { data: value } })\n`
           functionContent += '      args.push(inputCountString)\n\n'
         } else {
-          // Image, Mesh, PointSet, PolyData, Transform, JsonCompatible
+          // Image, Mesh, PointSet, PolyData, TransformList, JsonCompatible
           functionContent +=
             '      const inputCountString = inputs.length.toString()\n'
           functionContent += `      inputs.push({ type: InterfaceTypes.${interfaceType}, data: value as ${interfaceType} })\n`
@@ -511,7 +511,7 @@ function functionModule(
           functionContent += `    inputs.push({ type: InterfaceTypes.${interfaceType}, data: { data: options.${camel} } })\n`
           functionContent += `    args.push('--${parameter.name}', inputCountString)\n\n`
         } else {
-          // Image, Mesh, PointSet, PolyData, Transform, JsonCompatible
+          // Image, Mesh, PointSet, PolyData, TransformList, JsonCompatible
           functionContent +=
             '    const inputCountString = inputs.length.toString()\n'
           functionContent += `    inputs.push({ type: InterfaceTypes.${interfaceType}, data: options.${camel} as ${interfaceType} })\n`

packages/core/typescript/itk-wasm/src/bindgen/typescript/interface-json-type-to-typescript-type.js

@@ -19,8 +19,8 @@ const interfaceJsonTypeToTypeScriptType = new Map([
   ['OUTPUT_POINT_SET', 'PointSet'],
   ['INPUT_POLYDATA', 'PolyData'],
   ['OUTPUT_POLYDATA', 'PolyData'],
-  ['INPUT_TRANSFORM', 'Transform'],
-  ['OUTPUT_TRANSFORM', 'Transform'],
+  ['INPUT_TRANSFORM', 'TransformList'],
+  ['OUTPUT_TRANSFORM', 'TransformList'],
   ['BOOL', 'boolean'],
   ['TEXT', 'string'],
   ['INT', 'number'],

packages/core/typescript/itk-wasm/src/bindgen/typescript/types-require-import.js

@@ -3,7 +3,7 @@ const typesRequireImport = [
   'Mesh',
   'PointSet',
   'PolyData',
-  'Transform',
+  'TransformList',
   'TextFile',
   'BinaryFile',
   'TextFile',

packages/core/typescript/itk-wasm/src/cli/default-image-tag.js

@@ -1,2 +1,2 @@
-const defaultImageTag = '20241030-6c93a1be'
+const defaultImageTag = '20241107-53b18ede'
 export default defaultImageTag

packages/core/typescript/itk-wasm/src/interface-types/index-common.ts

@@ -26,5 +26,6 @@ export { default as PolyDataType } from './poly-data-type.js'
 export { default as TransformParameterizations } from './transform-parameterizations.js'
 export { default as TransformType } from './transform-type.js'
 export { default as Transform } from './transform.js'
+export type { default as TransformList } from './transform-list.js'
 
 export { default as InterfaceTypes } from './interface-types.js'

packages/core/typescript/itk-wasm/src/interface-types/interface-types.ts

@@ -7,7 +7,7 @@ const InterfaceTypes = {
   PointSet: 'PointSet',
   Mesh: 'Mesh',
   PolyData: 'PolyData',
-  Transform: 'Transform',
+  TransformList: 'TransformList',
   JsonCompatible: 'JsonCompatible'
 } as const
 

packages/core/typescript/itk-wasm/src/interface-types/transform-list.ts

@@ -0,0 +1,5 @@
+import Transform from './transform.js'
+
+type TransformList = Transform[]
+
+export default TransformList

packages/core/typescript/itk-wasm/src/interface-types/transform-type.ts

@@ -1,10 +1,12 @@
 import TransformParameterizations from './transform-parameterizations.js'
+import FloatTypes from './float-types.js'
 
 class TransformType {
   constructor (
+    public readonly transformParameterization: (typeof TransformParameterizations)[keyof typeof TransformParameterizations] = TransformParameterizations.Identity,
+    public readonly parametersValueType: typeof FloatTypes[keyof typeof FloatTypes] = FloatTypes.Float64,
     public readonly inputDimension: number = 3,
-    public readonly outputDimension: number = 3,
-    public readonly transformParameterization: (typeof TransformParameterizations)[keyof typeof TransformParameterizations] = TransformParameterizations.Identity
+    public readonly outputDimension: number = 3
   ) {}
 }
 

packages/core/typescript/itk-wasm/src/interface-types/transform.ts

@@ -1,4 +1,5 @@
 import TransformType from './transform-type.js'
+import type TypedArray from '../typed-array.js'
 
 class Transform {
   transformType: TransformType
@@ -10,8 +11,8 @@ class Transform {
   inputSpaceName: string
   outputSpaceName: string
 
-  parameters: number[]
-  fixedParameters: number[]
+  parameters: TypedArray
+  fixedParameters: TypedArray
 
   constructor (transformType = new TransformType()) {
     this.transformType = transformType
@@ -21,8 +22,8 @@ class Transform {
     this.inputSpaceName = ''
     this.outputSpaceName = ''
 
-    this.parameters = new Array(0)
-    this.fixedParameters = new Array(0)
+    this.parameters = new Uint8Array(0)
+    this.fixedParameters = new Uint8Array(0)
   }
 }
 

packages/core/typescript/itk-wasm/src/pipeline/internal/run-pipeline-emscripten.ts

@@ -9,7 +9,7 @@ import Image from '../../interface-types/image.js'
 import Mesh from '../../interface-types/mesh.js'
 import PointSet from '../../interface-types/point-set.js'
 import PolyData from '../../interface-types/poly-data.js'
-// import Transform from '../../interface-types/transform.js'
+import TransformList from '../../interface-types/transform-list.js'
 import FloatTypes from '../../interface-types/float-types.js'
 import IntTypes from '../../interface-types/int-types.js'
 
@@ -22,7 +22,7 @@ const haveSharedArrayBuffer = typeof globalThis.SharedArrayBuffer === 'function'
 const encoder = new TextEncoder()
 const decoder = new TextDecoder('utf-8')
 
-function readFileSharedArray (
+function readFileSharedArray(
   emscriptenModule: PipelineEmscriptenModule,
   path: string
 ): Uint8Array {
@@ -42,7 +42,7 @@ function readFileSharedArray (
   return array
 }
 
-function memoryUint8SharedArray (
+function memoryUint8SharedArray(
   emscriptenModule: PipelineEmscriptenModule,
   byteOffset: number,
   length: number
@@ -63,7 +63,7 @@ function memoryUint8SharedArray (
   return array
 }
 
-function setPipelineModuleInputArray (
+function setPipelineModuleInputArray(
   emscriptenModule: PipelineEmscriptenModule,
   dataArray: TypedArray | null,
   inputIndex: number,
@@ -82,7 +82,7 @@ function setPipelineModuleInputArray (
   return dataPtr
 }
 
-function setPipelineModuleInputJSON (
+function setPipelineModuleInputJSON(
   emscriptenModule: PipelineEmscriptenModule,
   dataObject: object,
   inputIndex: number
@@ -98,13 +98,13 @@ function setPipelineModuleInputJSON (
   emscriptenModule.stringToUTF8(dataJSON, jsonPtr, length)
 }
 
-function getPipelineModuleOutputArray (
+function getPipelineModuleOutputArray(
   emscriptenModule: PipelineEmscriptenModule,
   outputIndex: number,
   subIndex: number,
   componentType:
-  | (typeof IntTypes)[keyof typeof IntTypes]
-  | (typeof FloatTypes)[keyof typeof FloatTypes]
+    | (typeof IntTypes)[keyof typeof IntTypes]
+    | (typeof FloatTypes)[keyof typeof FloatTypes]
 ): TypedArray | Float32Array | Uint32Array | null {
   const dataPtr = emscriptenModule.ccall(
     'itk_wasm_output_array_address',
@@ -123,7 +123,7 @@ function getPipelineModuleOutputArray (
   return data
 }
 
-function getPipelineModuleOutputJSON (
+function getPipelineModuleOutputJSON(
   emscriptenModule: PipelineEmscriptenModule,
   outputIndex: number
 ): object {
@@ -138,7 +138,7 @@ function getPipelineModuleOutputJSON (
   return dataObject
 }
 
-function runPipelineEmscripten (
+function runPipelineEmscripten(
   pipelineModule: PipelineEmscriptenModule,
   args: string[],
   outputs: PipelineOutput[] | null,
@@ -310,6 +310,42 @@ function runPipelineEmscripten (
           setPipelineModuleInputJSON(pipelineModule, pointSetJSON, index)
           break
         }
+        case InterfaceTypes.TransformList: {
+          const transformList = input.data as TransformList
+          const transformListJSON: any = []
+          transformList.forEach((transform, transformIndex) => {
+            const fixedParameterPtr = setPipelineModuleInputArray(
+              pipelineModule,
+              transform.fixedParameters,
+              index,
+              transformIndex * 2
+            )
+            const fixedParameters = `data:application/vnd.itk.address,0:${fixedParameterPtr}`
+            const parameterPtr = setPipelineModuleInputArray(
+              pipelineModule,
+              transform.parameters,
+              index,
+              transformIndex * 2 + 1
+            )
+            const parameters = `data:application/vnd.itk.address,0:${parameterPtr}`
+            const transformJSON = {
+              transformType: transform.transformType,
+              numberOfFixedParameters: transform.numberOfFixedParameters,
+              numberOfParameters: transform.numberOfParameters,
+
+              name: transform.name,
+
+              inputSpaceName: transform.inputSpaceName,
+              outputSpaceName: transform.outputSpaceName,
+
+              parameters,
+              fixedParameters
+            }
+            transformListJSON.push(transformJSON)
+          })
+          setPipelineModuleInputJSON(pipelineModule, transformListJSON, index)
+          break
+        }
         case InterfaceTypes.PolyData: {
           const polyData = input.data as PolyData
           const pointsPtr = setPipelineModuleInputArray(
@@ -618,6 +654,34 @@ function runPipelineEmscripten (
           outputData = pointSet
           break
         }
+        case InterfaceTypes.TransformList: {
+          const transformList = getPipelineModuleOutputJSON(
+            pipelineModule,
+            index
+          ) as TransformList
+          transformList.forEach((transform, transformIndex) => {
+            if (transform.numberOfFixedParameters > 0) {
+              transformList[transformIndex].fixedParameters =
+                getPipelineModuleOutputArray(
+                  pipelineModule,
+                  index,
+                  transformIndex * 2,
+                  transform.transformType.parametersValueType
+                ) as TypedArray
+            }
+            if (transform.numberOfFixedParameters > 0) {
+              transformList[transformIndex].parameters =
+                getPipelineModuleOutputArray(
+                  pipelineModule,
+                  index,
+                  transformIndex * 2 + 1,
+                  transform.transformType.parametersValueType
+                ) as TypedArray
+            }
+          })
+          outputData = transformList
+          break
+        }
         case InterfaceTypes.PolyData: {
           const polyData = getPipelineModuleOutputJSON(
             pipelineModule,

packages/core/typescript/itk-wasm/src/pipeline/pipeline-input.ts

@@ -7,7 +7,7 @@ import Image from '../interface-types/image.js'
 import Mesh from '../interface-types/mesh.js'
 import PointSet from '../interface-types/point-set.js'
 import PolyData from '../interface-types/poly-data.js'
-import Transform from '../interface-types/transform.js'
+import TransformList from '../interface-types/transform-list.js'
 import JsonCompatible from '../interface-types/json-compatible.js'
 
 interface PipelineInput {
@@ -24,7 +24,7 @@ interface PipelineInput {
   | Mesh
   | PointSet
   | PolyData
-  | Transform
+  | TransformList
 }
 
 export default PipelineInput

packages/core/typescript/itk-wasm/src/pipeline/pipeline-output.ts

@@ -7,7 +7,7 @@ import Image from '../interface-types/image.js'
 import Mesh from '../interface-types/mesh.js'
 import PointSet from '../interface-types/point-set.js'
 import PolyData from '../interface-types/poly-data.js'
-import Transform from '../interface-types/transform.js'
+import TransformList from '../interface-types/transform-list.js'
 import JsonCompatible from '../interface-types/json-compatible.js'
 
 interface PipelineOutput {
@@ -24,7 +24,7 @@ interface PipelineOutput {
   | Mesh
   | PointSet
   | PolyData
-  | Transform
+  | TransformList
 }
 
 export default PipelineOutput

packages/core/typescript/itk-wasm/test/node/interface-types/transform-test.js

@@ -0,0 +1,24 @@
+import test from 'ava'
+
+import { Transform, TransformType } from '../../../dist/index-node.js'
+
+test('transformType should have the same transformType passed to the constructor', t => {
+  const transform = new Transform()
+  const defaultTransformType = new TransformType()
+  t.deepEqual(transform.transformType, defaultTransformType)
+})
+
+test('name should have the default value of "Transform"', t => {
+  const transform = new Transform()
+  t.deepEqual(transform.name, 'Transform')
+})
+
+test('numberOfFixedParameters should have a default value of 0', t => {
+  const transform = new Transform()
+  t.is(transform.numberOfFixedParameters, 0)
+})
+
+test('numberOfParameters should have a default value of 0', t => {
+  const transform = new Transform()
+  t.is(transform.numberOfParameters, 0)
+})

packages/core/typescript/itk-wasm/test/node/interface-types/transform-type-test.js

@@ -0,0 +1,32 @@
+import test from 'ava'
+
+import {
+  TransformType,
+  TransformParameterizations,
+  FloatTypes
+} from '../../../dist/index-node.js'
+
+test('inputDimension should have a default value of 3', (t) => {
+  const transformType = new TransformType()
+  t.is(transformType.inputDimension, 3)
+})
+
+test('outputDimension should have a default value of 3', (t) => {
+  const transformType = new TransformType()
+  t.is(transformType.outputDimension, 3)
+})
+
+test('transformParameterization should have a default value of Identity', (t) => {
+  const transformType = new TransformType()
+  t.is(
+    transformType.transformParameterization,
+    TransformParameterizations.Identity
+  )
+})
+test('parametersValueType should have the same value passed to the constructor', (t) => {
+  const transformType = new TransformType()
+  t.is(
+    transformType.parametersValueType,
+    FloatTypes.Float64
+  )
+})