Proposal for compositional layer support

[Ouwen]

Since cornerstonejs has layer API support (cornerstonejs/cornerstone#68), the react-cornerstone-viewport could provide props support. This would allow for easy overlays of segmentation maps, heat maps, and other fusion based image information.

The current behaviour for react-cornsertone-viewport is to take in a list of imageIds as a stack and display some initial index.

react-cornerstone-viewport/src/CornerstoneViewport/CornerstoneViewport.js

Lines 172 to 188 in 52703b9

	cornerstoneTools.clearToolState(this.element, 'stack');
	cornerstoneTools.addStackStateManager(this.element, [
	'stack',
	'playClip',
	'referenceLines',
	]);
	cornerstoneTools.addToolState(this.element, 'stack', {
	imageIds: [...imageIds],
	currentImageIdIndex: imageIdIndex,
	});
	// Load first image in stack
	const image = await cornerstone.loadAndCacheImage(imageId);
	// Display
	cornerstone.displayImage(this.element, image);

However, it would be useful to take in layers as a prop where layers can contain many imageIds, but ultimately they are fused together as with the composite image example: https://rawgit.com/cornerstonejs/cornerstone/master/example/layers/index.html.

// layers prop
const layers = [{
            imageId: 'ct://1',
            options: {
                name: 'CT'
            }
        }, {
            imageId: 'pet://1',
            options: {
                name: 'PET',
                opacity: 0.7,
                viewport: {
                    colormap: 'hotIron',
                    voi: {
                        windowWidth: 30,
                        windowCenter: 16
                    }
                }
            }
        }
    ];

Alternatively, the imageIds could by default be added to a single element layer with that layer being set active.

A potential barrier is that the cornerstoneTools stack stateManagement relies on imageIds. Not sure if this would be a big deal though since the cornerstone layer API uses underlying imageIds, and tools can be applied to just the the active layer. I was wondering what would happen if we just provided the list of imageIds from the active layer.

Happy to put together a PR, but wanted to feel out opinions on better API design or caveats.

[shanebenlolo]

Did you ever write a PR for this? I'm trying to implement the same thing.

[Ouwen]

No I have not