updated doc and setup script

Author: Amit Kapadia

README.md

@@ -1,26 +1,22 @@
 # WebFITS
 
-A JavaScript library to visualize astronomical images in a web browser.  This library contains a set of functions that are frequently used to visualize the high dynamic range of astronomical images.  The following functions are currently supported:
-
-  * Linear
-  * Logarithm
-  * Square Root
-  * Hyperbolic Inverse Sine
-  * Power (order 2)
-  * Lupton Color Algorithm
-
-Extending these should be straight-forward.
-
+A JavaScript library to visualize astronomical images in a web browser.  This library contains a set of functions that are frequently used to visualize the high dynamic range of astronomical images.
 
 ## API
-    getContext()
-Setup a visualization context.  For the WebGL implementation this function sets up all programs, shaders and buffers.  For the Canvas implementation this function just extracts the 2d context and sets a few internal variables.  This function is automatically called when a new WebFITS object is instantiated, but if `teardown` is called, this function needs to be explicitly called again.
-
-    setupControls(callback)
-Allow panning and zooming on the visualization context.  `callback` is an optional user-defined function that accepts three arguments: `x`, `y`, and `opts`.  The callback is executed when the mouse moves over the visualization context, passing the `x` and `y` coordinates of the image reference frame.  This is useful for getting the pixel value at a given coordinate.  See examples.
+    
+    setupControls(mouseCallbacks, opts)
+Enable panning and zooming on the visualization context.  `mouseCallbacks` is an optional argument.  Providing an object with functions defined on the following keys will hook into WebFITS mouse events.  See `examples/webgl-single-image-mouse-callbacks.html` for an example.
+  
+  * `onmousedown`
+  * `onmouseup`
+  * `onmousemove`
+  * `onmouseout`
+  * `onmouseover`
+
+`opts` is a second optional argument that can be used to pass values to the mouse callbacks.
 
     loadImage(identifier, arr, width, height)
-Imports an image to the visualization.  `identifier` is a user chosen name for the image. `arr` is a typed array representing the image of `width` and `height`.
+Load an image into the visualization.  `identifier` is a user chosen name for the image. `arr` is a typed array representing the image of `width` and `height`.
 
     setImage(identifier)
 After loading images with `loadImage`, a specific image may be selected using this function.
@@ -29,19 +25,27 @@ After loading images with `loadImage`, a specific image may be selected using th
 Set the minimum and maximum pixels values that will be rendered.
 
     setStretch(stretch)
-Sets the stretch for the image, the default is `linear`.  Current valid values for `stretch` are `linear`, `logarithm`, `sqrt`, `arcsinh`, `power`.
+Sets the stretch for the image, the default is `linear`.  Current valid values for `stretch`
+
+  * `linear`
+  * `logarithm`
+  * `sqrt`
+  * `arcsinh`
+  * `power`
+
+-
 
     setScales(r, g, b)
 This function is relevant to color composites, setting a normalized scale for each rgb channel.
 
     setAlpha(value)
-This function is relevant to color composites, setting the `alpha` parameter in the Lupton algorithm.
+This function is relevant to color composites, setting the `alpha` parameter in the modifed Lupton algorithm.
 
     setQ(value)
-This function is relevant to color composites, setting the `Q` parameter in the Lupton algorithm.
+This function is relevant to color composites, setting the `Q` parameter in the modifed Lupton algorithm.
 
     drawColor(r_identifier, g_identifier, b_identifier)
-Render a color composite by specifying the identifiers for each channel.  Note: `setScales`, `setAlpha`, and `setQ` must be called prior to this function, this WebFITS does not provide any default values.
+Render a color composite by specifying the identifiers for each channel.  Note: `setScales`, `setAlpha`, and `setQ` must be called prior to this function.  WebFITS does not provide default values.
 
 
 ## Examples
@@ -50,9 +54,12 @@ Examples may be found in the `examples` directory.  To get started run:
 
     ./setup.sh
 
-This script downloads the latest version of [`fits.js`](http://astrojs.github.com/fitsjs/) and sample images needed for the examples.  A local server is needed to see the examples.  If familiar with NodeJS, you may run:
+This script downloads the latest version of [`fits.js`](http://astrojs.github.com/fitsjs/) and sample images needed for the examples.  A local server is needed to see the examples.  If familiar with [Node.js](http://nodejs.org/), you may install development dependencies by running:
 
     npm install .
+
+and spin up a local server
+
     http-server
 
 otherwise a local server can be started using Python.

setup.sh

@@ -6,9 +6,13 @@ mkdir -vp examples/lib
 mkdir -vp examples/data
 
 # Download JavaScript dependencies
-curl "https://raw.github.com/astrojs/fitsjs/master/lib/fits.js" -o 'examples/lib/fits.js'
+curl "https://raw.github.com/astrojs/fitsjs/rewrite/lib/fits.js" -o 'examples/lib/fits.js'
 
 # Download data for examples
 curl "http://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/data/pub/CFHTSG/W3-2%2B0.G.fits%5B16094%3A16605%2C7328%3A7839%5D" -o "examples/data/m101_g.fits"
 curl "http://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/data/pub/CFHTSG/W3-2%2B0.R.fits%5B16094%3A16605%2C7328%3A7839%5D" -o "examples/data/m101_r.fits"
 curl "http://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/data/pub/CFHTSG/W3-2%2B0.I.fits%5B16094%3A16605%2C7328%3A7839%5D" -o "examples/data/m101_i.fits"
+curl "http://astrojs.s3.amazonaws.com/sample/m101_g_sm.fits" -o "examples/data/m101_i.fits"
+curl "http://astrojs.s3.amazonaws.com/sample/CFHTLS_082_0001_g.fits.fz" -o "examples/data/CFHTLS_082_0001_g.fits.fz"
+curl "http://astrojs.s3.amazonaws.com/sample/CFHTLS_082_0001_r.fits.fz" -o "examples/data/CFHTLS_082_0001_r.fits.fz"
+curl "http://astrojs.s3.amazonaws.com/sample/CFHTLS_082_0001_i.fits.fz" -o "examples/data/CFHTLS_082_0001_i.fits.fz"