This document describes the directory structure of the
TUVision Image Library.
Contents:
- Directory Overview
- Subdirectories in the Image directory:
- contrib
- Contributed free code which is used by the library (JPEG, PNG,...)
- doc
- contains the files relevant to the documentation and the
documentation generation, i.e. styleguides (like this file)
and doxygen input files.
- examples
- All files that give examples to a specific Image library class
should be put here and referenced in the comments (i.e.
documentation) of this class.
The examples are also used by the documentation tool.
- src
- Contains the source code of the library
- src/tuv
- Subdirectory which contains only Datatypes, i.e. CImage
- src/tuv/io
- Put all classes here that deal with
reading and writing of images from files.
- src/tuv/geometry
- All generic datatypes, i.e. CPoint, CVertex2d, CRect...
- src/tuv/exceptions
- The exception code of the TUVision library
- src/tuv2d
- The 2D methods
- src/tuv2d/filters
contains classes which modify images.
For example, filters which return
- a pixel-wise modified new version of the input image,
- or the same image but with modified pixels,
- or even a new image type or a feature list.
- src/tuv2d/operators
- Image operators which modify the image but not in
the sense of a filter
- src/tuv2d/extractors
- Feature extractors
- src/tuv3d
- 3D - Algorithms
- src/tuv3d/calibration
- Camera Calibration
- src/tuv3d/coordinatetransforms
- Coordinate Transformations
- include
- The header files of the TUVisionLibrary source code.
It is organized in the corresponding tuv, tuv2d and
tuv3d - subdirectories.
- Files in the root-directory:
- README
- contains a short description of the image library and an
overview of the accompanying files.
- Authors
- The main authors of the library
- INSTALL
- Installation description for the library for Unix and Windows