
Notes on sample Vista module
----------------------------

This directory contains an example of a Vista module that can be
copied to a user's own directory and modified to perform other tasks.

This particular program creates and outputs an image with 1-bit pixels
for each image in the input.  The output pixel is 1 if the corresponding
input pixel is not less than a specified threshold.

The code is divided into two parts: a main routine, typical of a Vista
filter program, and a BinarizeImage routine, typical of a Vista library
routine. The two parts are explained further in "Introduction to the Vista
Library", in the $VISTA/doc/intro directory.

($VISTA is the top of the Vista source directory tree.)


Making a copy of this module
----------------------------

To copy this directory to your own directory, do a recursive copy:

% cp -r this-directory destination-directory

You can then cd to this directory and type "make" to compile the
module.  Test the module by running the program to binarize an
image and running "vxshow" on the result:

% binarize -thresh 128  <$VISTA/data/einstein.v  >test.v
% vxshow test.v


Man page
--------

To read the manual page in this directory, do the following:
% nroff -man binarize.man | more

It should be easy to modify the manual page to describe your own
program, even if you do not know much about nroff.
