TrizTech/ohif-viewer
17
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(general): enhancements and bug fixes (#4018)

Browse Source
This commit is contained in:
Ibrahim authored and GitHub committed 2024-04-10 11:34:13 -04:00
1 parent ac0e1c0a2c
commit 2b83393f91
30 files changed
+710 -151
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

extensions/cornerstone/src/Viewport/OHIFCornerstoneViewport.tsx
+1
View File
@@ -444,6 +444,7 @@ const OHIFCornerstoneViewport = React.memo(props => {
actions={viewportDialogState.actions}
onSubmit={viewportDialogState.onSubmit}
onOutsideClick={viewportDialogState.onOutsideClick}
onKeyPress={viewportDialogState.onKeyPress}
/>
)}
</div>
extensions/cornerstone/src/getCustomizationModule.ts
+130
View File
@@ -64,6 +64,136 @@ function getCustomizationModule() {
step: 1,
},
},
{
id: 'cornerstone.measurements',
Angle: {
displayText: [],
report: [],
},
CobbAngle: {
displayText: [],
report: [],
},
ArrowAnnotate: {
displayText: [],
report: [],
},
RectangleROi: {
displayText: [],
report: [],
},
CircleROI: {
displayText: [],
report: [],
},
EllipticalROI: {
displayText: [],
report: [],
},
Bidirectional: {
displayText: [],
report: [],
},
Length: {
displayText: [],
report: [],
},
LivewireContour: {
displayText: [],
report: [],
},
SplineROI: {
displayText: [
{
displayName: 'Area',
value: 'area',
type: 'value',
},
{
value: 'areaUnit',
for: ['area'],
type: 'unit',
},
/**
{
displayName: 'Modality',
value: 'Modality',
type: 'value',
},
*/
],
report: [
{
displayName: 'Area',
value: 'area',
type: 'value',
},
{
displayName: 'Unit',
value: 'areaUnit',
type: 'value',
},
],
},
PlanarFreehandROI: {
displayText: [
{
displayName: 'Mean',
value: 'mean',
type: 'value',
},
{
displayName: 'Max',
value: 'max',
type: 'value',
},
{
displayName: 'Area',
value: 'area',
type: 'value',
},
{
value: 'modalityUnit',
for: ['mean', 'max' /** 'stdDev **/],
type: 'unit',
},
{
value: 'areaUnit',
for: ['area'],
type: 'unit',
},
/**
{
displayName: 'Std Dev',
value: 'stdDev',
type: 'value',
},
*/
],
report: [
{
displayName: 'Mean',
value: 'mean',
type: 'value',
},
{
displayName: 'Max',
value: 'max',
type: 'value',
},
{
displayName: 'Area',
value: 'area',
type: 'value',
},
{
displayName: 'Unit',
value: 'unit',
type: 'value',
},
],
},
},
],
},
];
extensions/cornerstone/src/initMeasurementService.js
+30 -5
View File
@@ -17,7 +17,8 @@ const CORNERSTONE_3D_TOOLS_SOURCE_VERSION = '0.1';
const initMeasurementService = (
measurementService,
displaySetService,
cornerstoneViewportService
cornerstoneViewportService,
customizationService
) => {
/* Initialization */
const {
@@ -30,10 +31,13 @@ const initMeasurementService = (
CobbAngle,
RectangleROI,
PlanarFreehandROI,
SplineROI,
LivewireContour,
} = measurementServiceMappingsFactory(
measurementService,
displaySetService,
cornerstoneViewportService
cornerstoneViewportService,
customizationService
);
const csTools3DVer1MeasurementSource = measurementService.createSource(
CORNERSTONE_3D_TOOLS_SOURCE_NAME,
@@ -127,6 +131,14 @@ const initMeasurementService = (
PlanarFreehandROI.toMeasurement
);
measurementService.addMapping(
csTools3DVer1MeasurementSource,
'SplineROI',
SplineROI.matchingCriteria,
SplineROI.toAnnotation,
SplineROI.toMeasurement
);
// On the UI side, the Calibration Line tool will work almost the same as the
// Length tool
measurementService.addMapping(
@@ -137,16 +149,29 @@ const initMeasurementService = (
Length.toMeasurement
);
measurementService.addMapping(
csTools3DVer1MeasurementSource,
'LivewireContour',
LivewireContour.matchingCriteria,
LivewireContour.toAnnotation,
LivewireContour.toMeasurement
);
return csTools3DVer1MeasurementSource;
};
const connectToolsToMeasurementService = servicesManager => {
const { measurementService, displaySetService, cornerstoneViewportService } =
servicesManager.services;
const {
measurementService,
displaySetService,
cornerstoneViewportService,
customizationService,
} = servicesManager.services;
const csTools3DVer1MeasurementSource = initMeasurementService(
measurementService,
displaySetService,
cornerstoneViewportService
cornerstoneViewportService,
customizationService
);
connectMeasurementServiceToTools(
measurementService,
extensions/cornerstone/src/utils/callInputDialog.tsx
+1 -4
View File
@@ -109,13 +109,10 @@ export function callLabelAutocompleteDialog(uiDialogService, callback, dialogCon
uiDialogService.create({
id: 'select-annotation',
centralize: true,
isDraggable: false,
showOverlay: true,
content: LabellingFlow,
defaultPosition: {
x: window.innerWidth / 2,
y: window.innerHeight / 2,
},
contentProps: {
labellingDoneCallback: labellingDoneCallback,
measurementData: { label: '' },
extensions/cornerstone/src/utils/measurementServiceMappings/Angle.ts
+7 -5
View File
@@ -16,7 +16,8 @@ const Angle = {
csToolsEventDetail,
displaySetService,
CornerstoneViewportService,
getValueTypeFromToolType
getValueTypeFromToolType,
customizationService
) => {
const { annotation, viewportId } = csToolsEventDetail;
const { metadata, data, annotationUID } = annotation;
@@ -54,8 +55,9 @@ const Angle = {
const mappedAnnotations = getMappedAnnotations(annotation, displaySetService);
const displayText = getDisplayText(mappedAnnotations, displaySet);
const getReport = () => _getReport(mappedAnnotations, points, FrameOfReferenceUID);
const displayText = getDisplayText(mappedAnnotations, displaySet, customizationService);
const getReport = () =>
_getReport(mappedAnnotations, points, FrameOfReferenceUID, customizationService);
return {
uid: annotationUID,
@@ -127,7 +129,7 @@ This function is used to convert the measurement data to a format that is
suitable for the report generation (e.g. for the csv report). The report
returns a list of columns and corresponding values.
*/
function _getReport(mappedAnnotations, points, FrameOfReferenceUID) {
function _getReport(mappedAnnotations, points, FrameOfReferenceUID, customizationService) {
const columns = [];
const values = [];
@@ -160,7 +162,7 @@ function _getReport(mappedAnnotations, points, FrameOfReferenceUID) {
};
}
function getDisplayText(mappedAnnotations, displaySet) {
function getDisplayText(mappedAnnotations, displaySet, customizationService) {
if (!mappedAnnotations || !mappedAnnotations.length) {
return '';
}
extensions/cornerstone/src/utils/measurementServiceMappings/ArrowAnnotate.ts
+4 -3
View File
@@ -14,7 +14,8 @@ const Length = {
csToolsEventDetail,
displaySetService,
cornerstoneViewportService,
getValueTypeFromToolType
getValueTypeFromToolType,
customizationService
) => {
const { annotation, viewportId } = csToolsEventDetail;
const { metadata, data, annotationUID } = annotation;
@@ -52,7 +53,7 @@ const Length = {
const mappedAnnotations = getMappedAnnotations(annotation, displaySetService);
const displayText = getDisplayText(mappedAnnotations, displaySet);
const displayText = getDisplayText(mappedAnnotations, displaySet, customizationService);
return {
uid: annotationUID,
@@ -106,7 +107,7 @@ function getMappedAnnotations(annotation, displaySetService) {
return annotations;
}
function getDisplayText(mappedAnnotations, displaySet) {
function getDisplayText(mappedAnnotations, displaySet, customizationService) {
if (!mappedAnnotations) {
return '';
}
extensions/cornerstone/src/utils/measurementServiceMappings/Bidirectional.ts
+7 -5
View File
@@ -11,7 +11,8 @@ const Bidirectional = {
csToolsEventDetail,
displaySetService,
cornerstoneViewportService,
getValueTypeFromToolType
getValueTypeFromToolType,
customizationService
) => {
const { annotation, viewportId } = csToolsEventDetail;
const { metadata, data, annotationUID } = annotation;
@@ -49,8 +50,9 @@ const Bidirectional = {
const mappedAnnotations = getMappedAnnotations(annotation, displaySetService);
const displayText = getDisplayText(mappedAnnotations, displaySet);
const getReport = () => _getReport(mappedAnnotations, points, FrameOfReferenceUID);
const displayText = getDisplayText(mappedAnnotations, displaySet, customizationService);
const getReport = () =>
_getReport(mappedAnnotations, points, FrameOfReferenceUID, customizationService);
return {
uid: annotationUID,
@@ -122,7 +124,7 @@ This function is used to convert the measurement data to a format that is
suitable for the report generation (e.g. for the csv report). The report
returns a list of columns and corresponding values.
*/
function _getReport(mappedAnnotations, points, FrameOfReferenceUID) {
function _getReport(mappedAnnotations, points, FrameOfReferenceUID, customizationService) {
const columns = [];
const values = [];
@@ -155,7 +157,7 @@ function _getReport(mappedAnnotations, points, FrameOfReferenceUID) {
};
}
function getDisplayText(mappedAnnotations, displaySet) {
function getDisplayText(mappedAnnotations, displaySet, customizationService) {
if (!mappedAnnotations || !mappedAnnotations.length) {
return '';
}
extensions/cornerstone/src/utils/measurementServiceMappings/CircleROI.ts
+7 -5
View File
@@ -9,7 +9,8 @@ const CircleROI = {
csToolsEventDetail,
DisplaySetService,
CornerstoneViewportService,
getValueTypeFromToolType
getValueTypeFromToolType,
customizationService
) => {
const { annotation, viewportId } = csToolsEventDetail;
const { metadata, data, annotationUID } = annotation;
@@ -47,8 +48,9 @@ const CircleROI = {
const mappedAnnotations = getMappedAnnotations(annotation, DisplaySetService);
const displayText = getDisplayText(mappedAnnotations, displaySet);
const getReport = () => _getReport(mappedAnnotations, points, FrameOfReferenceUID);
const displayText = getDisplayText(mappedAnnotations, displaySet, customizationService);
const getReport = () =>
_getReport(mappedAnnotations, points, FrameOfReferenceUID, customizationService);
return {
uid: annotationUID,
@@ -125,7 +127,7 @@ This function is used to convert the measurement data to a format that is
suitable for the report generation (e.g. for the csv report). The report
returns a list of columns and corresponding values.
*/
function _getReport(mappedAnnotations, points, FrameOfReferenceUID) {
function _getReport(mappedAnnotations, points, FrameOfReferenceUID, customizationService) {
const columns = [];
const values = [];
@@ -163,7 +165,7 @@ function _getReport(mappedAnnotations, points, FrameOfReferenceUID) {
};
}
function getDisplayText(mappedAnnotations, displaySet) {
function getDisplayText(mappedAnnotations, displaySet, customizationService) {
if (!mappedAnnotations || !mappedAnnotations.length) {
return '';
}
extensions/cornerstone/src/utils/measurementServiceMappings/CobbAngle.ts
+7 -5
View File
@@ -16,7 +16,8 @@ const CobbAngle = {
csToolsEventDetail,
displaySetService,
CornerstoneViewportService,
getValueTypeFromToolType
getValueTypeFromToolType,
customizationService
) => {
const { annotation, viewportId } = csToolsEventDetail;
const { metadata, data, annotationUID } = annotation;
@@ -54,8 +55,9 @@ const CobbAngle = {
const mappedAnnotations = getMappedAnnotations(annotation, displaySetService);
const displayText = getDisplayText(mappedAnnotations, displaySet);
const getReport = () => _getReport(mappedAnnotations, points, FrameOfReferenceUID);
const displayText = getDisplayText(mappedAnnotations, displaySet, customizationService);
const getReport = () =>
_getReport(mappedAnnotations, points, FrameOfReferenceUID, customizationService);
return {
uid: annotationUID,
@@ -127,7 +129,7 @@ This function is used to convert the measurement data to a format that is
suitable for the report generation (e.g. for the csv report). The report
returns a list of columns and corresponding values.
*/
function _getReport(mappedAnnotations, points, FrameOfReferenceUID) {
function _getReport(mappedAnnotations, points, FrameOfReferenceUID, customizationService) {
const columns = [];
const values = [];
@@ -160,7 +162,7 @@ function _getReport(mappedAnnotations, points, FrameOfReferenceUID) {
};
}
function getDisplayText(mappedAnnotations, displaySet) {
function getDisplayText(mappedAnnotations, displaySet, customizationService) {
if (!mappedAnnotations || !mappedAnnotations.length) {
return '';
}
extensions/cornerstone/src/utils/measurementServiceMappings/EllipticalROI.ts
+7 -5
View File
@@ -9,7 +9,8 @@ const EllipticalROI = {
csToolsEventDetail,
displaySetService,
cornerstoneViewportService,
getValueTypeFromToolType
getValueTypeFromToolType,
customizationService
) => {
const { annotation, viewportId } = csToolsEventDetail;
const { metadata, data, annotationUID } = annotation;
@@ -47,8 +48,9 @@ const EllipticalROI = {
const mappedAnnotations = getMappedAnnotations(annotation, displaySetService);
const displayText = getDisplayText(mappedAnnotations, displaySet);
const getReport = () => _getReport(mappedAnnotations, points, FrameOfReferenceUID);
const displayText = getDisplayText(mappedAnnotations, displaySet, customizationService);
const getReport = () =>
_getReport(mappedAnnotations, points, FrameOfReferenceUID, customizationService);
return {
uid: annotationUID,
@@ -125,7 +127,7 @@ This function is used to convert the measurement data to a format that is
suitable for the report generation (e.g. for the csv report). The report
returns a list of columns and corresponding values.
*/
function _getReport(mappedAnnotations, points, FrameOfReferenceUID) {
function _getReport(mappedAnnotations, points, FrameOfReferenceUID, customizationService) {
const columns = [];
const values = [];
@@ -163,7 +165,7 @@ function _getReport(mappedAnnotations, points, FrameOfReferenceUID) {
};
}
function getDisplayText(mappedAnnotations, displaySet) {
function getDisplayText(mappedAnnotations, displaySet, customizationService) {
if (!mappedAnnotations || !mappedAnnotations.length) {
return '';
}
extensions/cornerstone/src/utils/measurementServiceMappings/Length.ts
+12 -25
View File
@@ -15,7 +15,8 @@ const Length = {
csToolsEventDetail,
displaySetService,
cornerstoneViewportService,
getValueTypeFromToolType
getValueTypeFromToolType,
customizationService
) => {
const { annotation, viewportId } = csToolsEventDetail;
const { metadata, data, annotationUID } = annotation;
@@ -32,11 +33,7 @@ const Length = {
throw new Error('Tool not supported');
}
const {
SOPInstanceUID,
SeriesInstanceUID,
StudyInstanceUID,
} = getSOPInstanceAttributes(
const { SOPInstanceUID, SeriesInstanceUID, StudyInstanceUID } = getSOPInstanceAttributes(
referencedImageId,
cornerstoneViewportService,
viewportId
@@ -57,8 +54,9 @@ const Length = {
const mappedAnnotations = getMappedAnnotations(annotation, displaySetService);
const displayText = getDisplayText(mappedAnnotations, displaySet);
const getReport = () => _getReport(mappedAnnotations, points, FrameOfReferenceUID);
const displayText = getDisplayText(mappedAnnotations, displaySet, customizationService);
const getReport = () =>
_getReport(mappedAnnotations, points, FrameOfReferenceUID, customizationService);
return {
uid: annotationUID,
@@ -99,11 +97,8 @@ function getMappedAnnotations(annotation, displaySetService) {
throw new Error('Non-acquisition plane measurement mapping not supported');
}
const {
SOPInstanceUID,
SeriesInstanceUID,
frameNumber,
} = getSOPInstanceAttributes(referencedImageId);
const { SOPInstanceUID, SeriesInstanceUID, frameNumber } =
getSOPInstanceAttributes(referencedImageId);
const displaySet = displaySetService.getDisplaySetForSOPInstanceUID(
SOPInstanceUID,
@@ -132,7 +127,7 @@ This function is used to convert the measurement data to a format that is
suitable for the report generation (e.g. for the csv report). The report
returns a list of columns and corresponding values.
*/
function _getReport(mappedAnnotations, points, FrameOfReferenceUID) {
function _getReport(mappedAnnotations, points, FrameOfReferenceUID, customizationService) {
const columns = [];
const values = [];
@@ -167,7 +162,7 @@ function _getReport(mappedAnnotations, points, FrameOfReferenceUID) {
};
}
function getDisplayText(mappedAnnotations, displaySet) {
function getDisplayText(mappedAnnotations, displaySet, customizationService) {
if (!mappedAnnotations || !mappedAnnotations.length) {
return '';
}
@@ -175,13 +170,7 @@ function getDisplayText(mappedAnnotations, displaySet) {
const displayText = [];
// Area is the same for all series
const {
length,
SeriesNumber,
SOPInstanceUID,
frameNumber,
unit,
} = mappedAnnotations[0];
const { length, SeriesNumber, SOPInstanceUID, frameNumber, unit } = mappedAnnotations[0];
const instance = displaySet.images.find(image => image.SOPInstanceUID === SOPInstanceUID);
@@ -197,9 +186,7 @@ function getDisplayText(mappedAnnotations, displaySet) {
return displayText;
}
const roundedLength = utils.roundNumber(length, 2);
displayText.push(
`${roundedLength} ${unit} (S: ${SeriesNumber}${instanceText}${frameText})`
);
displayText.push(`${roundedLength} ${unit} (S: ${SeriesNumber}${instanceText}${frameText})`);
return displayText;
}
extensions/cornerstone/src/utils/measurementServiceMappings/LivewireContour.ts
+161
View File
@@ -0,0 +1,161 @@
import SUPPORTED_TOOLS from './constants/supportedTools';
import getSOPInstanceAttributes from './utils/getSOPInstanceAttributes';
import { getDisplayUnit } from './utils';
import { utils } from '@ohif/core';
/**
* Represents a mapping utility for Livewire measurements.
*/
const LivewireContour = {
toAnnotation: measurement => {},
/**
* Maps cornerstone annotation event data to measurement service format.
*
* @param {Object} csToolsEventDetail Cornerstone event data
* @param {DisplaySetService} DisplaySetService Service for managing display sets
* @param {CornerstoneViewportService} CornerstoneViewportService Service for managing viewports
* @param {Function} getValueTypeFromToolType Function to get value type from tool type
* @returns {Measurement} Measurement instance
*/
toMeasurement: (
csToolsEventDetail,
DisplaySetService,
CornerstoneViewportService,
getValueTypeFromToolType,
customizationService
) => {
const { annotation } = csToolsEventDetail;
const { metadata, data, annotationUID } = annotation;
if (!metadata || !data) {
console.warn('Livewire tool: Missing metadata or data');
return null;
}
const { toolName, referencedImageId, FrameOfReferenceUID } = metadata;
const validToolType = SUPPORTED_TOOLS.includes(toolName);
if (!validToolType) {
throw new Error(`Tool ${toolName} not supported`);
}
const { SOPInstanceUID, SeriesInstanceUID, frameNumber, StudyInstanceUID } =
getSOPInstanceAttributes(referencedImageId);
let displaySet;
if (SOPInstanceUID) {
displaySet = DisplaySetService.getDisplaySetForSOPInstanceUID(
SOPInstanceUID,
SeriesInstanceUID
);
} else {
displaySet = DisplaySetService.getDisplaySetsForSeries(SeriesInstanceUID);
}
return {
uid: annotationUID,
SOPInstanceUID,
FrameOfReferenceUID,
points: data.contour.polyline,
textBox: data.handles.textBox,
metadata,
frameNumber,
referenceSeriesUID: SeriesInstanceUID,
referenceStudyUID: StudyInstanceUID,
toolName: metadata.toolName,
displaySetInstanceUID: displaySet.displaySetInstanceUID,
label: data.label,
displayText: getDisplayText(annotation, displaySet, customizationService),
data: data.cachedStats,
type: getValueTypeFromToolType(toolName),
getReport: () => getColumnValueReport(annotation, customizationService),
};
},
};
/**
* This function is used to convert the measurement data to a
* format that is suitable for report generation (e.g. for the csv report).
* The report returns a list of columns and corresponding values.
*
* @param {object} annotation
* @returns {object} Report's content from this tool
*/
function getColumnValueReport(annotation, customizationService) {
const columns = [];
const values = [];
/** Add type */
columns.push('AnnotationType');
values.push('Cornerstone:Livewire');
/** Add cachedStats */
const { metadata, data } = annotation;
/** Add FOR */
if (metadata.FrameOfReferenceUID) {
columns.push('FrameOfReferenceUID');
values.push(metadata.FrameOfReferenceUID);
}
/** Add points */
if (data.contour.polyline) {
/**
* Points has the form of [[x1, y1, z1], [x2, y2, z2], ...]
* convert it to string of [[x1 y1 z1];[x2 y2 z2];...]
* so that it can be used in the CSV report
*/
columns.push('points');
values.push(data.contour.polyline.map(p => p.join(' ')).join(';'));
}
return { columns, values };
}
/**
* Retrieves the display text for an annotation in a display set.
*
* @param {Object} annotation - The annotation object.
* @param {Object} displaySet - The display set object.
* @returns {string[]} - An array of display text.
*/
function getDisplayText(annotation, displaySet, customizationService) {
const { metadata, data } = annotation;
if (!data.cachedStats || !data.cachedStats[`imageId:${metadata.referencedImageId}`]) {
return [];
}
const { area, areaUnit } = data.cachedStats[`imageId:${metadata.referencedImageId}`];
const { SOPInstanceUID, frameNumber } = getSOPInstanceAttributes(metadata.referencedImageId);
const displayText = [];
const instance = displaySet.images.find(image => image.SOPInstanceUID === SOPInstanceUID);
let InstanceNumber;
if (instance) {
InstanceNumber = instance.InstanceNumber;
}
const instanceText = InstanceNumber ? ` I: ${InstanceNumber}` : '';
const frameText = displaySet.isMultiFrame ? ` F: ${frameNumber}` : '';
const { SeriesNumber } = displaySet;
if (SeriesNumber) {
displayText.push(`S: ${SeriesNumber}${instanceText}${frameText}`);
}
if (area) {
/**
* Add Area
* Area sometimes becomes undefined if `preventHandleOutsideImage` is off
*/
const roundedArea = utils.roundNumber(area || 0, 2);
displayText.push(`${roundedArea} ${getDisplayUnit(areaUnit)}`);
}
return displayText;
}
export default LivewireContour;
extensions/cornerstone/src/utils/measurementServiceMappings/PlanarFreehandROI.ts
+44 -60
View File
@@ -22,7 +22,8 @@ const PlanarFreehandROI = {
csToolsEventDetail,
DisplaySetService,
CornerstoneViewportService,
getValueTypeFromToolType
getValueTypeFromToolType,
customizationService
) => {
const { annotation } = csToolsEventDetail;
const { metadata, data, annotationUID } = annotation;
@@ -64,10 +65,10 @@ const PlanarFreehandROI = {
toolName: metadata.toolName,
displaySetInstanceUID: displaySet.displaySetInstanceUID,
label: data.label,
displayText: getDisplayText(annotation, displaySet),
displayText: getDisplayText(annotation, displaySet, customizationService),
data: data.cachedStats,
type: getValueTypeFromToolType(toolName),
getReport: () => getColumnValueReport(annotation),
getReport: () => getColumnValueReport(annotation, customizationService),
};
},
};
@@ -80,7 +81,9 @@ const PlanarFreehandROI = {
* @param {object} annotation
* @returns {object} Report's content from this tool
*/
function getColumnValueReport(annotation) {
function getColumnValueReport(annotation, customizationService) {
const { PlanarFreehandROI } = customizationService.get('cornerstone.measurements');
const { report } = PlanarFreehandROI;
const columns = [];
const values = [];
@@ -90,10 +93,12 @@ function getColumnValueReport(annotation) {
/** Add cachedStats */
const { metadata, data } = annotation;
const { mean, stdDev, max, area, unit, areaUnit, perimeter } =
data.cachedStats[`imageId:${metadata.referencedImageId}`];
columns.push(`Maximum`, `Mean`, `Std Dev`, 'Pixel Unit', `Area`, 'Unit', 'Perimeter');
values.push(max, mean, stdDev, unit, area, areaUnit, perimeter);
const stats = data.cachedStats[`imageId:${metadata.referencedImageId}`];
report.forEach(({ name, value }) => {
columns.push(name);
stats[value] ? values.push(stats[value]) : values.push('not available');
});
/** Add FOR */
if (metadata.FrameOfReferenceUID) {
@@ -103,11 +108,6 @@ function getColumnValueReport(annotation) {
/** Add points */
if (data.contour.polyline) {
/**
* Points has the form of [[x1, y1, z1], [x2, y2, z2], ...]
* convert it to string of [[x1 y1 z1];[x2 y2 z2];...]
* so that it can be used in the CSV report
*/
columns.push('points');
values.push(data.contour.polyline.map(p => p.join(' ')).join(';'));
}
@@ -122,19 +122,19 @@ function getColumnValueReport(annotation) {
* @param {Object} displaySet - The display set object.
* @returns {string[]} - An array of display text.
*/
function getDisplayText(annotation, displaySet) {
function getDisplayText(annotation, displaySet, customizationService) {
const { PlanarFreehandROI } = customizationService.get('cornerstone.measurements');
const { displayText } = PlanarFreehandROI;
const { metadata, data } = annotation;
if (!data.cachedStats || !data.cachedStats[`imageId:${metadata.referencedImageId}`]) {
return [];
}
const { mean, stdDev, max, area, modalityUnit, areaUnit, perimeter } =
data.cachedStats[`imageId:${metadata.referencedImageId}`];
const { SOPInstanceUID, frameNumber } = getSOPInstanceAttributes(metadata.referencedImageId);
const displayText = [];
const displayTextArray = [];
const instance = displaySet.images.find(image => image.SOPInstanceUID === SOPInstanceUID);
let InstanceNumber;
@@ -147,55 +147,39 @@ function getDisplayText(annotation, displaySet) {
const { SeriesNumber } = displaySet;
if (SeriesNumber) {
displayText.push(`S: ${SeriesNumber}${instanceText}${frameText}`);
displayTextArray.push(`S: ${SeriesNumber}${instanceText}${frameText}`);
}
if (area) {
/**
* Add Area
* Area sometimes becomes undefined if `preventHandleOutsideImage` is off
*/
const roundedArea = utils.roundNumber(area || 0, 2);
displayText.push(`Area: ${roundedArea} ${getDisplayUnit(areaUnit)}`);
}
const stats = data.cachedStats[`imageId:${metadata.referencedImageId}`];
if (mean) {
if (Array.isArray(mean)) {
const meanValues = mean.map(value => utils.roundNumber(value));
displayText.push(`Mean: ${meanValues.join(', ')} ${modalityUnit}`);
} else {
displayText.push(`Mean: ${utils.roundNumber(mean)} ${modalityUnit}`);
const roundValues = values => {
if (Array.isArray(values)) {
return values.map(value => {
if (isNaN(value)) {
return value;
}
return utils.roundNumber(value);
});
}
}
return isNaN(values) ? values : utils.roundNumber(values);
};
if (max) {
if (Array.isArray(max)) {
const maxValues = max.map(value => utils.roundNumber(value, 2));
displayText.push(`Max: ${maxValues.join(', ')} ${modalityUnit}`);
} else {
displayText.push(`Max: ${utils.roundNumber(max, 2)} ${modalityUnit}`);
const findUnitForValue = (displayTextItems, value) =>
displayTextItems.find(({ type, for: filter }) => type === 'unit' && filter.includes(value))
?.value;
const formatDisplayText = (displayName, result, unit) =>
`${displayName}: ${Array.isArray(result) ? roundValues(result).join(', ') : roundValues(result)} ${unit}`;
displayText.forEach(({ displayName, value, type }) => {
if (type === 'value') {
const result = stats[value];
const unit = stats[findUnitForValue(displayText, value)] || '';
displayTextArray.push(formatDisplayText(displayName, result, unit));
}
}
});
if (stdDev) {
if (Array.isArray(stdDev)) {
const stdDevValues = stdDev.map(value => utils.roundNumber(value));
displayText.push(`Std Dev: ${stdDevValues.join(', ')} ${modalityUnit}`);
} else {
displayText.push(`Std Dev: ${utils.roundNumber(stdDev)} ${modalityUnit}`);
}
}
if (perimeter) {
if (Array.isArray(perimeter)) {
const perimeterValues = perimeter.map(value => utils.roundNumber(value));
displayText.push(`Perimeter: ${perimeterValues.join(', ')} ${modalityUnit}`);
} else {
displayText.push(`Perimeter: ${utils.roundNumber(perimeter)} ${modalityUnit}`);
}
}
return displayText;
return displayTextArray;
}
export default PlanarFreehandROI;
extensions/cornerstone/src/utils/measurementServiceMappings/RectangleROI.ts
+7 -5
View File
@@ -9,7 +9,8 @@ const RectangleROI = {
csToolsEventDetail,
DisplaySetService,
CornerstoneViewportService,
getValueTypeFromToolType
getValueTypeFromToolType,
customizationService
) => {
const { annotation, viewportId } = csToolsEventDetail;
const { metadata, data, annotationUID } = annotation;
@@ -47,8 +48,9 @@ const RectangleROI = {
const mappedAnnotations = getMappedAnnotations(annotation, DisplaySetService);
const displayText = getDisplayText(mappedAnnotations, displaySet);
const getReport = () => _getReport(mappedAnnotations, points, FrameOfReferenceUID);
const displayText = getDisplayText(mappedAnnotations, displaySet, customizationService);
const getReport = () =>
_getReport(mappedAnnotations, points, FrameOfReferenceUID, customizationService);
return {
uid: annotationUID,
@@ -125,7 +127,7 @@ This function is used to convert the measurement data to a format that is
suitable for the report generation (e.g. for the csv report). The report
returns a list of columns and corresponding values.
*/
function _getReport(mappedAnnotations, points, FrameOfReferenceUID) {
function _getReport(mappedAnnotations, points, FrameOfReferenceUID, customizationService) {
const columns = [];
const values = [];
@@ -163,7 +165,7 @@ function _getReport(mappedAnnotations, points, FrameOfReferenceUID) {
};
}
function getDisplayText(mappedAnnotations, displaySet) {
function getDisplayText(mappedAnnotations, displaySet, customizationService) {
if (!mappedAnnotations || !mappedAnnotations.length) {
return '';
}
extensions/cornerstone/src/utils/measurementServiceMappings/SplineROI.ts
+188
View File
@@ -0,0 +1,188 @@
import SUPPORTED_TOOLS from './constants/supportedTools';
import getSOPInstanceAttributes from './utils/getSOPInstanceAttributes';
import { getDisplayUnit } from './utils';
import { utils } from '@ohif/core';
/**
* Represents a mapping utility for Spline ROI measurements.
*/
const SplineROI = {
toAnnotation: measurement => {},
/**
* Maps cornerstone annotation event data to measurement service format.
*
* @param {Object} csToolsEventDetail Cornerstone event data
* @param {DisplaySetService} DisplaySetService Service for managing display sets
* @param {CornerstoneViewportService} CornerstoneViewportService Service for managing viewports
* @param {Function} getValueTypeFromToolType Function to get value type from tool type
* @returns {Measurement} Measurement instance
*/
toMeasurement: (
csToolsEventDetail,
DisplaySetService,
CornerstoneViewportService,
getValueTypeFromToolType,
customizationService
) => {
const { annotation } = csToolsEventDetail;
const { metadata, data, annotationUID } = annotation;
if (!metadata || !data) {
console.warn('SplineROI tool: Missing metadata or data');
return null;
}
const { toolName, referencedImageId, FrameOfReferenceUID } = metadata;
const validToolType = SUPPORTED_TOOLS.includes(toolName);
if (!validToolType) {
throw new Error(`Tool ${toolName} not supported`);
}
const { SOPInstanceUID, SeriesInstanceUID, frameNumber, StudyInstanceUID } =
getSOPInstanceAttributes(referencedImageId);
let displaySet;
if (SOPInstanceUID) {
displaySet = DisplaySetService.getDisplaySetForSOPInstanceUID(
SOPInstanceUID,
SeriesInstanceUID
);
} else {
displaySet = DisplaySetService.getDisplaySetsForSeries(SeriesInstanceUID);
}
return {
uid: annotationUID,
SOPInstanceUID,
FrameOfReferenceUID,
points: data.contour.polyline,
textBox: data.handles.textBox,
metadata,
frameNumber,
referenceSeriesUID: SeriesInstanceUID,
referenceStudyUID: StudyInstanceUID,
toolName: metadata.toolName,
displaySetInstanceUID: displaySet.displaySetInstanceUID,
label: data.label,
displayText: getDisplayText(annotation, displaySet, customizationService),
data: data.cachedStats,
type: getValueTypeFromToolType(toolName),
getReport: () => getColumnValueReport(annotation, customizationService),
};
},
};
/**
* This function is used to convert the measurement data to a
* format that is suitable for report generation (e.g. for the csv report).
* The report returns a list of columns and corresponding values.
*
* @param {object} annotation
* @returns {object} Report's content from this tool
*/
function getColumnValueReport(annotation, customizationService) {
const { SplineROI } = customizationService.get('cornerstone.measurements');
const { report } = SplineROI;
const columns = [];
const values = [];
/** Add type */
columns.push('AnnotationType');
values.push('Cornerstone:SplineROI');
/** Add cachedStats */
const { metadata, data } = annotation;
const stats = data.cachedStats[`imageId:${metadata.referencedImageId}`];
report.forEach(({ name, value }) => {
columns.push(name);
stats[value] ? values.push(stats[value]) : values.push('not available');
});
/** Add FOR */
if (metadata.FrameOfReferenceUID) {
columns.push('FrameOfReferenceUID');
values.push(metadata.FrameOfReferenceUID);
}
/** Add points */
if (data.contour.polyline) {
/**
* Points has the form of [[x1, y1, z1], [x2, y2, z2], ...]
* convert it to string of [[x1 y1 z1];[x2 y2 z2];...]
* so that it can be used in the CSV report
*/
columns.push('points');
values.push(data.contour.polyline.map(p => p.join(' ')).join(';'));
}
return { columns, values };
}
/**
* Retrieves the display text for an annotation in a display set.
*
* @param {Object} annotation - The annotation object.
* @param {Object} displaySet - The display set object.
* @returns {string[]} - An array of display text.
*/
function getDisplayText(annotation, displaySet, customizationService) {
const { SplineROI } = customizationService.get('cornerstone.measurements');
const { displayText } = SplineROI;
const { metadata, data } = annotation;
if (!data.cachedStats || !data.cachedStats[`imageId:${metadata.referencedImageId}`]) {
return [];
}
const { SOPInstanceUID, frameNumber } = getSOPInstanceAttributes(metadata.referencedImageId);
const displayTextArray = [];
const instance = displaySet.images.find(image => image.SOPInstanceUID === SOPInstanceUID);
let InstanceNumber;
if (instance) {
InstanceNumber = instance.InstanceNumber;
}
const instanceText = InstanceNumber ? ` I: ${InstanceNumber}` : '';
const frameText = displaySet.isMultiFrame ? ` F: ${frameNumber}` : '';
const { SeriesNumber } = displaySet;
if (SeriesNumber) {
displayTextArray.push(`S: ${SeriesNumber}${instanceText}${frameText}`);
}
const stats = data.cachedStats[`imageId:${metadata.referencedImageId}`];
const roundValues = values => {
if (Array.isArray(values)) {
return values.map(value => {
if (isNaN(value)) {
return value;
}
return utils.roundNumber(value);
});
}
return isNaN(values) ? values : utils.roundNumber(values);
};
const findUnitForValue = (displayTextItems, value) =>
displayTextItems.find(({ type, for: filter }) => type === 'unit' && filter.includes(value))
?.value;
const formatDisplayText = (displayName, result, unit) =>
`${displayName}: ${Array.isArray(result) ? roundValues(result).join(', ') : roundValues(result)} ${unit}`;
displayText.forEach(({ displayName, value, type }) => {
if (type === 'value') {
const result = stats[value];
const unit = stats[findUnitForValue(displayText, value)] || '';
displayTextArray.push(formatDisplayText(displayName, result, unit));
}
});
return displayTextArray;
}
export default SplineROI;
extensions/cornerstone/src/utils/measurementServiceMappings/constants/supportedTools.js
+2
View File
@@ -9,4 +9,6 @@ export default [
'Probe',
'RectangleROI',
'PlanarFreehandROI',
'SplineROI',
'LivewireContour',
];
extensions/cornerstone/src/utils/measurementServiceMappings/measurementServiceMappingsFactory.ts
+58 -10
View File
@@ -8,11 +8,14 @@ import CobbAngle from './CobbAngle';
import Angle from './Angle';
import PlanarFreehandROI from './PlanarFreehandROI';
import RectangleROI from './RectangleROI';
import SplineROI from './SplineROI';
import LivewireContour from './LivewireContour';
const measurementServiceMappingsFactory = (
measurementService: MeasurementService,
displaySetService,
cornerstoneViewportService
cornerstoneViewportService,
customizationService
) => {
/**
* Maps measurement service format object to cornerstone annotation object.
@@ -39,6 +42,8 @@ const measurementServiceMappingsFactory = (
ArrowAnnotate: POINT,
CobbAngle: ANGLE,
Angle: ANGLE,
SplineROI: POLYLINE,
LivewireContour: POLYLINE,
};
return TOOL_TYPE_TO_VALUE_TYPE[toolType];
@@ -52,7 +57,8 @@ const measurementServiceMappingsFactory = (
csToolsAnnotation,
displaySetService,
cornerstoneViewportService,
_getValueTypeFromToolType
_getValueTypeFromToolType,
customizationService
),
matchingCriteria: [
{
@@ -68,7 +74,8 @@ const measurementServiceMappingsFactory = (
csToolsAnnotation,
displaySetService,
cornerstoneViewportService,
_getValueTypeFromToolType
_getValueTypeFromToolType,
customizationService
),
matchingCriteria: [
// TODO -> We should eventually do something like shortAxis + longAxis,
@@ -91,7 +98,8 @@ const measurementServiceMappingsFactory = (
csToolsAnnotation,
displaySetService,
cornerstoneViewportService,
_getValueTypeFromToolType
_getValueTypeFromToolType,
customizationService
),
matchingCriteria: [
{
@@ -107,7 +115,8 @@ const measurementServiceMappingsFactory = (
csToolsAnnotation,
displaySetService,
cornerstoneViewportService,
_getValueTypeFromToolType
_getValueTypeFromToolType,
customizationService
),
matchingCriteria: [
{
@@ -123,7 +132,8 @@ const measurementServiceMappingsFactory = (
csToolsAnnotation,
displaySetService,
cornerstoneViewportService,
_getValueTypeFromToolType
_getValueTypeFromToolType,
customizationService
),
matchingCriteria: [
{
@@ -139,7 +149,42 @@ const measurementServiceMappingsFactory = (
csToolsAnnotation,
displaySetService,
cornerstoneViewportService,
_getValueTypeFromToolType
_getValueTypeFromToolType,
customizationService
),
matchingCriteria: [
{
valueType: MeasurementService.VALUE_TYPES.POLYLINE,
},
],
},
SplineROI: {
toAnnotation: SplineROI.toAnnotation,
toMeasurement: csToolsAnnotation =>
SplineROI.toMeasurement(
csToolsAnnotation,
displaySetService,
cornerstoneViewportService,
_getValueTypeFromToolType,
customizationService
),
matchingCriteria: [
{
valueType: MeasurementService.VALUE_TYPES.POLYLINE,
},
],
},
LivewireContour: {
toAnnotation: LivewireContour.toAnnotation,
toMeasurement: csToolsAnnotation =>
LivewireContour.toMeasurement(
csToolsAnnotation,
displaySetService,
cornerstoneViewportService,
_getValueTypeFromToolType,
customizationService
),
matchingCriteria: [
{
@@ -155,7 +200,8 @@ const measurementServiceMappingsFactory = (
csToolsAnnotation,
displaySetService,
cornerstoneViewportService,
_getValueTypeFromToolType
_getValueTypeFromToolType,
customizationService
),
matchingCriteria: [
{
@@ -172,7 +218,8 @@ const measurementServiceMappingsFactory = (
csToolsAnnotation,
displaySetService,
cornerstoneViewportService,
_getValueTypeFromToolType
_getValueTypeFromToolType,
customizationService
),
matchingCriteria: [
{
@@ -188,7 +235,8 @@ const measurementServiceMappingsFactory = (
csToolsAnnotation,
displaySetService,
cornerstoneViewportService,
_getValueTypeFromToolType
_getValueTypeFromToolType,
customizationService
),
matchingCriteria: [
{