This distribution, UnshakeC1.5r1 includes pre-compiled libraries for
Linux (compiled under SuSE Linux, gcc-3.3.5), man files, and source files
for a simple command-line filter for PNM files, along with test
images. The PNM library libpnm must be present on your computer, and
pnmtools would be a great advantage.

To build:
Unpack the distribution and cd to the resulting directory. Read the file
"LICENCE". Type "make". That should do it.

To check:
Unzip the image files;
gunzip A_sols.ppm.gz A_sols.out.ppm.gz
Then run the program on the source file, and check that the result is
identical to A_sols.out.ppm;
./Unshake -m < A_sols.ppm > test.ppm
pnmpsnr A_sols.out.ppm test.ppm
(It should say that all three components "do not differ".)

To install as root:
Copy Unshake to /usr/bin or /usr/local/bin. Copy libUnshake.3 and
Unshake.1 into /usr/share/man/man3 and /usr/share/man/man1 (or the
appropriate places on your system). If you are going to use libUnshake.a, copy
libUnshake.a and libphase.a to /usr/lib or similar.

Or:
As a user other than root, copy the files to directories where your personal
shell environment can find them.

To use Unshake:
Assuming that pnmtools are present on your system, use them to translate image
files to pnm format. E.g. to deconvolve PNG file myfile.PNG into JPEG file
myfile.out.jpg, type
pngtopnm myfile.png | unshake.sh | ppmtojpeg > myfile.out.jpg

"unshake.sh" is a simple shell script which converts images encoded using sRGB
into the linear coding which Unshake assumes. (Integer values in the file are
proportional to the intensity of light in the scene.)

Be patient - it can take a while to Fourier transform a large image.

M.D. Cahill, 1st January 2003, ammended for UnshakeC1.5r1, 6th September 2006.


