Updated backlog/roadmap

Improved naming for image loading:
  loadImage() now just loads the image and does not cache it
  loadAndCacheImage() loads and caches the image
updated examples to use new

dist/cornerstone.css

@@ -1,4 +1,4 @@
-/*! cornerstone - v0.3.0 - 2014-05-04 | (c) 2014 Chris Hafey | https://github.com/chafey/cornerstone */
+/*! cornerstone - v0.3.0 - 2014-05-06 | (c) 2014 Chris Hafey | https://github.com/chafey/cornerstone */
 .cornerstone-enabled-image {
 
     /* prevent text selection from occurring when dragging the mouse on the div */

dist/cornerstone.js

@@ -1,4 +1,4 @@
-/*! cornerstone - v0.3.0 - 2014-05-04 | (c) 2014 Chris Hafey | https://github.com/chafey/cornerstone */
+/*! cornerstone - v0.3.0 - 2014-05-06 | (c) 2014 Chris Hafey | https://github.com/chafey/cornerstone */
 var cornerstone = (function (cornerstone) {
 
     "use strict";
@@ -901,7 +901,7 @@ var cornerstone = (function (cornerstone) {
     // Loads an image given an imageId and returns a promise which will resolve
     // to the loaded image object or fail if an error occurred.  The loaded image
     // is not stored in the cache
-    function loadImageNoCache(imageId) {
+    function loadImage(imageId) {
         if(imageId === undefined) {
             throw "loadImage: parameter imageId must not be undefined";
         }
@@ -922,13 +922,27 @@ var cornerstone = (function (cornerstone) {
     // Loads an image given an imageId and returns a promise which will resolve
     // to the loaded image object or fail if an error occurred.  The image is
     // stored in the cache
-    function loadImage(imageId) {
+    function loadAndCacheImage(imageId) {
+        if(imageId === undefined) {
+            throw "loadAndCacheImage: parameter imageId must not be undefined";
+        }
+
+        var imagePromise = cornerstone.imageCache.getImagePromise(imageId);
+        if(imagePromise !== undefined) {
+            return imagePromise;
+        }
+
+        imagePromise = loadImageFromImageLoader(imageId);
+        if(imagePromise === undefined) {
+            throw "loadAndCacheImage: no image loader for imageId";
+        }
 
-        var imagePromise = loadImageNoCache(imageId);
         cornerstone.imageCache.putImagePromise(imageId, imagePromise);
+
         return imagePromise;
     }
 
+
     // registers an imageLoader plugin with cornerstone for the specified scheme
     function registerImageLoader(scheme, imageLoader) {
         imageLoaders[scheme] = imageLoader;
@@ -944,7 +958,7 @@ var cornerstone = (function (cornerstone) {
     // module exports
 
     cornerstone.loadImage = loadImage;
-    cornerstone.loadImageNoCache = loadImageNoCache;
+    cornerstone.loadAndCacheImage = loadAndCacheImage;
     cornerstone.registerImageLoader = registerImageLoader;
     cornerstone.registerUnknownImageLoader = registerUnknownImageLoader;
 

docs/backlog.md

@@ -4,7 +4,11 @@ Backlog:
 
 Beyond v1.0:
 ------------
- * [ASM.JS](http://asmjs.org/) version of storedPixelDataToCanvasImageData and generateLut
+  * Packaging/build related
+      * AMD wrapper to make it easier to use with AMD loaders
+  * more viewport functionality
+      * pseudo color tables (for PET, MRI)
+* [ASM.JS](http://asmjs.org/) version of storedPixelDataToCanvasImageData and generateLut
  * [Native Client](https://developers.google.com/native-client/dev/) version of storedPixelDataToCanvasImageData
    and generateLut
  * Cine clip support via HTML5 video tag

docs/roadmap.md

@@ -7,12 +7,6 @@ Phase 6 (in progress - target by May 15 for SIIM)
 --------------------
  * API documentation
  * Testing for other browsers and platforms (automated if possible)
- * Packaging/build related
-     * AMD wrapper to make it easier to use with AMD loaders
- * more viewport functionality
-     * pseudo color tables (for PET, MRI)
- * Code cleanup / refactoring / documentation
-
 
 Phase 5 (completed April 17, 2014)
 ---------------------

example/imageCache/index.html

@@ -81,7 +81,7 @@ <h1>
 
         $('#addImage').click(function() {
             var imageId = "colorImageLoader://" + imageNum++;
-            cornerstone.loadImage(imageId);
+            cornerstone.loadAndCacheImage(imageId);
         });
 
         setInterval(function() {
@@ -94,7 +94,7 @@ <h1>
         var canvas = document.createElement('canvas');
 
         // Loads an image given an imageId
-        function loadImage(imageId) {
+        function loadImage  (imageId) {
 
             var width = 256;
             var height = 256;
@@ -175,7 +175,7 @@ <h1>
 
         // load image and display it
         var imageId = "colorImageLoader://1";
-        cornerstone.loadImage(imageId).then(function(image) {
+        cornerstone.loadAndCacheImage(imageId).then(function(image) {
             cornerstone.displayImage(element, image);
 
             // add event handlers to mouse move to adjust window/center

example/index.html

@@ -32,6 +32,7 @@ <h1>
         <li><a href="nonSquarePixels/index.html">Non square pixels</a></li>
         <li><a href="colorImage/index.html">Color Images</a></li>
         <li><a href="scrollzoompanwl/index.html">All features (scroll, zoom, pan, window/level, html overlays, resize, invert, interpolation)</a></li>
+        <li><a href="imageCache/index.html">Image Cache</a></li>
     </ul>
 
 

example/multiimage/index.html

@@ -64,13 +64,13 @@ <h1>
         var mr3 = cornerstone.enable(document.getElementById('ct1'));
 
         // load and display the images
-        cornerstone.loadImage('example://1').then(function(image) {
+        cornerstone.loadAndCacheImage('example://1').then(function(image) {
             cornerstone.displayImage(mr1, image);
         });
-        cornerstone.loadImage('example://2').then(function(image) {
+        cornerstone.loadAndCacheImage('example://2').then(function(image) {
             cornerstone.displayImage(mr2, image);
         });
-        cornerstone.loadImage('ctexample://1').then(function(image) {
+        cornerstone.loadAndCacheImage('ctexample://1').then(function(image) {
             cornerstone.displayImage(ct1, image);
         });
     });

example/scrollzoompanwl/index.html

@@ -83,7 +83,7 @@ <h1>
 
         // updates the image display
         function updateTheImage(imageIndex) {
-            return cornerstone.loadImage(imageIds[imageIndex]).then(function(image) {
+            return cornerstone.loadAndCacheImage(imageIds[imageIndex]).then(function(image) {
                 currentImageIndex = imageIndex;
                 var viewport = cornerstone.getViewport(element);
                 cornerstone.displayImage(element, image, viewport);

src/imageLoader.js

@@ -35,7 +35,7 @@ var cornerstone = (function (cornerstone) {
     // Loads an image given an imageId and returns a promise which will resolve
     // to the loaded image object or fail if an error occurred.  The loaded image
     // is not stored in the cache
-    function loadImageNoCache(imageId) {
+    function loadImage(imageId) {
         if(imageId === undefined) {
             throw "loadImage: parameter imageId must not be undefined";
         }
@@ -56,13 +56,27 @@ var cornerstone = (function (cornerstone) {
     // Loads an image given an imageId and returns a promise which will resolve
     // to the loaded image object or fail if an error occurred.  The image is
     // stored in the cache
-    function loadImage(imageId) {
+    function loadAndCacheImage(imageId) {
+        if(imageId === undefined) {
+            throw "loadAndCacheImage: parameter imageId must not be undefined";
+        }
+
+        var imagePromise = cornerstone.imageCache.getImagePromise(imageId);
+        if(imagePromise !== undefined) {
+            return imagePromise;
+        }
+
+        imagePromise = loadImageFromImageLoader(imageId);
+        if(imagePromise === undefined) {
+            throw "loadAndCacheImage: no image loader for imageId";
+        }
 
-        var imagePromise = loadImageNoCache(imageId);
         cornerstone.imageCache.putImagePromise(imageId, imagePromise);
+
         return imagePromise;
     }
 
+
     // registers an imageLoader plugin with cornerstone for the specified scheme
     function registerImageLoader(scheme, imageLoader) {
         imageLoaders[scheme] = imageLoader;
@@ -78,7 +92,7 @@ var cornerstone = (function (cornerstone) {
     // module exports
 
     cornerstone.loadImage = loadImage;
-    cornerstone.loadImageNoCache = loadImageNoCache;
+    cornerstone.loadAndCacheImage = loadAndCacheImage;
     cornerstone.registerImageLoader = registerImageLoader;
     cornerstone.registerUnknownImageLoader = registerUnknownImageLoader;