X-Git-Url: http://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=doc%2FREADME;h=fa4d41f49fd8e4cadd2dcb4175adb2e88bab9974;hb=7dd02b26a4aa0e1f76a31f33a58d65255d6da0ed;hp=d84b0044aff029028e700bf97e31f7d59ff295bb;hpb=a74e394637d73a1fce837458a699713d8edef821;p=spline3.git
diff --git a/doc/README b/doc/README
index d84b004..fa4d41f 100644
--- a/doc/README
+++ b/doc/README
@@ -1,146 +1,5 @@
-1. What is it?
+Unfortunately, there's too much content in this README for me to
+maintain two versions. Please see the canonical README at,
-Spline3 is an implementation of the 3D interpolation scheme described
-in paper, "Local quasi-interpolation by cubic C^1 splines on type-6
-tetrahedral partitions" by Sorokina and Zeilfelder (this can be found
-in the 'references' folder).
+ http://michael.orlitzky.com/code/spline3.php
-It takes volumetric data as input, and allows you "zoom in" on it,
-producing higher-resolution data as a result. We "fill in the gaps"
-through interpolation.
-
-The program is written in Haskell and is novel because the main
-algorithm is purely functional. Nowhere in the main algorithm are any
-state or global variables manipulated. This has a unique benefit: the
-program can parallelize itself. Because the algorithm is a "pure"
-function, the compiler knows that it's safe to partition the
-computation across all of the available processors.
-
-In fact, our results show close-to-perfect gains. In other words,
-running on two processors is essentially twice is fast as running on
-one.
-
-
-2. Requirements
-
-Spline3 is a Haskell program using the Cabal build system. The file
-spline3.cabal lists all dependencies and it is recommended that you
-use Cabal to build the project. For convenience, a makefile is
-provided to build the project.
-
-
-3. Input data
-
-The input data is "volumetric." Basically, they're pixels in
-space. The data used came from the Stanford Volume Data Archive at
-http://graphics.stanford.edu/data/voldata/. Still, this data needs to
-be preprocessed a little before spline3 will accept it.
-
-First, we download the tarball from the website:
-
- $ wget -q http://graphics.stanford.edu/data/voldata/MRbrain.tar.gz
-
-Then, extract it and remove the tarball.
-
- $ tar -xf MRbrain.tar.gz
- $ rm MRbrain.tar.gz
-
-Now, we're left with 109 data files. We want to concatenate all of
-them together. Fortunately, they're named sequentially -- but not in
-alphabetical order. We can use a little shell magic to concatenate
-them in the right order:
-
- $ rm -f mri.bin
- $ for x in `seq 1 109`; do cat MRbrain.$x >> mri.bin; done;
-
-The result will be a file named "mri.bin" containing all 109
-layers. Other data from the website can be combined similarly.
-
-In all cases, you will need to supply a height, width, and depth to
-the program so that is knows the dimensions of its data. For the MRI
-data, this can be found on the website (although the program's
-defaults already assume you're using the MRI data):
-
- 109 slices of 256 x 256 pixels
-
-So, the correct program invocation would be,
-
- $ spline3 --depth=109 --height=256 --width=256