Manual

From BoofCV
Jump to navigationJump to search

Development with 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 tutorials. However, before going through the tutorials one should be familiar with coding standards use in BoofCV. Once these are understood one will be able to efficiently search the library or even guess the names of classes which are needed.

Click here for Coding Standards.

List of Tutorial

A few simple tutorials are provided to provide the basic concepts of development with BoofCV. First start with the Introduction tutorial and then move on to the rest depending on your interests.

Tutorials:

  1. Introduction Tutorial: Image Filters
  2. Binary Images
  3. Image Features: Stitching

Other resources:

Building BoofCV

The easiest way to build the library from source is using the provided ant scripts.

  1. Download source code. See the Main Page for where to download it from.
  2. Run the ant script inside the boofcv/main directory.
  3. Copy the BoofCV.jar from boofcv/lib.

In Linux it 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