Update some documentation.

[spline3.git] / src / MRI.hs

diff --git a/src/MRI.hs b/src/MRI.hs
index cb89af91d145c8c25c130a73b9814c9a6bfde869..c142dcd22b4d74e5b815841b894e212181131791 100644 (file)
--- a/src/MRI.hs
+++ b/src/MRI.hs
@@ -1,3 +1,8 @@
+-- | The MRI module contains functionsd and definitions relevant (and
+--   specific) to the MRI data files found at,
+--
+--   <http://graphics.stanford.edu/data/voldata/>
+--
 module MRI (
   flip_x,
   flip_y,
@@ -42,7 +47,11 @@ mri_upper_threshold = 2500
 mri_slice3d :: DIM3
 mri_slice3d = (Z :. 1 :. mri_height  :. mri_width)
 
+-- | RawData is an array of words (16 bits), as contained in the MRI
+--   data files.
 type RawData sh = Array sh Word16
+
+-- | A specialization of the 'RawData' type, to three dimensions.
 type RawData3D = RawData DIM3
 
 type RGB = (Word8, Word8, Word8)