Manual

Welcome to BoofCV! The following manual provides an introduction to development with BoofCV. It is assumed that the reader is familiar with development in the Java programming language and the basics of computer vision. This manual primarily takes the form of example code and tutorials.

Support

Support is provided in the form of the documentation on this website and through its message board. See the left navigation board for a link to the message board. Please read through the documentation and FAQ (see below) first before posting a question there. You are much more likely to get a good responce if you demonstrate due dilligence.

http://boofcv.org/index.php?title=FAQ

If you find any mistakes in the documentation or library itself please submit a bug report or post a message about it! If you don't let us know about it we can't fix it.

Propaganda

Did you find BoofCV useful and use it on your project/work/research/thesis? Well let others know about it through your blog, twitter, or status message! Academics, please cite BoofCV in your papers and checkout the papers page to see if the specific algorithm you are using is mentioned there. Proper citations enable others replicate your work.

BoofCV Papers and Tech Report

@misc{BoofCV2012,
author = {Abeles, Peter},
title = {BoofCV},
year = {2012},
howpublished = {http://boofcv.org/}
}

List of Examples and Tutorial

A few tutorials and examples are provided to provide the basic concepts of development with BoofCV. Data files used in these examples are stored in a separate GIT repository from the main code. See boofcv/examples/readme.txt or https://github.com/lessthanoptimal/BoofCV-Data

Tutorials:

1. Quick Start
2. Images in BoofCV
3. Videos and Webcams
4. Android Support
5. Camera Calibration
6. 3D Computer Vision

Example Code:

• Image Processing
  1. Image Filters (Derivatives)
  2. Converting Images
  3. Using MultiSpectral Images
  4. Binary Images
  5. Image Pyramid
  6. Wavelet Noise Removal
• Feature
  1. Object Contour/Edge Detection
  2. Detecting Lines and Line Segments
  3. Detecting Interest Points
  4. Detect Describe Interface
  5. Associate Interest Points
  6. Track Point Features
  7. Computing SURF Features
  8. Template Matching
• 2D and 3D Structure
  1. Image Stitching
  2. Compute Fundamental Matrix
  3. Dense Stereo Disparity
  4. Dense Stereo from Monocular Camera
  5. Stereo Visual Odometry
• Calibration
  1. Calibrate Monocular Camera
  2. Calibrate Stereo Camera
  3. Detecting Calibration Targets
  4. Calibrate Given Points
  5. Remove Lens Distortion
  6. Rectify Calibrated Stereo
  7. Rectify Uncalibrated Stereo

Other resources:

• List of Applets

Building BoofCV

The easiest way to build the library from source is using the provided Ant or Maven scripts.

1. Download source code. See the Main Page for where to download it from.
2. To run either script from the command-line, switch to the boofcv/main directory.
3. Then type "ant" or "mvn package"
4. Copy the compiled jar file to an appropriate location
   • Location Ant: boofcv/lib/BoofCV.jar.
   • Location Maven: boofcv/main/target/boofcv-XX.jar

In Linux building with Ant looks something like this:

$ cd boofcv/main/
$ ant
---- lots of text -----
    [javac] Note: Some input files use unchecked or unsafe operations.
    [javac] Note: Recompile with -Xlint:unchecked for details.
    [javac] 15 warnings

jar:
      [jar] Building jar: /home/pja/projects/boofcv/main/jar/BoofCV_IO.jar

main:
      [jar] Building jar: /home/pja/projects/boofcv/lib/BoofCV.jar

main:

BUILD SUCCESSFUL
Total time: 7 seconds