Added a basic implementation of hanging protocols with one hardcoded mammogram protocol.

Packages/viewerbase/components/viewer/imageViewerViewports/imageViewerViewports.js

@@ -43,13 +43,13 @@ Template.imageViewerViewports.helpers({
             viewportData = ViewerData[contentId].loadedSeriesData;
         }
 
-        var hangingProtocol = getHangingProtocol();
         var inputData = {
             viewportColumns: viewportColumns,
             viewportRows: viewportRows,
             studies: ViewerStudies
         };
-        var hangingProtocolViewportData = hangingProtocol(inputData);
+
+        var hangingProtocolViewportData = WindowManager.getHangingProtocol(inputData);
         
         var array = [];
         var numViewports = viewportRows * viewportColumns;
@@ -75,7 +75,7 @@ Template.imageViewerViewports.helpers({
             array.push(data);
         }
         return array;
-    },
+    }
 });
 
 var savedSeriesData,
@@ -134,7 +134,7 @@ Template.imageViewerViewports.events({
             // Set the basic template data
             data = {
                 viewportRows: 1,
-                viewportColumns: 1,
+                viewportColumns: 1
             };
 
             // Render the imageViewerViewports template with these settings
@@ -145,6 +145,5 @@ Template.imageViewerViewports.events({
             $('.imageViewerViewport').eq(0).addClass('zoomed');
 
         }
-        log.info('dblclick');
     }
 });

Packages/viewerbase/lib/windowManager.js

@@ -0,0 +1,296 @@
+/**
+ * This is a temporary function which will return a hardcoded hanging protocol as a JavaScript object
+ * The purpose of this is to act as a stub until we are actually parsing DICOM Hanging Protocol files,
+ * since Orthanc doesn't seem to support them yet.
+ *
+ * Soon we will be using instanceDataToJsObject to produce this object from the HangingProtocol WADO
+ * instance
+ *
+ */
+function getMammoHangingProtocol() {
+    var tagValues = {
+        HangingProtocolStorage: '1.2.840.10008.5.1.4.38.1'
+    };
+
+    var protocol = {
+        sopClassUid: tagValues.HangingProtocolStorage,
+        sopInstanceUid: '1.2.840.113986.2.664566.21121125.85669.911', // A random Uid
+        hangingProtocolName: 'MammoCadProtocol',
+        hangingProtocolDescription: 'Mammography screening protocol',
+        hangingProtocolLevel: 'SITE',
+        hangingProtocolCreator: 'Erik',
+        hangingProtocolCreationDateTime: '20020101104200',
+        hangingProtocolDefinitionSequence: [{
+                modality: 'MG',
+                laterality: '',
+                procedureCodeSequence: {
+                    codeValue: 98765,
+                    codingSchemeDesignator: '99Local',
+                    codingSchemeVersion: 1.5,
+                    codeMeaning: 'Mammogram'
+                },
+                anatomicRegionSequence: {
+                     codeValue: 'T-D1100',
+                     codingSchemeDesignator: 'SNM3',
+                     codeMeaning: 'BREAST'
+                },
+                reasonForRequestedProcedureCodeSequence: {
+                    codeValue: 'I67.1',
+                    codingSchemeDesignator: 'I10',
+                    codeMeaning: 'Calcification'
+                }
+        }],
+        hangingProtocolUserIdentificationCodeSequence: [],
+        hangingProtocolUserGroupName: 'ABC Hospital',
+        numberOfPriorsReferenced: 1,
+        imageSetsSequence: [{
+            imageSetSelectorSequence: [{
+                ImageSetSelectorUsageFlag: 'NO_MATCH',
+                SelectorAttribute: '00180015',
+                SelectorValueNumber: '1',
+                SelectorAttributeVR: 'CS',
+                SelectorCSValue: 'BREAST'
+            }],
+            timeBasedImageSetsSequence: [{
+                ImageSetNumber: 1,
+                ImageSetSelectorCategory: 'RELATIVE_TIME',
+                RelativeTime: '0\0',
+                RelativeTimeUnits: 'MINUTES',
+                ImageSetLabel: 'Current MG Breast'
+            },
+            {
+                ImageSetNumber: 2,
+                ImageSetSelectorCategory: 'ABSTRACT_PRIOR',
+                AbstractPriorValue: '1\1',
+                ImageSetLabel: 'Prior MG Breast'
+            }]
+        }],
+        // Skip Number of Screens for now,
+        // Skip Nominal Screen Definition Sequence for now,
+
+        // http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.23.3.html
+        DisplaySetsSequence: [{
+            // Left side image (R MLO Current)
+            ImageSetNumber: 1,
+            DisplaySetNumber: 1,
+            DisplaySetPresentationGroup: 1,
+            DisplaySetPresentationGroupDescription: 'Current Mediolateral only',
+            ImageBoxesSequence: [{
+                DisplayEnvironmentSpatialPosition: '0\0.2\0.16667\0',
+                ImageBoxNumber: 1,
+                ImageBoxLayoutType: 'STACK'
+            }],
+            FilterOperationsSequence: [{
+                SelectorAttributeVR: 'CS',
+                SelectorCSValue: 'R MLO',
+                FilterByCategory: 'SERIES_DESCRIPTION',
+                FilterByOperator: 'MEMBER_OF'
+            }],
+            ReformattingOperationType: '',
+            ReformattingThickness: '',
+            ReformattingInterval: '',
+            ReformattingOperationInitialViewDirection: '',
+            SortingOperationsSequence: [],
+            DisplaySetPatientOrientation: '',
+            VOIType: ''
+        }, {
+            // Right side image (L MLO Current)
+            ImageSetNumber: 1,
+            DisplaySetNumber: 1,
+            DisplaySetPresentationGroup: 1,
+            ImageBoxesSequence: [{
+                ImageBoxNumber: 1,
+                ImageBoxLayoutType: 'STACK'
+            }],
+            FilterOperationsSequence: [{
+                SelectorAttributeVR: 'CS',
+                SelectorCSValue: 'L MLO',
+                FilterByCategory: 'SERIES_DESCRIPTION',
+                FilterByOperator: 'MEMBER_OF'
+            }]
+        }],
+        PartialDataDisplayHandling: 'MAINTAIN_LAYOUT',
+        SynchronizedScrollingSequence: [],
+        NavigationIndicatorSequence: []
+    };
+
+    return protocol;
+}
+
+function findSetsByPresentationGroup(DisplaySetsSequence, DisplaySetPresentationGroup) {
+    var presentationGroupSets = [];
+    DisplaySetsSequence.forEach(function(displaySet) {
+        if (displaySet.DisplaySetPresentationGroup === DisplaySetPresentationGroup) {
+            presentationGroupSets.push(displaySet);
+        }
+    });
+    return presentationGroupSets;
+}
+
+function findStudy(displaySet, studies) {
+    // Placeholder for now
+    return studies.find().fetch()[0].studyInstanceUid;
+}
+
+/**
+ * Uses the FilterOperationsSequence information to find
+ * the relevant series for display in this display set
+ *
+ * @param displaySet
+ * @param study
+ * @returns {String} The instance Uid of the series to be displayed
+ */
+function findSeries(displaySet, study) {
+    var categoryDictionary = {
+        SERIES_DESCRIPTION: 'seriesDescription'
+    };
+
+    // TODO=Put these inside a loop? We need to support multiple filter operations,
+    // not just one
+    var filterBy = displaySet.FilterOperationsSequence[0].FilterByCategory;
+    var selectorValue = displaySet.FilterOperationsSequence[0].SelectorCSValue;
+    var filterType = displaySet.FilterOperationsSequence[0].FilterByOperator;
+    var category = categoryDictionary[filterBy];
+
+    var seriesInstanceUid;
+    study.seriesList.forEach(function(series) {
+        // TODO = Add other FilterBy operators
+        if (filterType === 'MEMBER_OF') {
+            if (series[category] === selectorValue) {
+                seriesInstanceUid = series.seriesInstanceUid;
+                return false;
+            }
+        }
+    });
+
+    return seriesInstanceUid;
+}
+
+/**
+ * (Work in progress) Uses the information from a DICOM Hanging Protocol
+ * to identify and display studies and series in the image viewer
+ *
+ * @param hangingProtocol
+ * @param inputData
+ * @returns {Array} Array of viewport data to be displayed
+ */
+function applyDICOMHangingProtocol(hangingProtocol, inputData) {
+    log.info('applyDICOMHangingProtocol');
+    var presentationGroup = inputData.DisplaySetPresentationGroup || 1;
+    var studies = inputData.studies;
+    var currentDisplaySets = findSetsByPresentationGroup(hangingProtocol.DisplaySetsSequence, presentationGroup);
+
+    var viewportData = [];
+    currentDisplaySets.forEach(function(displaySet, index) {
+        // TODO= Find study information by image set properties and
+        // image set number of this display set
+        var ImageSetNumber = displaySet.ImageSetNumber;
+
+        studyInstanceUid = findStudy(displaySet, studies);
+
+        var study = studies.findOne({studyInstanceUid: studyInstanceUid});
+        seriesInstanceUid = findSeries(displaySet, study);
+
+        viewportData[index] = {
+            seriesInstanceUid: seriesInstanceUid,
+            studyInstanceUid: studyInstanceUid,
+            currentImageIdIndex: 0
+        };
+    });
+
+    return viewportData;
+}
+
+/**
+ * This is an example of a hanging protocol
+ * It takes in a set of studies, as well as the
+ * number of rows and columns in the layout.
+ *
+ * It returns an array of objects, one for each viewport, detailing
+ * which series should be loaded in the viewport.
+ *
+ * @param inputData
+ * @returns {Array}
+ */
+function defaultHangingProtocol(inputData) {
+    var studies = inputData.studies.find().fetch();
+    var viewportRows = inputData.viewportRows;
+    var viewportColumns = inputData.viewportColumns;
+
+    // This is the most basic hanging protocol.
+    var stacks = [];
+    studies.forEach(function(study) {
+        study.seriesList.forEach(function(series) {
+            
+            // Ensure that the series has image data
+            // (All images have rows)
+            var anInstance = series.instances[0];
+            if (!anInstance || !anInstance.rows) {
+                return;
+            }
+
+            var stack = {
+                series: series,
+                study: study
+            };
+            stacks.push(stack);
+        });
+    });
+
+    var viewportData = [];
+
+    var numViewports = viewportRows * viewportColumns;
+    for (var i=0; i < numViewports; ++i) {
+        if (i >= stacks.length) {
+            // We don't have enough stacks to fill the desired number of viewports, so stop here
+            break;
+        }
+        viewportData[i] = {
+            seriesInstanceUid: stacks[i].series.seriesInstanceUid,
+            studyInstanceUid: stacks[i].study.studyInstanceUid,
+            currentImageIdIndex: 0
+        };
+    }
+    return viewportData;
+}
+
+var currentStage = 0;
+var hangingProtocol;
+
+function getHangingProtocol(inputData) {
+    // TODO = Update this to use Collection logic
+    var studies = inputData.studies.find().fetch();
+
+    if (!studies.length) {
+        log.warn("No studies provided to Hanging Protocol");
+        return;
+    }
+
+    // Find the unique modalities in this study
+    var modalities = [];
+    studies.forEach(function(study) {
+        study.seriesList.forEach(function(series) {
+            if (modalities.indexOf(series.modality) < 0) {
+                modalities.push(series.modality);
+            }
+        });
+    });
+
+    if (modalities.indexOf('MG') > -1) {
+        var hangingProtocol = getMammoHangingProtocol();
+        return applyDICOMHangingProtocol(hangingProtocol, inputData);
+    }
+
+    return defaultHangingProtocol(inputData);
+}
+
+function setHangingProtocol(protocol) {
+    hangingProtocol = protocol;
+}
+
+WindowManager = {
+    setHangingProtocol: setHangingProtocol,
+    getHangingProtocol: getHangingProtocol
+};
+
+WindowManager.setHangingProtocol(defaultHangingProtocol);

Packages/viewerbase/package.js

@@ -18,6 +18,7 @@ Package.onUse(function (api) {
 
     // Our custom package
     api.use('cornerstone');
+    api.use('hangingprotocols');
 
     api.addFiles('log.js', ['client', 'server']);
 
@@ -102,6 +103,7 @@ Package.onUse(function (api) {
     api.addFiles('lib/rerenderViewportWithNewSeries.js', 'client');
     api.addFiles('lib/sortStudy.js', 'client');
     api.addFiles('lib/toolManager.js', 'client');
+    api.addFiles('lib/windowManager.js', 'client');
 
     //api.export('accountsConfig', 'client');
     api.export('createStacks', 'client');
@@ -112,9 +114,13 @@ Package.onUse(function (api) {
     api.export('metaDataProvider', 'client');
     api.export('rerenderViewportWithNewSeries', 'client');
     api.export('sortStudy', 'client');
-    api.export('toolManager', 'client');
     api.export('updateOrientationMarkers', 'client');
 
+    // Viewer management objects
+    api.export('toolManager', 'client');
+    api.export('WindowManager', 'client');
+
+
     // UI Helpers
     api.addFiles('lib/helpers/formatDA.js', 'client');
     api.addFiles('lib/helpers/formatNumberPrecision.js', 'client');