Commented a lot of functions. Tried to get jsDoc and/or docco to work

Packages/viewerbase/server/methods/getStudyMetadata.js

@@ -1,10 +1,15 @@
 Meteor.methods({
-  'GetStudyMetadata' : function(studyInstanceUid) {
-    log.info('GetStudyMetadata(%s)', studyInstanceUid);
+    /**
+     * Retrieves Study metadata given a Study Instance UID
+     * This Meteor method is available from both the client and the server
+     */
+    'GetStudyMetadata' : function(studyInstanceUid) {
+        log.info('GetStudyMetadata(%s)', studyInstanceUid);
 
-    var server = Meteor.settings.dicomWeb.endpoints[0];
+        // Get the server data. This is user-defined in the
+        // config.json files used to run the Meteor server
+        var server = Meteor.settings.dicomWeb.endpoints[0];
 
-    //return Services.QIDO.Instances(server, studyInstanceUid);
-    return Services.WADO.RetrieveMetadata(server, studyInstanceUid);
-  }
+        return Services.WADO.RetrieveMetadata(server, studyInstanceUid);
+    }
 });

Packages/viewerbase/server/methods/worklistSearch.js

@@ -1,6 +1,13 @@
 Meteor.methods({
-  'WorklistSearch' : function(filter) {
-    var server = Meteor.settings.dicomWeb.endpoints[0];
-    return Services.QIDO.Studies(server, filter);
-  }
+    /**
+     * Use the specified filter to conduct a search from the DICOM server
+     * @param filter
+     */
+    'WorklistSearch': function(filter) {
+        // Get the server data. This is user-defined in the
+        // config.json files used to run the Meteor server
+        var server = Meteor.settings.dicomWeb.endpoints[0];
+
+        return Services.QIDO.Studies(server, filter);
+    }
 });

Packages/viewerbase/server/services/qido/instances.js

@@ -1,59 +1,83 @@
+/**
+ * Creates a QIDO URL given the server settings and a study instance UID
+ * @param server
+ * @param studyInstanceUid
+ * @returns {string} URL to be used for QIDO calls
+ */
 function buildUrl(server, studyInstanceUid) {
-
-  var url = server.qidoRoot + '/studies/' + studyInstanceUid + '/instances';
-
-  return url;
+    return server.qidoRoot + '/studies/' + studyInstanceUid + '/instances';
 }
 
+/**
+ * Parses data returned from a QIDO search and transforms it into
+ * an array of series that are present in the study
+ *
+ * @param server The DICOM server
+ * @param studyInstanceUid
+ * @param resultData
+ * @returns {Array} Series List
+ */
 function resultDataToStudyMetadata(server, studyInstanceUid, resultData) {
-  var seriesMap = {};
-  var seriesList = [];
-  resultData.forEach(function(instance) {
-    var seriesInstanceUid = DICOMWeb.getString(instance['0020000E']);
-    var series = seriesMap[seriesInstanceUid];
-    if(!series) {
-      series = {
-        seriesInstanceUid : seriesInstanceUid,
-        seriesNumber : DICOMWeb.getString(instance['00200011']),
-        instances: []
-      };
-      seriesMap[seriesInstanceUid] = series;
-      seriesList.push(series);
-    }
+    var seriesMap = {};
+    var seriesList = [];
 
-    // The uri for the dicomweb
-    // NOTE: DCM4CHEE seems to return the data zipped
-    // NOTE: Orthanc returns the data with multi-part mime which cornerstoneWADOImageLoader doesn't
-    //       know how to parse yet
-    //var uri = DICOMWeb.getString(instance['00081190']);
-    //uri = uri.replace('wado-rs', 'dicom-web');
+    resultData.forEach(function(instance) {
+        // Use seriesMap to cache series data
+        // If the series instance UID has already been used to
+        // process series data, continue using that series
+        var seriesInstanceUid = DICOMWeb.getString(instance['0020000E']);
+        var series = seriesMap[seriesInstanceUid];
 
-    // manually create a WADO-URI from the UID's
-    // NOTE: Haven't been able to get Orthanc's WADO-URI to work yet - maybe its not configured?
-    var sopInstanceUid = DICOMWeb.getString(instance['00080018']);
-    var uri = server.wadoUriRoot + '?requestType=WADO&studyUID=' + studyInstanceUid + '&seriesUID=' + seriesInstanceUid + '&objectUID=' + sopInstanceUid + "&contentType=application%2Fdicom";
+        // If no series data exists in the seriesMap cache variable,
+        // process any available series data
+        if(!series) {
+            series = {
+                seriesInstanceUid : seriesInstanceUid,
+                seriesNumber : DICOMWeb.getString(instance['00200011']),
+                instances: []
+            };
 
-    series.instances.push({
-      sopClassUid: DICOMWeb.getString(instance['00080016']),
-      sopInstanceUid: sopInstanceUid,
-      uri: uri,
-      instanceNumber: DICOMWeb.getString(instance['00200013'])
-    });
+            // Save this data in the seriesMap cache variable
+            seriesMap[seriesInstanceUid] = series;
+            seriesList.push(series);
+        }
+
+        // The uri for the dicomweb
+        // NOTE: DCM4CHEE seems to return the data zipped
+        // NOTE: Orthanc returns the data with multi-part mime which cornerstoneWADOImageLoader doesn't
+        //       know how to parse yet
+        //var uri = DICOMWeb.getString(instance['00081190']);
+        //uri = uri.replace('wado-rs', 'dicom-web');
+
+        // manually create a WADO-URI from the UIDs
+        // NOTE: Haven't been able to get Orthanc's WADO-URI to work yet - maybe its not configured?
+        var sopInstanceUid = DICOMWeb.getString(instance['00080018']);
+        var uri = server.wadoUriRoot + '?requestType=WADO&studyUID=' + studyInstanceUid + '&seriesUID=' + seriesInstanceUid + '&objectUID=' + sopInstanceUid + "&contentType=application%2Fdicom";
+
+        // Add this instance to the current series
+        series.instances.push({
+            sopClassUid: DICOMWeb.getString(instance['00080016']),
+            sopInstanceUid: sopInstanceUid,
+            uri: uri,
+            instanceNumber: DICOMWeb.getString(instance['00200013'])
+        });
   });
   return seriesList;
 }
 
+/**
+ * Retrieve a set of instances using a QIDO call
+ * @param server
+ * @param studyInstanceUid
+ * @returns {{wadoUriRoot: String, studyInstanceUid: String, seriesList: Array}}
+ */
 Services.QIDO.Instances = function(server, studyInstanceUid) {
+    var url = buildUrl(server, studyInstanceUid);
+    var result = DICOMWeb.getJSON(url, server.requestOptions);
 
-  var url = buildUrl(server, studyInstanceUid);
-
-  var result = DICOMWeb.getJSON(url, server.requestOptions);
-  
-  var study = {
-    wadoUriRoot: server.wadoUriRoot,
-    studyInstanceUid: studyInstanceUid,
-    seriesList: resultDataToStudyMetadata(server, studyInstanceUid, result.data)
-  };
-
-  return study;
+    return {
+        wadoUriRoot: server.wadoUriRoot,
+        studyInstanceUid: studyInstanceUid,
+        seriesList: resultDataToStudyMetadata(server, studyInstanceUid, result.data)
+    };
 };

Packages/viewerbase/server/services/qido/studies.js

@@ -1,45 +1,56 @@
+/**
+ * Produces a QIDO URL given server details and a set of specified search filter
+ * items
+ *
+ * @param server
+ * @param filter
+ * @returns {string} The URL with encoded filter query data
+ */
 function filterToQIDOURL(server, filter) {
-  var parameters = {
-    PatientName : filter.patientName,
-    PatientID: filter.patientId,
-    AccessionNumber : filter.accessionNumber,
-    limit : filter.limit || 20,
-    includefield : server.qidoSupportsIncludeField ? 'all' : undefined
-  };
-  var url = server.qidoRoot + '/studies?' + encodeQueryData(parameters);
-  return url;
+    var parameters = {
+        PatientName : filter.patientName,
+        PatientID: filter.patientId,
+        AccessionNumber : filter.accessionNumber,
+        limit : filter.limit || 20,
+        includefield : server.qidoSupportsIncludeField ? 'all' : undefined
+    };
+    return server.qidoRoot + '/studies?' + encodeQueryData(parameters);
 }
 
+/**
+ * Parses resulting data from a QIDO call into a set of Study MetaData
+ *
+ * @param resultData
+ * @returns {Array} An array of Study MetaData objects
+ */
 function resultDataToStudies(resultData) {
-  var studies = [];
-  resultData.forEach(function(study) {
-    studies.push({
-      studyInstanceUid: DICOMWeb.getString(study['0020000D']),
-      // 00080005 = SpecificCharacterSet
-      studyDate: DICOMWeb.getString(study['00080020']),
-      studyTime: DICOMWeb.getString(study['00080030']),
-      accessionNumber: DICOMWeb.getString(study['00080050']),
-      referringPhysicianName: DICOMWeb.getString(study['00080090']),
-      // 00081190 = URL
-      patientName: DICOMWeb.getName(study['00100010']),
-      patientId: DICOMWeb.getString(study['00100020']),
-      patientBirthdate: DICOMWeb.getString(study['00100030']),
-      patientSex: DICOMWeb.getString(study['00100040']),
-      imageCount: DICOMWeb.getString(study['00201208']),
-      studyId: DICOMWeb.getString(study['00200010']),
-      studyDescription: DICOMWeb.getString(study['00081030']),
-      modalities: DICOMWeb.getString(study['00080061'])
-      //url : server.wadoRoot + '/studies/' + DICOMWeb.getString(study['0020000D']) + '/metadata'
+    var studies = [];
+
+    resultData.forEach(function(study) {
+        studies.push({
+          studyInstanceUid: DICOMWeb.getString(study['0020000D']),
+          // 00080005 = SpecificCharacterSet
+          studyDate: DICOMWeb.getString(study['00080020']),
+          studyTime: DICOMWeb.getString(study['00080030']),
+          accessionNumber: DICOMWeb.getString(study['00080050']),
+          referringPhysicianName: DICOMWeb.getString(study['00080090']),
+          // 00081190 = URL
+          patientName: DICOMWeb.getName(study['00100010']),
+          patientId: DICOMWeb.getString(study['00100020']),
+          patientBirthdate: DICOMWeb.getString(study['00100030']),
+          patientSex: DICOMWeb.getString(study['00100040']),
+          imageCount: DICOMWeb.getString(study['00201208']),
+          studyId: DICOMWeb.getString(study['00200010']),
+          studyDescription: DICOMWeb.getString(study['00081030']),
+          modalities: DICOMWeb.getString(study['00080061'])
+        });
     });
-  });
-  return studies;
+    return studies;
 }
 
+
 Services.QIDO.Studies = function(server, filter) {
-
-  var url = filterToQIDOURL(server, filter);
-
-  var result = DICOMWeb.getJSON(url, server.requestOptions);
-
-  return resultDataToStudies(result.data);
+    var url = filterToQIDOURL(server, filter);
+    var result = DICOMWeb.getJSON(url, server.requestOptions);
+    return resultDataToStudies(result.data);
 };

Packages/viewerbase/server/services/wado/retrieveMetadata.js

@@ -1,8 +1,22 @@
+/**
+ * Creates a URL for a WADO search
+ *
+ * @param server
+ * @param studyInstanceUid
+ * @returns {string}
+ */
 function buildUrl(server, studyInstanceUid) {
-    var url = server.wadoRoot + '/studies/' + studyInstanceUid + '/metadata';
-    return url;
+    return server.wadoRoot + '/studies/' + studyInstanceUid + '/metadata';
 }
 
+/**
+ * Parses the SourceImageSequence, if it exists, in order
+ * to return a ReferenceSOPInstanceUID. The ReferenceSOPInstanceUID
+ * is used to refer to this image in any accompanying DICOM-SR documents.
+ *
+ * @param instance
+ * @returns {String} The ReferenceSOPInstanceUID
+ */
 function getSourceImageInstanceUid(instance) {
     // TODO= Parse the whole Source Image Sequence
     // This is a really poor workaround for now.
@@ -13,6 +27,16 @@ function getSourceImageInstanceUid(instance) {
     }
 }
 
+/**
+ * Parses result data from a WADO search into Study MetaData
+ * Returns an object populated with study metadata, including the
+ * series list.
+ *
+ * @param server
+ * @param studyInstanceUid
+ * @param resultData
+ * @returns {{seriesList: Array, patientName: *, patientId: *, accessionNumber: *, studyDate: *, modalities: *, studyDescription: *, imageCount: *, studyInstanceUid: *}}
+ */
 function resultDataToStudyMetadata(server, studyInstanceUid, resultData) {
     var seriesMap = {};
     var seriesList = [];
@@ -92,6 +116,12 @@ function resultDataToStudyMetadata(server, studyInstanceUid, resultData) {
     return studyData;
 }
 
+/**
+ * Retrieved Study MetaData from a DICOM server using a WADO call
+ * @param server
+ * @param studyInstanceUid
+ * @returns {{seriesList: Array, patientName: *, patientId: *, accessionNumber: *, studyDate: *, modalities: *, studyDescription: *, imageCount: *, studyInstanceUid: *}}
+ */
 Services.WADO.RetrieveMetadata = function(server, studyInstanceUid) {
     var url = buildUrl(server, studyInstanceUid);