Added rendering support for Icon Image Sequence

Removed circular dependencies Updated c8 and build workflow to work/test on multiple node versions
PantelisGeorgiadis · Dec 12, 2022 · 36a7b2e · 36a7b2e
1 parent 778b084
commit 36a7b2e
Show file tree

Hide file tree

Showing 25 changed files with 607 additions and 283 deletions.
diff --git a/.c8rc.json b/.c8rc.json
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -1,25 +1,30 @@
-name: build
-'on':
+name: Node.js CI
+
+on:
   push:
-    branches:
-      - master
+    branches: [ master ]
   pull_request:
-    branches:
-      - master
+    branches: [ master ]
+
 jobs:
   build:
     runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.x, 16.x, 18.x]
+
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Initialize CodeQL
         uses: github/codeql-action/init@v2
         with:
           languages: javascript
-      - name: Use Node.js
-        uses: actions/setup-node@v1
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
         with:
-          node-version: 14.x
+          node-version: ${{ matrix.node-version }}
       - name: Install dependencies
         run: npm install
       - name: Build

diff --git a/.npmignore b/.npmignore
@@ -12,7 +12,6 @@ documentation/
 .gitignore
 .gitattributes
 .jsdocrc.json
-.c8rc.json
 index.test-d.ts
 karma.config.js
 webpack.config.js
diff --git a/README.md b/README.md
@@ -76,6 +76,10 @@ const renderingResult = image.render();
 
 // Rendered pixels in an RGBA ArrayBuffer.
 const renderedPixels = renderingResult.pixels;
+// Rendered width.
+const width = renderingResult.width;
+// Rendered height.
+const height = renderingResult.height;
 ```
 
 #### Advanced image rendering
@@ -134,6 +138,10 @@ const renderingResult = image.render(renderingOpts);
 const renderedPixels = renderingResult.pixels;
 // Rendered frame index.
 const frame = renderingResult.frame;
+// Rendered width.
+const width = renderingResult.width;
+// Rendered height.
+const height = renderingResult.height;
 // Window/level used to render the pixels.
 // In case of color images, windowLevel should not be present.
 const windowLevel = renderingResult.windowLevel;

diff --git a/examples/index.html b/examples/index.html
@@ -192,8 +192,8 @@
         const renderedPixels = new Uint8Array(renderingResult.pixels);
         const t1 = performance.now();
 
-        opts.canvasElement.width = opts.image.getWidth();
-        opts.canvasElement.height = opts.image.getHeight();
+        opts.canvasElement.width = renderingResult.width;
+        opts.canvasElement.height = renderingResult.height;
 
         if (opts.useWebGl) {
           const gl = opts.canvasElement.getContext('webgl');
@@ -253,8 +253,8 @@
             gl.TEXTURE_2D,
             0,
             gl.RGBA,
-            opts.image.getWidth(),
-            opts.image.getHeight(),
+            renderingResult.width,
+            renderingResult.height,
             0,
             gl.RGBA,
             gl.UNSIGNED_BYTE,
@@ -270,9 +270,9 @@
         } else {
           const ctx = opts.canvasElement.getContext('2d');
           ctx.clearRect(0, 0, opts.canvasElement.width, opts.canvasElement.height);
-          const imageData = ctx.createImageData(opts.image.getWidth(), opts.image.getHeight());
+          const imageData = ctx.createImageData(renderingResult.width, renderingResult.height);
           const canvasPixels = imageData.data;
-          for (let i = 0; i < 4 * opts.image.getWidth() * opts.image.getHeight(); i++) {
+          for (let i = 0; i < 4 * renderingResult.width * renderingResult.height; i++) {
             canvasPixels[i] = renderedPixels[i];
           }
           ctx.putImageData(imageData, 0, 0);

diff --git a/examples/index.js b/examples/index.js
@@ -22,8 +22,8 @@ async function renderToBmp(dicomFile, bmpFile) {
   const renderedPixels = Buffer.from(renderingResult.pixels);
 
   // BMP lib expects ABGR and the rendering output is RGBA
-  const argbPixels = Buffer.alloc(4 * image.getWidth() * image.getHeight());
-  for (let i = 0; i < 4 * image.getWidth() * image.getHeight(); i += 4) {
+  const argbPixels = Buffer.alloc(4 * renderingResult.width * renderingResult.height);
+  for (let i = 0; i < 4 * renderingResult.width * renderingResult.height; i += 4) {
     argbPixels[i] = renderedPixels[i + 3];
     argbPixels[i + 1] = renderedPixels[i + 2];
     argbPixels[i + 2] = renderedPixels[i + 1];
@@ -32,8 +32,8 @@ async function renderToBmp(dicomFile, bmpFile) {
 
   const encodedBmp = bmp.encode({
     data: argbPixels,
-    width: image.getWidth(),
-    height: image.getHeight(),
+    width: renderingResult.width,
+    height: renderingResult.height,
   });
 
   fs.writeFileSync(bmpFile, encodedBmp.data);

diff --git a/examples/index.ts b/examples/index.ts
@@ -21,8 +21,8 @@ async function renderToBmp(dicomFile: string, bmpFile: string) {
   const renderedPixels = Buffer.from(renderingResult.pixels);
 
   // BMP lib expects ABGR and the rendering output is RGBA
-  const argbPixels = Buffer.alloc(4 * image.getWidth() * image.getHeight());
-  for (let i = 0; i < 4 * image.getWidth() * image.getHeight(); i += 4) {
+  const argbPixels = Buffer.alloc(4 * renderingResult.width * renderingResult.height);
+  for (let i = 0; i < 4 * renderingResult.width * renderingResult.height; i += 4) {
     argbPixels[i] = renderedPixels[i + 3];
     argbPixels[i + 1] = renderedPixels[i + 2];
     argbPixels[i + 2] = renderedPixels[i + 1];
@@ -31,8 +31,8 @@ async function renderToBmp(dicomFile: string, bmpFile: string) {
 
   const encodedBmp = bmp.encode({
     data: argbPixels,
-    width: image.getWidth(),
-    height: image.getHeight(),
+    width: renderingResult.width,
+    height: renderingResult.height,
   });
 
   fs.writeFileSync(bmpFile, encodedBmp.data);

diff --git a/index.d.ts b/index.d.ts
@@ -103,9 +103,9 @@ declare class WindowLevel {
   setDescription(description: string): void;
 
   /**
-   * Creates an array of window/level objects based on the image parameters.
+   * Creates an array of window/level objects based on the image elements.
    */
-  static fromDicomImage(image: DicomImage): Array<WindowLevel>;
+  static fromDicomImageElements(elements: Record<string, unknown>): Array<WindowLevel>;
 
   /**
    * Gets the window/level description.
@@ -192,6 +192,21 @@ declare class DicomImage {
     colorPalette?: number;
   }): {
     frame: number;
+    width: number;
+    height: number;
+    pixels: ArrayBuffer;
+    windowLevel?: WindowLevel;
+    histograms?: Array<Histogram>;
+    colorPalette?: number;
+  };
+
+  /**
+   * Renders the icon image located within an icon image sequence, if exists.
+   */
+  renderIcon(): {
+    frame: number;
+    width: number;
+    height: number;
     pixels: ArrayBuffer;
     windowLevel?: WindowLevel;
     histograms?: Array<Histogram>;

diff --git a/index.test-d.ts b/index.test-d.ts
@@ -32,7 +32,9 @@ expectType<number>(windowLevel.getLevel());
 expectType<string | undefined>(windowLevel.getDescription());
 expectType<string>(windowLevel.toString());
 expectType<WindowLevel[]>(
-  WindowLevel.fromDicomImage(new DicomImage({}, TransferSyntax.ImplicitVRLittleEndian))
+  WindowLevel.fromDicomImageElements(
+    new DicomImage({}, TransferSyntax.ImplicitVRLittleEndian).getElements()
+  )
 );
 
 // Histogram
@@ -78,8 +80,11 @@ expectType<number>(dicomImage.getNumberOfFrames());
 expectError(
   dicomImage.render({ frame: '1', windowLevel: 'WW/WL', renderOverlays: 1, calculateHistograms: 0 })
 );
+expectError(dicomImage.renderIcon({ frame: 1 }));
 expectType<{
   frame: number;
+  width: number;
+  height: number;
   pixels: ArrayBuffer;
   windowLevel?: WindowLevel;
   histograms?: Array<Histogram>;
@@ -92,4 +97,13 @@ expectType<{
     colorPalette: StandardColorPalette.HotIron,
   })
 );
+expectType<{
+  frame: number;
+  width: number;
+  height: number;
+  pixels: ArrayBuffer;
+  windowLevel?: WindowLevel;
+  histograms?: Array<Histogram>;
+  colorPalette?: number;
+}>(dicomImage.renderIcon());
 expectType<string>(dicomImage.toString());