-
-
Notifications
You must be signed in to change notification settings - Fork 3.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(ImageOverlayViewerTool): add ImageOverlayViewer tool that can re…
…nder image overlay (pixel overlay) of the DICOM images (#3163) Co-authored-by: Joe Boccanfuso <[email protected]>
- Loading branch information
Showing
15 changed files
with
355 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
247 changes: 247 additions & 0 deletions
247
extensions/cornerstone/src/tools/ImageOverlayViewerTool.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,247 @@ | ||
| import { metaData } from '@cornerstonejs/core'; | ||
| import { utilities } from '@cornerstonejs/core'; | ||
| import { AnnotationDisplayTool, drawing } from '@cornerstonejs/tools'; | ||
| import { guid } from '@ohif/core/src/utils'; | ||
|
|
||
| interface CachedStat { | ||
| color: number[]; // [r, g, b, a] | ||
| overlays: { | ||
| // ...overlayPlaneModule | ||
| _id: string; | ||
| type: 'G' | 'R'; // G for Graphics, R for ROI | ||
| color?: number[]; // Rendered color [r, g, b, a] | ||
| dataUrl?: string; // Rendered image in Data URL expression | ||
| }[]; | ||
| } | ||
|
|
||
| /** | ||
| * Image Overlay Viewer tool is not a traditional tool that requires user interactin. | ||
| * But it is used to display Pixel Overlays. And it will provide toggling capability. | ||
| * | ||
| * The documentation for Overlay Plane Module of DICOM can be found in [C.9.2 of | ||
| * Part-3 of DICOM standard](https://dicom.nema.org/medical/dicom/2018b/output/chtml/part03/sect_C.9.2.html) | ||
| * | ||
| * Image Overlay rendered by this tool can be toggled on and off using | ||
| * toolGroup.setToolEnabled() and toolGroup.setToolDisabled() | ||
| */ | ||
| class ImageOverlayViewerTool extends AnnotationDisplayTool { | ||
| static toolName = 'ImageOverlayViewer'; | ||
| private _cachedOverlayMetadata: Map<string, any[]> = new Map(); | ||
| private _cachedStats: { [key: string]: CachedStat } = {}; | ||
|
|
||
| constructor( | ||
| toolProps = {}, | ||
| defaultToolProps = { | ||
| supportedInteractionTypes: [], | ||
| configuration: { | ||
| fillColor: [255, 127, 127, 255], | ||
| }, | ||
| } | ||
| ) { | ||
| super(toolProps, defaultToolProps); | ||
| } | ||
|
|
||
| onSetToolDisabled = (): void => { | ||
| this._cachedStats = {}; | ||
| this._cachedOverlayMetadata = new Map(); | ||
| }; | ||
|
|
||
| renderAnnotation = (enabledElement, svgDrawingHelper) => { | ||
| const { viewport } = enabledElement; | ||
|
|
||
| const imageId = this.getReferencedImageId(viewport); | ||
| if (!imageId) { | ||
| return; | ||
| } | ||
|
|
||
| const overlays = | ||
| this._cachedOverlayMetadata.get(imageId) ?? | ||
| metaData.get('overlayPlaneModule', imageId)?.overlays; | ||
|
|
||
| // no overlays | ||
| if (!overlays?.length) { | ||
| return; | ||
| } | ||
|
|
||
| this._cachedOverlayMetadata.set(imageId, overlays); | ||
|
|
||
| this._getCachedStat(imageId, overlays, this.configuration.fillColor).then(cachedStat => { | ||
| cachedStat.overlays.forEach(overlay => { | ||
| this._renderOverlay(enabledElement, svgDrawingHelper, overlay); | ||
| }); | ||
| }); | ||
|
|
||
| return true; | ||
| }; | ||
|
|
||
| /** | ||
| * Render to DOM | ||
| * | ||
| * @param enabledElement | ||
| * @param svgDrawingHelper | ||
| * @param overlayData | ||
| * @returns | ||
| */ | ||
| private _renderOverlay(enabledElement, svgDrawingHelper, overlayData) { | ||
| const { viewport } = enabledElement; | ||
| const imageId = this.getReferencedImageId(viewport); | ||
| if (!imageId) { | ||
| return; | ||
| } | ||
|
|
||
| // Decide the rendering position of the overlay image on the current canvas | ||
| const { _id, columns: width, rows: height, x, y } = overlayData; | ||
| const overlayTopLeftWorldPos = utilities.imageToWorldCoords(imageId, [ | ||
| x - 1, // Remind that top-left corner's (x, y) is be (1, 1) | ||
| y - 1, | ||
| ]); | ||
| const overlayTopLeftOnCanvas = viewport.worldToCanvas(overlayTopLeftWorldPos); | ||
| const overlayBottomRightWorldPos = utilities.imageToWorldCoords(imageId, [width, height]); | ||
| const overlayBottomRightOnCanvas = viewport.worldToCanvas(overlayBottomRightWorldPos); | ||
|
|
||
| // add image to the annotations svg layer | ||
| const svgns = 'http://www.w3.org/2000/svg'; | ||
| const svgNodeHash = `image-overlay-${_id}`; | ||
| const existingImageElement = svgDrawingHelper.getSvgNode(svgNodeHash); | ||
|
|
||
| const attributes = { | ||
| 'data-id': svgNodeHash, | ||
| width: overlayBottomRightOnCanvas[0] - overlayTopLeftOnCanvas[0], | ||
| height: overlayBottomRightOnCanvas[1] - overlayTopLeftOnCanvas[1], | ||
| x: overlayTopLeftOnCanvas[0], | ||
| y: overlayTopLeftOnCanvas[1], | ||
| href: overlayData.dataUrl, | ||
| }; | ||
|
|
||
| if ( | ||
| isNaN(attributes.x) || | ||
| isNaN(attributes.y) || | ||
| isNaN(attributes.width) || | ||
| isNaN(attributes.height) | ||
| ) { | ||
| console.warn('Invalid rendering attribute for image overlay', attributes['data-id']); | ||
| return false; | ||
| } | ||
|
|
||
| if (existingImageElement) { | ||
| drawing.setAttributesIfNecessary(attributes, existingImageElement); | ||
| svgDrawingHelper.setNodeTouched(svgNodeHash); | ||
| } else { | ||
| const newImageElement = document.createElementNS(svgns, 'image'); | ||
| drawing.setNewAttributesIfValid(attributes, newImageElement); | ||
| svgDrawingHelper.appendNode(newImageElement, svgNodeHash); | ||
| } | ||
| return true; | ||
| } | ||
|
|
||
| private async _getCachedStat( | ||
| imageId: string, | ||
| overlayMetadata: any[], | ||
| color: number[] | ||
| ): Promise<CachedStat> { | ||
| if (this._cachedStats[imageId] && this._isSameColor(this._cachedStats[imageId].color, color)) { | ||
| return this._cachedStats[imageId]; | ||
| } | ||
|
|
||
| const overlays = await Promise.all( | ||
| overlayMetadata | ||
| .filter(overlay => overlay.pixelData) | ||
| .map(async (overlay, idx) => { | ||
| let pixelData = null; | ||
| if (overlay.pixelData.Value) { | ||
| pixelData = overlay.pixelData.Value; | ||
| } else if (overlay.pixelData.retrieveBulkData) { | ||
| pixelData = await overlay.pixelData.retrieveBulkData(); | ||
| } | ||
|
|
||
| if (!pixelData) { | ||
| return; | ||
| } | ||
|
|
||
| const dataUrl = this._renderOverlayToDataUrl( | ||
| { width: overlay.columns, height: overlay.rows }, | ||
| color, | ||
| pixelData | ||
| ); | ||
|
|
||
| return { | ||
| ...overlay, | ||
| _id: guid(), | ||
| dataUrl, // this will be a data url expression of the rendered image | ||
| color, | ||
| }; | ||
| }) | ||
| ); | ||
|
|
||
| this._cachedStats[imageId] = { | ||
| color: color, | ||
| overlays: overlays.filter(overlay => overlay), | ||
| }; | ||
|
|
||
| return this._cachedStats[imageId]; | ||
| } | ||
|
|
||
| /** | ||
| * compare two RGBA expression of colors. | ||
| * | ||
| * @param color1 | ||
| * @param color2 | ||
| * @returns | ||
| */ | ||
| private _isSameColor(color1: number[], color2: number[]) { | ||
| return ( | ||
| color1 && | ||
| color2 && | ||
| color1[0] === color2[0] && | ||
| color1[1] === color2[1] && | ||
| color1[2] === color2[2] && | ||
| color1[3] === color2[3] | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * pixelData of overlayPlane module is an array of bits corresponding | ||
| * to each of the underlying pixels of the image. | ||
| * Let's create pixel data from bit array of overlay data | ||
| * | ||
| * @param pixelDataRaw | ||
| * @param color | ||
| * @returns | ||
| */ | ||
| private _renderOverlayToDataUrl({ width, height }, color, pixelDataRaw) { | ||
| const pixelDataView = new DataView(pixelDataRaw); | ||
| const totalBits = width * height; | ||
|
|
||
| const canvas = document.createElement('canvas'); | ||
| canvas.width = width; | ||
| canvas.height = height; | ||
|
|
||
| const ctx = canvas.getContext('2d'); | ||
| ctx.clearRect(0, 0, width, height); // make it transparent | ||
| ctx.globalCompositeOperation = 'copy'; | ||
|
|
||
| const imageData = ctx.getImageData(0, 0, width, height); | ||
| const data = imageData.data; | ||
| for (let i = 0, bitIdx = 0, byteIdx = 0; i < totalBits; i++) { | ||
| if (pixelDataView.getUint8(byteIdx) & (1 << bitIdx)) { | ||
| data[i * 4] = color[0]; | ||
| data[i * 4 + 1] = color[1]; | ||
| data[i * 4 + 2] = color[2]; | ||
| data[i * 4 + 3] = color[3]; | ||
| } | ||
|
|
||
| // next bit, byte | ||
| if (bitIdx >= 7) { | ||
| bitIdx = 0; | ||
| byteIdx++; | ||
| } else { | ||
| bitIdx++; | ||
| } | ||
| } | ||
| ctx.putImageData(imageData, 0, 0); | ||
|
|
||
| return canvas.toDataURL(); | ||
| } | ||
| } | ||
|
|
||
| export default ImageOverlayViewerTool; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.