Welcome to BoofCV! BoofCV is an open source Java computer vision library intended for developers. 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.
Before you can do anything with BoofCV you will need to download it. The download page provides instructions on how to download pre-compiled jars, source code, add a Maven dependency, and checkout the latest source code. After you obtain the jar files browse through the examples below to get ideas on how you can use BoofCV.
Want to try out BoofCV without needing to build it? Check out the available applications!
To use BoofCV in your project you do NOT need to build it. The best way to add BoofCV to you project is by using the jars uploaded to Maven Central and referencing them in your Gradle or Maven project. See Download for more instructions on adding BoofCV to your project.
Building BoofCV is very easy. The only bit that's tricky is knowing that you need to first run the auto code generator as is shown below. Note that it can take a minute or two the first time you build to download all the dependencies.
cd boofcv git clean -fd main ./gradlew autogenerate ./gradlew publishToMavenLocal
The latest build script should even download the latest JDK for you. If there are any issues please post a question to the message board. If you are building from an IDE such as IntelliJ or Eclipse you will probably need to point it towards the correct JDK manually. The readme.md will have the latest info on JDK compatibility, but Java 15 is what it needs to be built with.
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 response if you demonstrate due diligence.
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.
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.
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
Want to quickly explore all the examples and run all the demonstrations? Checkout the source code and run the following applications:
cd boofcv ./gradlew examples java -jar examples/examples.jar ./gradlew demonstrations java -jar demonstrations/demonstrations.jar
YouTube Video showing the above applications being built and run.
Alternatively you can just download a pre-compiled application and explore these examples that way. See Applications.
List of simple examples which demonstrate a single capability of BoofCV.