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

feat(handler): Add handler for unsupported sopclassUIDs (#3601)

Browse Source
This commit is contained in:
rodrigobasilio2022 2023-08-16 12:37:28 -03:00 committed by GitHub
parent de6976df3b
commit f845f87716
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 180 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
extensions/default/src/Panels/PanelStudyBrowser.tsx
View File

@ -131,7 +131,7 @@ function PanelStudyBrowser({
const imageId = imageIds[Math.floor(imageIds.length / 2)];
// TODO: Is it okay that imageIds are not returned here for SR displaySets?
if (imageId) {
if (imageId && !displaySet?.unsupported) {
// When the image arrives, render it and store the result in the thumbnailImgSrcMap
newImageSrcEntry[dSet.displaySetInstanceUID] = await getImageSrc(
imageId
@ -175,20 +175,22 @@ function PanelStudyBrowser({
const displaySet = displaySetService.getDisplaySetByUID(
dSet.displaySetInstanceUID
);
const imageIds = dataSource.getImageIdsForDisplaySet(displaySet);
const imageId = imageIds[Math.floor(imageIds.length / 2)];
if (!displaySet?.unsupported) {
const imageIds = dataSource.getImageIdsForDisplaySet(displaySet);
const imageId = imageIds[Math.floor(imageIds.length / 2)];
// TODO: Is it okay that imageIds are not returned here for SR displaysets?
if (imageId) {
// When the image arrives, render it and store the result in the thumbnailImgSrcMap
newImageSrcEntry[dSet.displaySetInstanceUID] = await getImageSrc(
imageId,
dSet.initialViewport
);
if (isMounted.current) {
setThumbnailImageSrcMap(prevState => {
return { ...prevState, ...newImageSrcEntry };
});
// TODO: Is it okay that imageIds are not returned here for SR displaysets?
if (imageId) {
// When the image arrives, render it and store the result in the thumbnailImgSrcMap
newImageSrcEntry[dSet.displaySetInstanceUID] = await getImageSrc(
imageId,
dSet.initialViewport
);
if (isMounted.current) {
setThumbnailImageSrcMap(prevState => {
return { ...prevState, ...newImageSrcEntry };
});
}
}
}
});
@ -308,7 +310,7 @@ function _mapDisplaySets(displaySets, thumbnailImageSrcMap) {
.filter(ds => !ds.excludeFromThumbnailBrowser)
.forEach(ds => {
const imageSrc = thumbnailImageSrcMap[ds.displaySetInstanceUID];
const componentType = _getComponentType(ds.Modality);
const componentType = _getComponentType(ds);
const array =
componentType === 'thumbnail'
@ -348,8 +350,8 @@ const thumbnailNoImageModalities = [
'RTDOSE',
];
function _getComponentType(Modality) {
if (thumbnailNoImageModalities.includes(Modality)) {
function _getComponentType(ds) {
if (thumbnailNoImageModalities.includes(ds.Modality) || ds?.unsupported) {
// TODO probably others.
return 'thumbnailNoImage';
}

30
extensions/default/src/getDisplaySetsFromUnsupportedSeries.js Normal file
View File

@ -0,0 +1,30 @@
import ImageSet from '@ohif/core/src/classes/ImageSet';
import { DisplaySetMessage, DisplaySetMessageList } from '@ohif/core';
/**
* Default handler for a instance list with an unsupported sopClassUID
*/
export default function getDisplaySetsFromUnsupportedSeries(instances) {
const imageSet = new ImageSet(instances);
const messages = new DisplaySetMessageList();
messages.addMessage(DisplaySetMessage.CODES.UNSUPPORTED_DISPLAYSET);
const instance = instances[0];
imageSet.setAttributes({
displaySetInstanceUID: imageSet.uid, // create a local alias for the imageSet UID
SeriesDate: instance.SeriesDate,
SeriesTime: instance.SeriesTime,
SeriesInstanceUID: instance.SeriesInstanceUID,
StudyInstanceUID: instance.StudyInstanceUID,
SeriesNumber: instance.SeriesNumber || 0,
FrameRate: instance.FrameTime,
SOPClassUID: instance.SOPClassUID,
SeriesDescription: instance.SeriesDescription || '',
Modality: instance.Modality,
numImageFrames: instances.length,
unsupported: true,
SOPClassHandlerId: 'unsupported',
isReconstructable: false,
messages,
});
return [imageSet];
}

6
extensions/default/src/getSopClassHandlerModule.js
View File

@ -4,6 +4,7 @@ import ImageSet from '@ohif/core/src/classes/ImageSet';
import isDisplaySetReconstructable from '@ohif/core/src/utils/isDisplaySetReconstructable';
import { id } from './id';
import getDisplaySetMessages from './getDisplaySetMessages';
import getDisplaySetsFromUnsupportedSeries from './getDisplaySetsFromUnsupportedSeries';
const sopClassHandlerName = 'stack';
@ -213,6 +214,11 @@ function getSopClassHandlerModule() {
sopClassUids,
getDisplaySetsFromSeries,
},
{
name: 'not-supported-display-sets-handler',
sopClassUids: [],
getDisplaySetsFromSeries: getDisplaySetsFromUnsupportedSeries,
},
];
}

41
extensions/measurement-tracking/src/panels/PanelStudyBrowserTracking/PanelStudyBrowserTracking.tsx
View File

@ -156,7 +156,7 @@ function PanelStudyBrowserTracking({
const imageId = imageIds[Math.floor(imageIds.length / 2)];
// TODO: Is it okay that imageIds are not returned here for SR displaysets?
if (imageId) {
if (imageId && !displaySet?.unsupported) {
// When the image arrives, render it and store the result in the thumbnailImgSrcMap
newImageSrcEntry[dSet.displaySetInstanceUID] = await getImageSrc(
imageId
@ -212,23 +212,24 @@ function PanelStudyBrowserTracking({
const displaySet = displaySetService.getDisplaySetByUID(
displaySetInstanceUID
);
if (!displaySet?.unsupported) {
if (options.madeInClient) {
setJumpToDisplaySet(displaySetInstanceUID);
}
if (options.madeInClient) {
setJumpToDisplaySet(displaySetInstanceUID);
}
const imageIds = dataSource.getImageIdsForDisplaySet(displaySet);
const imageId = imageIds[Math.floor(imageIds.length / 2)];
const imageIds = dataSource.getImageIdsForDisplaySet(displaySet);
const imageId = imageIds[Math.floor(imageIds.length / 2)];
// TODO: Is it okay that imageIds are not returned here for SR displaysets?
if (imageId) {
// When the image arrives, render it and store the result in the thumbnailImgSrcMap
newImageSrcEntry[displaySetInstanceUID] = await getImageSrc(
imageId
);
setThumbnailImageSrcMap(prevState => {
return { ...prevState, ...newImageSrcEntry };
});
// TODO: Is it okay that imageIds are not returned here for SR displaysets?
if (imageId) {
// When the image arrives, render it and store the result in the thumbnailImgSrcMap
newImageSrcEntry[displaySetInstanceUID] = await getImageSrc(
imageId
);
setThumbnailImageSrcMap(prevState => {
return { ...prevState, ...newImageSrcEntry };
});
}
}
});
}
@ -424,7 +425,7 @@ function _mapDisplaySets(
.filter(ds => !ds.excludeFromThumbnailBrowser)
.forEach(ds => {
const imageSrc = thumbnailImageSrcMap[ds.displaySetInstanceUID];
const componentType = _getComponentType(ds.Modality);
const componentType = _getComponentType(ds);
const numPanes = viewportGridService.getNumViewportPanes();
const viewportIdentificator =
numPanes === 1
@ -471,7 +472,7 @@ function _mapDisplaySets(
if (componentType === 'thumbnailNoImage') {
if (dataSource.reject && dataSource.reject.series) {
thumbnailProps.canReject = true;
thumbnailProps.canReject = !ds?.unsupported;
thumbnailProps.onReject = () => {
uiDialogService.create({
id: 'ds-reject-sr',
@ -564,8 +565,8 @@ const thumbnailNoImageModalities = [
'OT',
];
function _getComponentType(Modality) {
if (thumbnailNoImageModalities.includes(Modality)) {
function _getComponentType(ds) {
if (thumbnailNoImageModalities.includes(ds.Modality) || ds?.unsupported) {
return 'thumbnailNoImage';
}

4
platform/app/src/components/ViewportGrid.tsx
View File

@ -280,6 +280,10 @@ function ViewerViewportGrid(props) {
displaySetService.getDisplaySetByUID(displaySetInstanceUID) || {}
);
}
).filter(
(displaySet) => {
return !displaySet?.unsupported;
}
);
const ViewportComponent = _getViewportComponent(

1
platform/core/src/services/DisplaySetService/DisplaySetMessage.ts
View File

@ -16,6 +16,7 @@ class DisplaySetMessage {
INCONSISTENT_COMPONENTS: 10,
INCONSISTENT_ORIENTATIONS: 11,
INCONSISTENT_POSITION_INFORMATION: 12,
UNSUPPORTED_DISPLAYSET: 13,
};
constructor(id: number) {

75
platform/core/src/services/DisplaySetService/DisplaySetService.ts
View File

@ -9,6 +9,7 @@ export type DisplaySet = {
StudyInstanceUID: string;
SeriesInstanceUID?: string;
numImages?: number;
unsupported?: boolean;
};
const displaySetCache = new Map<string, DisplaySet>();
@ -48,6 +49,7 @@ export default class DisplaySetService extends PubSubService {
};
public activeDisplaySets = [];
public unsuportedSOPClassHandler;
extensionManager: ExtensionManager;
protected activeDisplaySetsMap = new Map<string, DisplaySet>();
@ -58,6 +60,8 @@ export default class DisplaySetService extends PubSubService {
constructor() {
super(EVENTS);
this.unsuportedSOPClassHandler =
'@ohif/extension-default.sopClassHandlerModule.not-supported-display-sets-handler';
}
public init(extensionManager, SOPClassHandlerIds): void {
@ -85,6 +89,14 @@ export default class DisplaySetService extends PubSubService {
});
}
/**
* Sets the handler for unsupported sop classes
* @param sopClassHandlerUID
*/
public setUnsuportedSOPClassHandler(sopClassHandler) {
this.unsuportedSOPClassHandler = sopClassHandler;
}
/**
* Adds new display sets directly, as specified.
* Use this function when the display sets are created externally directly
@ -256,6 +268,47 @@ export default class DisplaySetService extends PubSubService {
this.activeDisplaySetsMap.clear();
}
/**
* This function hides the old makeDisplaySetForInstances function to first
* separate the instances by sopClassUID so each call have only instances
* with the same sopClassUID, to avoid a series composed by different
* sopClassUIDs be filtered inside one of the SOPClassHandler functions and
* didn't appear in the series list.
* @param instancesSrc
* @param settings
* @returns
*/
public makeDisplaySetForInstances(
instancesSrc: InstanceMetadata[],
settings
): DisplaySet[] {
// creating a sopClassUID list and for each sopClass associate its respective
// instance list
const instancesForSetSOPClasses = instancesSrc.reduce(
(sopClassList, instance) => {
if (!(instance.SOPClassUID in sopClassList)) {
sopClassList[instance.SOPClassUID] = [];
}
sopClassList[instance.SOPClassUID].push(instance);
return sopClassList;
},
{}
);
// for each sopClassUID, call the old makeDisplaySetForInstances with a
// instance list composed only by instances with the same sopClassUID and
// accumulate the displaySets in the variable allDisplaySets
const sopClasses = Object.keys(instancesForSetSOPClasses);
let allDisplaySets = [];
sopClasses.forEach(sopClass => {
const displaySets = this._makeDisplaySetForInstances(
instancesForSetSOPClasses[sopClass],
settings
);
allDisplaySets = [...allDisplaySets, ...displaySets];
});
return allDisplaySets;
}
/**
* Creates new display sets for the instances contained in instancesSrc
* according to the sop class handlers registered.
@ -272,7 +325,7 @@ export default class DisplaySetService extends PubSubService {
* @param settings are settings to add
* @returns Array of the display sets added.
*/
public makeDisplaySetForInstances(
private _makeDisplaySetForInstances(
instancesSrc: InstanceMetadata[],
settings
): DisplaySet[] {
@ -355,6 +408,26 @@ export default class DisplaySetService extends PubSubService {
allDisplaySets.push(...displaySets);
}
}
// applying the default sopClassUID handler
if (allDisplaySets.length === 0) {
// applying hp-defined viewport settings to the displaysets
const handler = this.extensionManager.getModuleEntry(
this.unsuportedSOPClassHandler
);
const displaySets = handler.getDisplaySetsFromSeries(instances);
if (displaySets?.length) {
displaySets.forEach(ds => {
Object.keys(settings).forEach(key => {
ds[key] = settings[key];
});
});
this._addDisplaySetsToCache(displaySets);
this._addActiveDisplaySets(displaySets);
allDisplaySets.push(...displaySets);
}
}
return allDisplaySets;
}

1
platform/core/src/services/DisplaySetService/IDisplaySet.ts
View File

@ -3,6 +3,7 @@ interface IDisplaySet {
StudyInstanceUID: string;
SeriesInstanceUID?: string;
SeriesNumber?: string;
unsupported?: boolean;
}
export default IDisplaySet;

9
platform/core/src/services/HangingProtocolService/HangingProtocolService.ts
View File

@ -559,6 +559,13 @@ export default class HangingProtocolService extends PubSubService {
}
getViewportsRequireUpdate(viewportIndex, displaySetInstanceUID) {
const { displaySetService } = this._servicesManager.services;
const displaySet = displaySetService.getDisplaySetByUID(
displaySetInstanceUID
);
if (displaySet?.unsupported) {
throw new Error('Unsupported displaySet');
}
const newDisplaySetInstanceUID = displaySetInstanceUID;
const protocol = this.protocol;
const protocolStage = protocol.stages[this.stageIndex];
@ -1431,7 +1438,7 @@ export default class HangingProtocolService extends PubSubService {
}
const studyDisplaySets = this.displaySets.filter(
it => it.StudyInstanceUID === study.StudyInstanceUID
it => it.StudyInstanceUID === study.StudyInstanceUID && !it?.unsupported
);
const studyMatchDetails = this.protocolEngine.findMatch(

3
platform/i18n/src/locales/en-US/Messages.json
View File

@ -10,5 +10,6 @@
"9": "DisplaySet has inconsistent dimensions between frames.",
"10": "DisplaySet has frames with inconsistent number of components.",
"11": "DisplaySet has frames with inconsistent orientations.",
"12": "DisplaySet has inconsistent position information."
"12": "DisplaySet has inconsistent position information.",
"13": "Unsupported displaySet."
}

3
platform/i18n/src/locales/pt-BR/Messages.json
View File

@ -10,5 +10,6 @@
"9": "Série possui dimensões inconsistentes entre frames.",
"10": "Série possui frames com componentes inconsistentes.",
"11": "Série possui frames com orientações inconsistentes.",
"12": "Série possui informação de posição inconsistentes."
"12": "Série possui informação de posição inconsistentes.",
"13": "Série não suportada."
}

5
platform/ui/src/components/DisplaySetMessageListTooltip/DisplaySetMessageListTooltip.tsx
View File

@ -12,7 +12,7 @@ import { useTranslation } from 'react-i18next';
const DisplaySetMessageListTooltip = ({ messages, id }): React.ReactNode => {
const { t } = useTranslation('Messages');
const [isOpen, setIsOpen] = useState(false);
if (messages.size()) {
if (messages?.size()) {
return (
<>
<Icon
@ -29,7 +29,7 @@ const DisplaySetMessageListTooltip = ({ messages, id }): React.ReactNode => {
arrow="center"
parent={`#${id}`}
>
<div className="bg-primary-dark border border-secondary-light text-white text-base rounded text-left max-w-40">
<div className="bg-primary-dark border border-secondary-light text-white text-base rounded text-left max-w-64">
<div
className="break-normal text-base text-blue-300 font-bold"
style={{
@ -42,6 +42,7 @@ const DisplaySetMessageListTooltip = ({ messages, id }): React.ReactNode => {
<ol
style={{
marginLeft: '12px',
marginRight: '12px',
}}
>
{messages.messages.map((message, index) => (

2
platform/ui/src/components/Thumbnail/Thumbnail.tsx
View File

@ -82,7 +82,7 @@ const Thumbnail = ({
</div>
<DisplaySetMessageListTooltip
messages={messages}
id={`display-set-tooltip-${seriesNumber}`}
id={`display-set-tooltip-${displaySetInstanceUID}`}
/>
</div>
<div className="text-base text-white break-all">{description}</div>

2
platform/ui/src/components/ThumbnailList/ThumbnailList.tsx
View File

@ -159,7 +159,7 @@ function _getModalityTooltip(modality) {
const _modalityTooltips = {
SR: 'Structured Report',
SEG: 'Segmentation',
RT: 'RT Structure Set',
RTSTRUCT: 'RT Structure Set',
};
export default ThumbnailList;

24
platform/ui/src/components/ThumbnailNoImage/ThumbnailNoImage.tsx
View File

@ -5,6 +5,7 @@ import { useDrag } from 'react-dnd';
import Icon from '../Icon';
import Tooltip from '../Tooltip';
import Typography from '../Typography';
import DisplaySetMessageListTooltip from '../DisplaySetMessageListTooltip';
const ThumbnailNoImage = ({
displaySetInstanceUID,
@ -57,23 +58,10 @@ const ThumbnailNoImage = ({
</div>
</Tooltip>
<span className="ml-4 text-base text-blue-300">{seriesDate}</span>
{messages?.size() ? (
<div>
<Tooltip
position="left"
tight={true}
content={
<div className="text-left max-w-40">
{messages.thumbnailContents()}
</div>
}
>
<Icon name="notifications-warning" className="w-3 h-3" />
</Tooltip>
</div>
) : (
<></>
)}
<DisplaySetMessageListTooltip
messages={messages}
id={`display-set-tooltip-${displaySetInstanceUID}`}
/>
</div>
<div className="flex flex-row">
{canReject && (
@ -107,7 +95,7 @@ ThumbnailNoImage.propTypes = {
/** Must match the "type" a dropTarget expects */
type: PropTypes.string.isRequired,
}),
description: PropTypes.string.isRequired,
description: PropTypes.string,
modality: PropTypes.string.isRequired,
/* Tooltip message to display when modality text is hovered */
modalityTooltip: PropTypes.string.isRequired,

2
platform/ui/src/components/ViewportActionBar/ViewportActionBar.tsx
View File

@ -198,7 +198,7 @@ ViewportActionBar.propTypes = {
patientAge: PropTypes.string.isRequired,
MRN: PropTypes.string.isRequired,
thickness: PropTypes.string.isRequired,
thicknessUnits: PropTypes.string.isRequired,
thicknessUnits: PropTypes.string,
spacing: PropTypes.string.isRequired,
scanner: PropTypes.string.isRequired,
}),