Craig R. Farrand
Computer Science 699
README file for python/PIL/imaging project

	All the main files are included in the project directory, the only 
exception being the update.bat file included in the Project parent's directory.
At this time, the parent directory is the main notes directory.

	By running update.bat in the parent directory, it will copy out notes.py,
convert.py, and run.bat from the project directory to the parent directory.
It will also copy out notemodule.dll from the project\debug directory to the
parent directory.  From there, all the necessary files including the next.gif and
prev.gif are copied to the testing subdirectories.  At this time, the main testing
directory is the labImages directory.

RUNNING
-------

To run the whole project, the following files must be in the same
directory:

	notes.py
	convert.py
	notemodule.dll
	run.bat
	prev.gif
	next.gif

Then type run.bat at the command line or by double clicking it.  Answer yes when
asked to delete all the files in the web subdirectory.  The input images must also
be saved to the directory with the previously mentioned files.  The input images must
be in .tif format, and must be numbered in one of the following forms (the leading
name can be anything as long as it's the same for all the files):

	1)  notes.tif notes1.tif .... notes11.tif notes12.tif .... up to notes99.tif

	OR

	2)  notes1.tif ............ up to notes99.tif

	OR

	3)  notes01.tif notes02.tif .... notes10.tif notes11.tif .... up to notes99.tif

	Current limitations, only support numbers up to 99, which should be more than
	sufficient.  Since this project is based on the scanner in the vision lab (3370C),
	the normal input filenames will be in format 1 listed above.  When you select
	an initial name such as notes to use with the autofeeder, the output filenames are
	notes.tif notes1.tif notes2.tif ..... notes10.tif notes11.tif .... notes99.tif.


PROJECT FILES
-------------

NOTES.PY

This is the main python class used to call various pil library methods such as
opening, saving, resizing, getpixel, putpixel, cropping, pasting, etc.  This is
where the notemodule methods are called from.

CONVERT.PY

This is the python script that makes an instance of the note class, converts the
input .tif filenames, creates the appropriate web pages, and writes out all the
cleaned images in .gif format to the web subdirectory.  It also writes out all the
necessary .html files.

NOTEMODULE.H

Header file for the notemodule extension.

NOTEMODULE.C

The c file for the notemodule extension.  Contains various filters for resizing,
and color algorithms for setting the colors in the output image.

NOTEMODULE_WRAP.C

The wrapper file created by SWIG to allow python to make calls to the c extension.

NOTEMODULE.I

A simple interface file required by SWIG.

RUN.BAT

A batch file which sets up the web subdirectory, starts convert.py, copies all final
images to the web subdirectory, and deletes all intermediate files from the current
directory.  To run the whole project, the following files must be in the same
directory:

	notes.py
	convert.py
	notemodule.dll
	run.bat
	prev.gif
	next.gif

	(input images with filenames as mentioned earlier)
