Table of Contents
Introduction
BoofCV is an open source real-time computer vision library written entirely in Java and released under the Apache License 2.0. Functionality includes low-level image processing, camera calibration, feature detection/tracking, structure-from-motion, classification, and recognition.
Cloning GIT Repository
The bleeding edge source code can be obtained by cloning the git repository.
git clone -b SNAPSHOT --recursive https://github.com/lessthanoptimal/BoofCV.git boofcv
Is the data directory empty? That's because you didn't follow instructions and skipped --recursive. Fix that by doing the following.
cd boofcv
git submodule update --init --recursive
Quick Start Examples and Demonstrations
New to Java? Make sure you have Java 14 or newer installed. In the command line type java -version and you should see something like:
java -version
openjdk version "14" 2020-03-17
In this case I do have Java 14 installed. If you need to install/upgrade Java there are many options these days, such as Zulu. A quick search should help if you need a more detailed explanation. You should avoid anything with -ea in its name since that's a developmental version.
You can now build and run? Then run the commands below! Each jar will open a window, then to run an application just double click on its name.
cd boofcv
./gradlew autogenerate
./gradlew examplesJar
java -jar examples/examples.jar
./gradlew demonstrationsJar
java -jar demonstrations/demonstrations.jar
All the code for what you see is in boofcv/examples and boofcv/demonstrations. Example code is designed to be easy to understand so look there first.
Click HERE for instruction on building and running Applications. There you can calibrate cameras, create QR codes, batch scan for QR codes, batch downsample images, ... etc.
Maven Central Repository
BoofCV is on Maven Central and can be easily added to your Maven, Gradle, ...etc projects. It's divided up into many modules. The easiest way to include the critical modules is to have your project dependent on 'core'.
For Maven projects:
<dependency>
<groupId>org.boofcv</groupId>
<artifactId>boofcv-core</artifactId>
<version>0.37</version>
</dependency>
There are also several integration modules which help BoofCV interact with external projects. A list of those is included below:
| Name | Description |
|---|---|
| boofcv-core | All the core libraries without any of the integration modules listed below |
| boofcv-android | Useful functions for working inside of Android devices. |
| boofcv-javacv | JavaCV is a wrapper around OpenCV mainly for file IO. |
| boofcv-ffmpeg | javacpp-presets their ffmpeg wrapper is used for reading video files. |
| boofcv-jcodec | JCodec is a pure Java video reader/writer. |
| boofcv-swing | Visualization using Java Swing |
| boofcv-WebcamCapture | A few functions that make WebcamCapture even easier to use. |
Directories
| Directory | Description |
|---|---|
| applications/ | Helpful applications |
| data/ | Directory containing optional data used by applets and examples. |
| demonstrations/ | Demonstration code which typically lets experiment by changing parameters in real-time |
| examples/ | Set of example code designed to be easy to read and understand. |
| integration/ | Contains code which allows BoofCV to be easily integrated with 3rd party libraries. Primary for video input/output. |
| main/ | Contains the source code for BoofCV |
Building from Source
Building and installing BoofCV into your local Maven repository is easy[1] using the gradlew script:
cd boofcv
./gradlew autogenerate # Creates auto generated files
./gradlew publishToMavenLocal # Installs it into the local maven repository
If you wish to have jars instead, the following commands are provided.
./gradlew oneJarBin # Builds a single jar with all of BoofCV in it
./gradlew createLibraryDirectory # Puts all jars and dependencies into boofcv/library
./gradlew alljavadoc # Combines all JavaDoc from all sub-projects into a single set
[1] A couple of the integration submodules have a custom build process that can't be performed by Gradle. The script is smart enough to ignore modules and tell you that it is doing so if you haven't configured it yet.
IntelliJ
IntelliJ is the recommended IDE for use with BoofCV. With IntelliJ you can directly import the Gradle project.
- File->Project From Existing Sources
- Select your local "boofcv" directory
- Confirm that you wish to import the Gradle project
Eclipse
The easiest way to import the project is to use Gradle to generate an Eclipse project.
cd boofcv
./gradlew eclipse
Then in Eclipse; 1) "import existing projects", 2) Select your BoofCV directory, 3) Click Finish. You can also install a Gradle plugin to Eclipse and import the project directory. That's left as an exercise for the reader.
Dependencies
Core BoofCV modules depends on the following libraries
The following is required for unit tests
Code from the following libraries has been integrated into BoofCV
- General Purpose FFT by Takuya Ooura
- Java port by Piotr Wendykier with modifications by Peter Abeles to recycle memory.
The optional sub-projects in integration also have several dependencies. See those sub-projects for a list of their dependencies.
Contact
For questions or comments about BoofCV please use the message board. Only post a bug report after doing some due diligence to make sure it is really a bug and that it has not already been reported.
1.1k Jan 5, 2023
72 Dec 20, 2022
133 Dec 19, 2022
250 Jan 9, 2023
32 Nov 16, 2022
12.4k Dec 29, 2022
2 Jan 23, 2022
26 Nov 21, 2022
11 May 21, 2022
13.1k Dec 29, 2022
13 Aug 30, 2022
6.4k Jan 4, 2023
17 Sep 27, 2021
4.5k Jan 5, 2023
30.5k Jan 4, 2023
8 Oct 2, 2022
171 Dec 31, 2022
18 Nov 17, 2022
27 Dec 20, 2022