[Bug] Various issues with ScaleOverlayTool.ts

[fbuonomo]

Describe the Bug

Hi, I've made a series of changes to the ScaleOverlayTool.ts file to resolve a number of issues that have arisen during use.
Here are the changes:
On line 75, I've added a check for enabled elements because they may not be there:
if (!enabledElements.length || !enabledElements[0]?.viewport) {
return;
}
In renderAnnotation, I've changed the start of the line as follows because the annotations may not yet be visible:
const renderStatus = false;
const location = this.configuration.scaleLocation;
const { viewport } = enabledElement;
if (!viewport) {
return renderStatus;
}
const annotations = getAnnotations(this.getToolName(), viewport.element);
if (!annotations?.length) {
return renderStatus;
}
const annotation = annotations.filter(
(thisAnnotation) => thisAnnotation.data.viewportId == viewport.id
)[0];
const canvas = enabledElement.viewport.canvas;

if ((annotation?.data?.handles?.points?.length ?? 0) < 4) {
return renderStatus;
}

I also modified the _getTextLines function to prevent the text from referencing cm or mm when pixel spacing information is missing. The modified version:
_hasSpacing() {
const imageId = this.editData.viewport.getCurrentImageId?.();
const imagePlaneModule = metaData.get('imagePlaneModule', imageId);
const spacing = imagePlaneModule?.pixelSpacing ?? null;
return spacing && spacing[0] > 0 && spacing[1] > 0;
}

_getTextLines(scaleSize: number): string[] | undefined {
let scaleSizeDisplayValue;
let scaleSizeUnits;
if (!this._hasSpacing()) {
scaleSizeDisplayValue = scaleSize;
scaleSizeUnits = 'px';
}
else {
if (scaleSize >= 50) {
scaleSizeDisplayValue = scaleSize / 10; //convert to cm
scaleSizeUnits = 'cm';
} else {
scaleSizeDisplayValue = scaleSize; //convert to cm
scaleSizeUnits = 'mm';
}
}
Finally, I modified the return value of the computeScaleSize function because in some cases, scaleSizes.filter may return an empty array.
return currentScaleSize[0] || 2;

With these changes, my application works fine.
If they work, I'd like to see if they can be included in the next release.

I'm attaching the new ScaleOverlayTool.ts file.

ScaleOverlayTool.zip

Steps to Reproduce

Not applicable

The current behavior

abnormal behavior and annotation blocking

The expected behavior

Not applicable

System Information

cornerstone3D versione 4.3.13
node 22.14.0

[fbuonomo]

Sorry, I didn't quite understand how it worked.
I had to modify the _hasSpacing() and _getTextLines(scaleSize: number) functions again.
The correct functions are as follows:

const textBoxLines = this._getTextLines(scaleSize,viewport);

_hasSpacing(viewport: Types.IEnabledElement) {
const imageId = viewport.getCurrentImageId?.();
const imagePlaneModule = metaData.get('imagePlaneModule', imageId);
const spacing = imagePlaneModule?.pixelSpacing ?? null;
return spacing && spacing[0] > 0 && spacing[1] > 0;
}

_getTextLines(scaleSize: number, viewport: Types.IEnabledElement): string[] | undefined {
let scaleSizeDisplayValue;
let scaleSizeUnits;
if (!this._hasSpacing(viewport)) {
scaleSizeDisplayValue = scaleSize;
scaleSizeUnits = 'px';
}
else {
if (scaleSize >= 50) {
scaleSizeDisplayValue = scaleSize / 10; //convert to cm
scaleSizeUnits = 'cm';
} else {
scaleSizeDisplayValue = scaleSize; //convert to cm
scaleSizeUnits = 'mm';
}
}
const textLines = [scaleSizeDisplayValue.toString().concat(scaleSizeUnits)];

return textLines;
}

Attached is the complete file after the changes

ScaleOverlayTool.zip

[fbuonomo]

I added volume management

_hasSpacing(viewport: Types.IEnabledElement) {
const imageId = viewport.getCurrentImageId?.();
if (imageId) {
const imagePlaneModule = metaData.get('imagePlaneModule', imageId);
const spacing = imagePlaneModule?.pixelSpacing ?? null;
return spacing && spacing[0] > 0 && spacing[1] > 0;
}
else {
const volumeId = viewport.getVolumeId?.();
const volume = cache.getVolume(volumeId);
const imageData = volume?.imageData;
const spacing = imageData?.getSpacing();
return spacing && spacing[0] > 0 && spacing[1] > 0;
}

}