Introduction

This is the Gamera documentation. Please note that it is still a work in progress and has many holes in it. If you'd like any holes filled in, please contact Michael Droettboom at mdboom at jhu dot edu.

This documentation consists of some HOW TO documentation and some reference documentation. In addition, there are some more formal published papers available from the Gamera website.

Overview

• Gentle overview of Gamera: For a less-detailed idea of what Gamera is and does.

How To

• Building and installing Gamera: The basics to get you started with running Gamera.

• Training tutorial: A step-by-step tutorial about how to build training sets.

• Getting started writing Gamera scripts: How to start writing a Gamera-based application.

• Writing Gamera plugins: Learn how to write new image methods.

• Specifying arguments for plugin generation and dialog boxes

• The Gamera C++ Image API: How to work with Gamera's images from C++.

• Writing Gamera toolkits: How to package your code in a redistributable package that is easier to build.

• The Gamera GUI: How to use the integrated GUI. Additionally, this describes how to train images.

• matplotlib support: Using Gamera support for the popular matplotlib plotting library.

• Classifier API: How to use image classifiers from Python.

• Unit testing: How to write and run unit-tests with Gamera.

Reference

• Plugins: Documentation of all the included plugins.

• Directory heirarchy: Where the files are.

• Image types: The different types of images available in Gamera

• Dimension types: The various classes to manage bounding boxes and geometry.

• ImageData: Manages the underlying image data viewed by Image objects.

• ImageInfo objects: Used to examine on-disk image files without loading them

• Graph objects: A simple library for dealing with graph structures.

• XML format: The XML files that Gamera uses to store training data.

Acknowledgements

Many thanks to Teal Anderson for finding numerous typos among the hideous jargon of these documents.

Some of the material presented here is based on documentation or papers by Karl MacMillan and Ichiro Fujinaga.

Gamera is funded through the National Science Foundation's Digital Library Initiative 2 (Award #9817430), an Institute of Museum and Library Services National Leadership Grant, and support from the Lester S. Levy Estate.

These documents were produced using reStructuredText.