perf: ⚡️ Ingest vtkjs strokeBuffer for performance enhancement (#52)

* perf: ⚡️ Ingest vtkjs strokeBuffer for performance enhancement

Author: JamesAPetts

examples/VTKCornerstonePaintingSyncExample.js

@@ -14,7 +14,7 @@ import vtkVolume from 'vtk.js/Sources/Rendering/Core/Volume';
 const { EVENTS } = cornerstoneTools;
 window.cornerstoneTools = cornerstoneTools;
 
-function setupSyncedBrush(imageDataObject, element) {
+function setupSyncedBrush(imageDataObject) {
   // Create buffer the size of the 3D volume
   const dimensions = imageDataObject.dimensions;
   const width = dimensions[0];
@@ -128,10 +128,7 @@ class VTKCornerstonePaintingSyncExample extends Component {
         };
 
         const imageDataObject = getImageData(imageIds, displaySetInstanceUid);
-        const labelMapInputData = setupSyncedBrush(
-          imageDataObject,
-          this.cornerstoneElements[0]
-        );
+        const labelMapInputData = setupSyncedBrush(imageDataObject);
 
         this.onMeasurementsChanged = event => {
           if (event.type !== EVENTS.LABELMAP_MODIFIED) {
@@ -160,7 +157,7 @@ class VTKCornerstonePaintingSyncExample extends Component {
     );
   }
 
-  onPaintEnd = () => {
+  onPaintEnd = strokeBuffer => {
     const element = this.cornerstoneElements[0];
     const enabledElement = cornerstone.getEnabledElement(element);
     const { getters, setters } = cornerstoneTools.getModule('segmentation');
@@ -174,16 +171,35 @@ class VTKCornerstonePaintingSyncExample extends Component {
 
     const stackData = stackState.data[0];
     const numberOfFrames = stackData.imageIds.length;
+    const segmentIndex = labelmap3D.activeSegmentIndex;
 
-    // TODO -> Can do more efficiently if we can grab the strokeBuffer from vtk-js.
     for (let i = 0; i < numberOfFrames; i++) {
-      const labelmap2D = getters.labelmap2DByImageIdIndex(
-        labelmap3D,
-        i,
-        rows,
-        columns
-      );
-      setters.updateSegmentsOnLabelmap2D(labelmap2D);
+      let labelmap2D = labelmap3D.labelmaps2D[i];
+
+      if (labelmap2D && labelmap2D.segmentsOnLabelmap.includes(segmentIndex)) {
+        continue;
+      }
+
+      const frameLength = rows * columns;
+      const byteOffset = frameLength * i;
+      const strokeArray = new Uint8Array(strokeBuffer, byteOffset, frameLength);
+
+      const strokeOnFrame = strokeArray.some(element => element === 1);
+
+      if (!strokeOnFrame) {
+        continue;
+      }
+
+      if (labelmap2D) {
+        labelmap2D.segmentsOnLabelmap.push(segmentIndex);
+      } else {
+        labelmap2D = getters.labelmap2DByImageIdIndex(
+          labelmap3D,
+          i,
+          rows,
+          columns
+        );
+      }
     }
 
     cornerstone.updateImage(element);

package.json

@@ -23,7 +23,7 @@
   "peerDependencies": {
     "react": "^16.8.6",
     "react-dom": "^16.8.6",
-    "vtk.js": "^11.1.3"
+    "vtk.js": "^11.2.0"
   },
   "dependencies": {
     "date-fns": "^2.2.1",
@@ -46,7 +46,7 @@
     "copy-webpack-plugin": "^5.0.4",
     "cornerstone-core": "^2.3.0",
     "cornerstone-math": "^0.1.8",
-    "cornerstone-tools": "^4.0.9",
+    "cornerstone-tools": "^4.5.2",
     "cornerstone-wado-image-loader": "^3.0.5",
     "cross-env": "^5.2.0",
     "css-loader": "^3.0.0",
@@ -81,7 +81,7 @@
     "style-loader": "^0.23.1",
     "stylelint": "^10.1.0",
     "stylelint-config-recommended": "^2.2.0",
-    "vtk.js": "^11.1.3",
+    "vtk.js": "^11.2.0",
     "webpack": "4.34.0",
     "webpack-cli": "^3.3.4",
     "webpack-dev-server": "^3.8.0",

src/Custom/VTKMPRViewport.js

@@ -216,9 +216,12 @@ export default class VtkMpr extends Component {
         );
         this.subs.paintEnd.sub(
           this.viewWidget.onEndInteractionEvent(() => {
-            this.paintFilter.endStroke();
+            const strokeBufferPromise = this.paintFilter.endStroke();
+
             if (this.props.onPaintEnd) {
-              this.props.onPaintEnd();
+              strokeBufferPromise.then(strokeBuffer => {
+                this.props.onPaintEnd(strokeBuffer);
+              });
             }
           })
         );

src/VTKViewport/View2D.js

@@ -302,9 +302,12 @@ export default class View2D extends Component {
         );
         this.subs.paintEnd.sub(
           this.viewWidget.onEndInteractionEvent(() => {
-            this.paintFilter.endStroke();
+            const strokeBufferPromise = this.paintFilter.endStroke();
+
             if (this.props.onPaintEnd) {
-              this.props.onPaintEnd();
+              strokeBufferPromise.then(strokeBuffer => {
+                this.props.onPaintEnd(strokeBuffer);
+              });
             }
           })
         );

src/VTKViewport/View3D.js

@@ -239,9 +239,12 @@ export default class View3D extends Component {
         );
         this.subs.paintEnd.sub(
           this.viewWidget.onEndInteractionEvent(() => {
-            this.paintFilter.endStroke();
+            const strokeBufferPromise = this.paintFilter.endStroke();
+
             if (this.props.onPaintEnd) {
-              this.props.onPaintEnd();
+              strokeBufferPromise.then(strokeBuffer => {
+                this.props.onPaintEnd(strokeBuffer);
+              });
             }
           })
         );

yarn.lock

@@ -3425,10 +3425,10 @@ cornerstone-math@^0.1.8:
   resolved "https://registry.yarnpkg.com/cornerstone-math/-/cornerstone-math-0.1.8.tgz#68ab1f9e4fdcd7c5cb23a0d2eb4263f9f894f1c5"
   integrity sha512-x7NEQHBtVG7j1yeyj/aRoKTpXv1Vh2/H9zNLMyqYJDtJkNng8C4Q8M3CgZ1qer0Yr7eVq2x+Ynmj6kfOm5jXKw==
 
-cornerstone-tools@^4.0.9:
-  version "4.1.1"
-  resolved "https://registry.yarnpkg.com/cornerstone-tools/-/cornerstone-tools-4.1.1.tgz#69139314e24a667093a41f74ce1310cb34e53544"
-  integrity sha512-/eyhVvL+OLtwn7jIJuF0RC8kR1rP3fjuYhRgfuJEYWcwmEetYHQhYTFzZVqGWlUynjMVVp4s742JW82P9jQZOw==
+cornerstone-tools@^4.5.2:
+  version "4.5.2"
+  resolved "https://registry.yarnpkg.com/cornerstone-tools/-/cornerstone-tools-4.5.2.tgz#1eec8d8bb7e6674f16dcc054d477486b6b9477ee"
+  integrity sha512-FDRqt6JxcICCD0U34lpZ3uHYPaQr6jypAtyX0KL6GaMzC8X7cR0XE2Rm2bLT85oewyyQpHZC5tAFmr//noYxUQ==
   dependencies:
     "@babel/runtime" "7.1.2"
     cornerstone-math "0.1.7"
@@ -13602,10 +13602,10 @@ vm-browserify@^1.0.1:
   resolved "https://registry.yarnpkg.com/vm-browserify/-/vm-browserify-1.1.0.tgz#bd76d6a23323e2ca8ffa12028dc04559c75f9019"
   integrity sha512-iq+S7vZJE60yejDYM0ek6zg308+UZsdtPExWP9VZoCFCz1zkJoXFnAX7aZfd/ZwrkidzdUZL0C/ryW+JwAiIGw==
 
-vtk.js@^11.1.3:
-  version "11.2.0"
-  resolved "https://registry.yarnpkg.com/vtk.js/-/vtk.js-11.2.0.tgz#ce11863623f4f9ef64dfe6c5be1bb2fd2ed7ef6f"
-  integrity sha512-d++pvYLLc+/TGfNhGL/USZBwDoQGBV14UFOBLPZs4SjZGYdUEISFtG2FI4/MmoZOpzH/4vSoAlgbHAuCstYIQQ==
+vtk.js@^11.2.0:
+  version "11.4.2"
+  resolved "https://registry.yarnpkg.com/vtk.js/-/vtk.js-11.4.2.tgz#6a967a4522a88704b6982a0d1356f24f77b09989"
+  integrity sha512-lr0GFZM5fGVUwM008KhxaSCB9dIeqKeD1ZZJQGcP+4rfcrPgC7Zp2L16kgQkj6rupPTseI+Nsk6UV5Dc8lJN4w==
   dependencies:
     blueimp-md5 "2.10.0"
     commander "2.11.0"