   AUV Data Tools README 
============================

This project contains a library of functions and classes to access and process
data acquired from a Seabed AUV mission. It also contains a set of simple
tool to process and view images with 8 and 16 bit pixel depths.


Requirements:
------------
OpenCV
  - I've compiled with OpenCV versions 0.9.6 and 0.9.7
  - 0.9.5 won't work. It doesn't have the Bayer conversions and can't
    display 16-bit images.

Doxygen for building the documentation

Building:
--------
Run 'make' in the project root directory
Change the compiler flags in Makefile.config if required.

Documentation:
-------------
run 'make doxygen' in the project root directory.
Open doc/html/index.html in a browser.
 
Notes:
------
 * OpenCV cannot save images with pixel depths larger than 8 bits.
 * The OpenCV function cvConvertScale can be used to convert between 
   different pixel depths.
 * The OpenCV cvCvtColor can do some Bayer conversions. I Think this was
   new in version 0.9.6  
 * The program pnmdepth can convert PGM and PPM files to different pixel depths.
 * The program pnmtopng can convert 16-bit PGM and PPM files to 16-bit PNG files


Ian Mahon 25-11-05
