Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Handle large volumes #3235

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Handle large volumes #3235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions extensions/cornerstone/src/init.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,12 +71,14 @@ export default async function init({
uiNotificationService,
cineService,
cornerstoneViewportService,
cornerstoneCacheService,
hangingProtocolService,
toolGroupService,
viewportGridService,
} = servicesManager.services;

window.services = servicesManager.services;
cornerstoneCacheService.setMaxFramesInVolume(appConfig?.maxFramesInVolume);

if (
appConfig.showWarningMessageForCrossOrigin &&
Expand Down
33 changes: 31 additions & 2 deletions extensions/cornerstone/src/services/CornerstoneCacheService/CornerstoneCacheService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,26 @@ class CornerstoneCacheService {

stackImageIds: Map<string, string[]> = new Map();
volumeImageIds: Map<string, string[]> = new Map();
maxFramesInVolume = Infinity;
servicesManager: ServicesManager;

constructor(servicesManager) {
constructor(servicesManager: ServicesManager) {
this.servicesManager = servicesManager;
}

public setMaxFramesInVolume(numFrames: number): void {
this.maxFramesInVolume = numFrames || Infinity;
const { displaySetService } = this.servicesManager.services;
const displaySets = displaySetService.getActiveDisplaySets();
displaySets.forEach(displaySet =>
displaySetService.setDisplaySetMetadataInvalidated(displaySet.getUID())
);
}

public getMaxFramesInVolume(): number {
return this.maxFramesInVolume;
}

public getCacheSize() {
return cs3DCache.getCacheSize();
}
Expand Down Expand Up @@ -186,9 +201,22 @@ class CornerstoneCacheService {
displaySet,
dataSource
);
const distributedCopy = (items, n) => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is going to cause rendering issues when items.length ~= n because it is just going to throw out a certain set of instances, which causes the interval between images to be off by a factor of 2. When n << items.length, it works ok,
because the interval becomes nearly consistent again, or if n = items.length / integer value, then one can sub-select evenly. It is possible to write a inconsistent sample viewer, but currently we assume in the configuration that the sample volume is consistent, and don't account for this type of differences.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could write a decimator instead - that takes out every other image, or as a general implementation, leaves 1 image, takes k images out, then repeats. Decimators leave consistent spacing.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a decimator to CS3D in the HTJ2K progressive branch if you want one.

const elements = [items[0]];
const totalItems = items.length - 2;
const interval = totalItems / (n - 2);
for (let i = 1; i < n - 1; i++) {
elements.push(items[Math.floor(i * interval)]);
}
elements.push(items[items.length - 1]);
return elements;
};

volume = await volumeLoader.createAndCacheVolume(volumeId, {
imageIds: volumeImageIds,
imageIds:
volumeImageIds.length > this.maxFramesInVolume
? distributedCopy(volumeImageIds, this.maxFramesInVolume)
: volumeImageIds,
});

this.volumeImageIds.set(
Expand Down Expand Up @@ -238,6 +266,7 @@ class CornerstoneCacheService {
}

private _getCornerstoneStackImageIds(displaySet, dataSource): string[] {
displaySet.sortByImagePositionPatient();
return dataSource.getImageIdsForDisplaySet(displaySet);
}

Expand Down
38 changes: 29 additions & 9 deletions platform/core/src/classes/ImageSet.js → platform/core/src/classes/ImageSet.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,15 @@ const OBJECT = 'object';
* indiscriminately, but this should be changed).
*/
class ImageSet {
private rawImages;

constructor(images) {
if (Array.isArray(images) !== true) {
throw new Error('ImageSet expects an array of images');
}

// @property "images"
Object.defineProperty(this, 'images', {
// @property "rawImages"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just set instances to the complete list - instances is used elsewhere to mean all the instance values, whereas images is used for the images for display.

Object.defineProperty(this, 'rawImages', {
enumerable: false,
configurable: false,
writable: false,
Expand All @@ -32,6 +34,24 @@ class ImageSet {
});
}

get images(): any {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The general design of the display sets is that they are fixed representations of specific groups of DICOM objects - this mapping allows redefining that, and can cause problems when rendering different image sets. I'd rather have a mapping function produce a new ImageSet entirely rather than having the images be variable.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It isn't used anywhere here, and I don't see any testing behaviour for it - I think this is a bad idea without careful consideration of what it means for other classes which expect to the representation of display sets to be consistent.

/**
* Extensions can create arbitrary imagesMapper functions to filter/map
* these metadata. For example to only return the first 300 slices
* of a large volume, the below can be run in a command.
*
* const ds = services.DisplaySetService.getDisplaySetByUID(displaySetUID)
* ds.sortByImagePositionPatient()
* ds.setAttribute('imagesMapper', (ds)=> ds.slice(0, 300))
* displaySetService.setDisplaySetMetadataInvalidated(displaySetUID)
*/
const imagesMapper = this.getAttribute('imagesMapper');
if (imagesMapper && imagesMapper instanceof Function) {
return imagesMapper(this.rawImages);
}
return this.rawImages;
}

getUID() {
return this.uid;
}
Expand All @@ -48,26 +68,26 @@ class ImageSet {
if (typeof attributes === OBJECT && attributes !== null) {
const imageSet = this,
hasOwn = Object.prototype.hasOwnProperty;
for (let attribute in attributes) {
for (const attribute in attributes) {
if (hasOwn.call(attributes, attribute)) {
imageSet[attribute] = attributes[attribute];
}
}
}
}

getNumImages = () => this.images.length
getNumImages = () => this.rawImages.length;

getImage(index) {
return this.images[index];
return this.rawImages[index];
}

sortBy(sortingCallback) {
return this.images.sort(sortingCallback);
return this.rawImages.sort(sortingCallback);
}

sortByImagePositionPatient() {
const images = this.images;
const images = this.rawImages;
const referenceImagePositionPatient = _getImagePositionPatient(images[0]);

const refIppVec = new Vector3(
Expand Down Expand Up @@ -114,11 +134,11 @@ class ImageSet {
}

function _getImagePositionPatient(image) {
return image.getData().metadata.ImagePositionPatient;
return image.ImagePositionPatient;
}

function _getImageOrientationPatient(image) {
return image.getData().metadata.ImageOrientationPatient;
return image.ImageOrientationPatient;
}

export default ImageSet;
3 changes: 3 additions & 0 deletions platform/viewer/public/config/default.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ window.config = {
showStudyList: true,
// some windows systems have issues with more than 3 web workers
maxNumberOfWebWorkers: 3,
maxFramesInVolume: 400,
maxCacheSize: 1073741824,

// below flag is for performance reasons, but it might not work for all servers
omitQuotationForMultipartRequest: true,
showWarningMessageForCrossOrigin: true,
Expand Down