Difference between revisions of "Download"

From BoofCV
Jump to navigationJump to search
m
m
(42 intermediate revisions by the same user not shown)
Line 2: Line 2:


'''Latest Stable Release:'''
'''Latest Stable Release:'''
* [https://sourceforge.net/projects/boofcv/files/v0.26/boofcv-v0.26-libs.zip/download Compiled Jar, Source Jar, and Dependencies]
* [https://sourceforge.net/projects/boofcv/files/v0.40/ Jars and Source Code]
* [https://sourceforge.net/projects/boofcv/files/v0.26/boofcv-v0.26-src.zip/download Source Code and Data]
* [https://github.com/lessthanoptimal/BoofCV/blob/v0.40.1/change.txt Change Log]
* [[BoofCV_Change_Log|Change Log]]
 
'''Pre-Built Applications:'''
* [[Applications#Examples_and_Demonstrations| Examples and Demonstrations ]]


If you encounter any problems getting BoofCV up and running, please let us know!  A bug might have slipped through testing or if the instructions are not clear we would like to know.
If you encounter any problems getting BoofCV up and running, please let us know!  A bug might have slipped through testing or if the instructions are not clear we would like to know.
= Java Version =
To run BoofCV requires Java 11 and above. Building BoofCV requires Java 17, but if you use the build in Gradle script that is handled for you.
Where to download the Java Virtual Machine
* https://www.azul.com/downloads/zulu/
* https://adoptopenjdk.net/
NOTE: Version 0.39 and before maintained compatibility with Java 8.


= Maven Central =
= Maven Central =
The easiest way to use boofcv is to reference its jars on Maven Central.  See below for Maven and Gradle code.  BoofCV is broken up into many modules.  To make it easier to use BoofCV all of its core functionality can be referenced using the 'all' module.  Individual modules in "integration" still must be referenced individually.
The easiest way to use boofcv is to reference its jars on [https://search.maven.org/search?q=g:org.boofcv Maven Central].  See below for Maven and Gradle code.  BoofCV is broken up into many modules.  To make it easier to use BoofCV all of its core functionality can be referenced using the 'all' module.  Individual modules in "integration" still must be referenced individually.


Artifact List
Artifact List
* ''core'' : All the core functionality of BoofCV
* ''boofcv-core'' : All the core functionality of BoofCV.
* ''all'' : All the core and integration packages in BoofCV
* ''boofcv-all'' : All the core and integration packages in BoofCV. This can be very large. You probably want core!
* ''android'' : [http://developer.android.com/index.html Android] support  
* ''boofcv-android'' : [http://developer.android.com/index.html Android] support  
* ''openkinect'' : [http://openkinect.org/wiki/Main_Page Open Kinect] support (The Kinect RGB-D sensor)
* ''boofcv-WebcamCapture'' : [http://webcam-capture.sarxos.pl/ Webcam Capture support]
* ''WebcamCapture'' : [http://webcam-capture.sarxos.pl/ Webcam Capture support]
* ''boofcv-javacv'' : [https://github.com/bytedeco/javacv JavaCV] (Reading OpenCV files)
* ''javacv'' : [https://github.com/bytedeco/javacv JavaCV] (reading videos)
* ''boofcv-ffmpeg'' : [https://github.com/bytedeco/javacpp-presets javacpp-presets] Reading videos
* ''jcodec'' : [http://jcodec.org/ jcodec] Pure Java (and buggy) library for reading videos.
* ''boofcv-swing'' : Visualization using Java Swing
* ''boofcv-jcodec'' : [http://jcodec.org/ jcodec] Pure Java (and buggy) library for reading videos.


== Maven ==
== Gradle Dependencies ==


Here are some examples for how to add BoofCV to your Gradle project. You will need to replace $VERSION with the latest version of BoofCV, e.g. 0.40. If you just want image processing, with very few external dependencies, just include the following in your Gradle script:
<pre>
<pre>
<dependency>
api("org.boofcv:boofcv-core:$VERSION")
  <groupId>org.boofcv</groupId>
  <artifactId>ARTIFACT NAME</artifactId>
  <version>0.26</version>
</dependency>
</pre>
</pre>
It is possible to include only the modules inside of core that you need. While not difficult, you will need to learn more about how BoofCV is structured.


== Gradle ==
Since this does not include GUI or Webcam code most of the examples will not run! Here's how you can add them:
<pre>
<pre>
compile group: 'org.boofcv', name: 'ARTIFACT NAME', version: '0.26'
['boofcv-core','boofcv-swing','boofcv-WebcamCapture','demonstrations'].each
    { String a -> compile group: 'org.boofcv', name: a, version: VERSION }
</pre>
</pre>
Deep Learning does add some external dependencies that most people don't need. In the future that might become an optional dependency. For now look at [[Optimizing BoofCV]] for more complex ways to reduce the jar size.


= Bleeding Edge =  
= Bleeding Edge =  


The absolutely latest code is available on Github. This code should be considered developmental and may or may not work. Be wary if the link below shows the build is failing, since it's likely to fail for you too!
The absolutely latest code is available on Github. This code should be considered developmental and may or may not work. Please follow build instructions included in the [https://github.com/lessthanoptimal/BoofCV#building-from-source README.MD] as those will be up to date. There is also a (slightly) out of date [https://youtu.be/qMTtdiujAtQ?t=67 YouTube Video].
 
<span class="plainlinks">[http://travis-ci.org/lessthanoptimal/BoofCV https://secure.travis-ci.org/lessthanoptimal/BoofCV.png]</span>
 
To check it out do the following.
<pre>
git clone --recursive https://github.com/lessthanoptimal/BoofCV.git boofcv
</pre>
You need to do '--recursive' to ensure that you grab the data submodule too.  If you forgot to do it you can also invoke the following command.
<pre>
cd boofcv
git submodule update --init --recursive
</pre>
 
Then Gradle can be used to build the project as is usual.


= Past Releases =
= Past Releases =
Line 58: Line 58:
! Version !! Link !! Description  
! Version !! Link !! Description  
|-
|-
| v0.26 || [https://sourceforge.net/projects/boofcv/files/v0.26 Link] || Critical bug fixes, more examples, improved asymmetric grid
| v0.40.1 || [https://sourceforge.net/projects/boofcv/files/v0.40 Link] || Micro QR Code and strict null enforcement
|-
|-
| v0.25 || [https://sourceforge.net/projects/boofcv/files/v0.25 Link] || 360 and fisheye support, Deep Learning, circle asym grid, ... etc
| v0.39.1 || [https://sourceforge.net/projects/boofcv/files/v0.39.1 Link] || Markers (ECoCheck, AruCo), Calibration Apps, Simulation
|-
|-
| v0.24.1 || [https://sourceforge.net/projects/boofcv/files/v0.24.1 Link] || Fixed dependency on a SNAPSHOT
| v0.38 || [https://sourceforge.net/projects/boofcv/files/v0.38 Link] || Better MVS and Scene Recognition
|-
|-
| v0.24 || [https://sourceforge.net/projects/boofcv/files/v0.24 Link] || Replaced Xuggler with JavaCV
| v0.37 || [https://sourceforge.net/projects/boofcv/files/v0.37 Link] || Mutli-View Stereo
|-
|-
| v0.23 || [https://sourceforge.net/projects/boofcv/files/v0.23 Link] || Refactoring of image names
| v0.36 || [https://sourceforge.net/projects/boofcv/files/v0.36 Link] || Random dot markers, SBA in Visual odometry, visualization
|-
|-
| Alpha v0.22 || [https://sourceforge.net/projects/boofcv/files/v0.22 Link] || HOG, bug fixes and other tweaks
| v0.35 || [https://sourceforge.net/projects/boofcv/files/v0.35 Link] || Even better Chessboard, stereo, various
|-
|-
| Alpha v0.21 || [https://sourceforge.net/projects/boofcv/files/v0.21 Link] || Rewrite of SIFT, Dense SIFt, improved chessboard
| v0.34 || [https://sourceforge.net/projects/boofcv/files/v0.34 Link] || More Concurrency, Chessboard, Lines
|-
|-
| Alpha v0.20 || [https://sourceforge.net/projects/boofcv/files/v0.20 Link] || Better fiducials, bug fixes, less clutter
| v0.33 || [https://sourceforge.net/projects/boofcv/files/v0.33.1 Link] || Concurrency, SFM, QR Fixes
|-
|-
| Alpha v0.19 || [https://sourceforge.net/projects/boofcv/files/v0.19 Link] || Background modelling, improved fiducials, scene recognition
| v0.32 || [https://sourceforge.net/projects/boofcv/files/v0.32 Link] || Uncalibrated Stereo
|-
|-
| Alpha v0.18 || [https://sourceforge.net/projects/boofcv/files/v0.18 Link] || Thresholding, fiducials
| v0.31 || [https://sourceforge.net/projects/boofcv/files/v0.31 Link] || Sparse Bundle Adjustment
|-
|-
| Alpha v0.17 || [https://github.com/lessthanoptimal/BoofCV/releases/tag/v0.17 Link] || Gradle, segmentation, dense optical flow, integration
| v0.30 || [https://sourceforge.net/projects/boofcv/files/v0.30 Link] || Android and SFM
|-
|-
| Alpha v0.16 || [https://sourceforge.net/projects/boofcv/files/v0.16 Link] || Object tracking, FFT, color SURF
| v0.29 || [https://sourceforge.net/projects/boofcv/files/v0.29 Link] || BOverride, Background GMM, GVersion
|-
|-
| Alpha v0.15 || [https://sourceforge.net/projects/boofcv/files/v0.15 Link] || Kinect, visual odometry, ground plane, bugs
| v0.28 || [https://sourceforge.net/projects/boofcv/files/v0.28 Link] || Fisheye calibration, Hex target, QR Code, polyline
|-
|-
| Alpha v0.14 || [https://sourceforge.net/projects/boofcv/files/v0.14 Link] || Improved 2D image processing
| v0.27 || [https://sourceforge.net/projects/boofcv/files/v0.27 Link] || Module name changes, new calib target, new distortion
|-
|-
| Alpha v0.13 || [https://sourceforge.net/projects/boofcv/files/v0.13 Link] || Feature API changes, VO, many changes
| v0.26 || [https://sourceforge.net/projects/boofcv/files/v0.26 Link] || Critical bug fixes, more examples, improved asymmetric grid
|-
|-
| Alpha v0.12 || [https://sourceforge.net/projects/boofcv/files/v0.12 Link] || SIFT, combined tracker, API changes
| v0.25 || [https://sourceforge.net/projects/boofcv/files/v0.25 Link] || 360 and fisheye support, Deep Learning, circle asym grid, ... etc
|-
|-
| Alpha v0.11 || [https://sourceforge.net/projects/boofcv/files/v0.11 Link] || Stereo Visual Odometry, trifocal tensor
| v0.24.1 || [https://sourceforge.net/projects/boofcv/files/v0.24.1 Link] || Fixed dependency on a SNAPSHOT
|-
|-
| Alpha v0.10 || [https://sourceforge.net/projects/boofcv/files/v0.10 Link] || 5-pt Essential, Template, Improved performance/API.
| v0.24 || [https://sourceforge.net/projects/boofcv/files/v0.24 Link] || Replaced Xuggler with JavaCV
|-
|-
| Alpha v0.9 || [https://sourceforge.net/projects/boofcv/files/v0.9 Link] || Android and Xuggler support, Refactorings
| v0.23 || [https://sourceforge.net/projects/boofcv/files/v0.23 Link] || Refactoring of image names
|-
| Alpha v0.8 || [https://sourceforge.net/projects/boofcv/files/v0.8 Link] || Stereo disparity, tweaked calibration
|-
| Alpha v0.7 || [https://sourceforge.net/projects/boofcv/files/v0.7 Link] || Stereo calibration, rectification, improved API
|-
| Alpha v0.6 || [https://sourceforge.net/projects/boofcv/files/v0.6 Link] || Camera calibration, 3D Vision, Performance, and more
|-
| Alpha v0.5 || [https://sourceforge.net/projects/boofcv/files/v0.5 Link] || Improvements to SURF and non-linear optimization
|-
| Alpha v0.4 || [https://sourceforge.net/projects/boofcv/files/v0.4 Link] || Fixed bugs in SURF and MultiSpectral images
|-
| Alpha v0.3 || [https://sourceforge.net/projects/boofcv/files/v0.3 Link] || More color and camera calibration support
|-
| Alpha v0.2 || [https://sourceforge.net/projects/boofcv/files/v0.2 Link] || API improvements and geometric vision
|-
| Alpha v0.1 || [https://sourceforge.net/projects/boofcv/files/v0.1 Link] || First formal publish release
|}
|}

Revision as of 19:04, 30 June 2022

BoofCV is available from its central repository at Github or through periodic releases. Below are links to the latest stable release hosted on SourceForge.

Latest Stable Release:

Pre-Built Applications:

If you encounter any problems getting BoofCV up and running, please let us know! A bug might have slipped through testing or if the instructions are not clear we would like to know.

Java Version

To run BoofCV requires Java 11 and above. Building BoofCV requires Java 17, but if you use the build in Gradle script that is handled for you.

Where to download the Java Virtual Machine

NOTE: Version 0.39 and before maintained compatibility with Java 8.

Maven Central

The easiest way to use boofcv is to reference its jars on Maven Central. See below for Maven and Gradle code. BoofCV is broken up into many modules. To make it easier to use BoofCV all of its core functionality can be referenced using the 'all' module. Individual modules in "integration" still must be referenced individually.

Artifact List

  • boofcv-core : All the core functionality of BoofCV.
  • boofcv-all : All the core and integration packages in BoofCV. This can be very large. You probably want core!
  • boofcv-android : Android support
  • boofcv-WebcamCapture : Webcam Capture support
  • boofcv-javacv : JavaCV (Reading OpenCV files)
  • boofcv-ffmpeg : javacpp-presets Reading videos
  • boofcv-swing : Visualization using Java Swing
  • boofcv-jcodec : jcodec Pure Java (and buggy) library for reading videos.

Gradle Dependencies

Here are some examples for how to add BoofCV to your Gradle project. You will need to replace $VERSION with the latest version of BoofCV, e.g. 0.40. If you just want image processing, with very few external dependencies, just include the following in your Gradle script:

api("org.boofcv:boofcv-core:$VERSION")

It is possible to include only the modules inside of core that you need. While not difficult, you will need to learn more about how BoofCV is structured.

Since this does not include GUI or Webcam code most of the examples will not run! Here's how you can add them:

['boofcv-core','boofcv-swing','boofcv-WebcamCapture','demonstrations'].each
    { String a -> compile group: 'org.boofcv', name: a, version: VERSION }

Deep Learning does add some external dependencies that most people don't need. In the future that might become an optional dependency. For now look at Optimizing BoofCV for more complex ways to reduce the jar size.

Bleeding Edge

The absolutely latest code is available on Github. This code should be considered developmental and may or may not work. Please follow build instructions included in the README.MD as those will be up to date. There is also a (slightly) out of date YouTube Video.

Past Releases

Version Link Description
v0.40.1 Link Micro QR Code and strict null enforcement
v0.39.1 Link Markers (ECoCheck, AruCo), Calibration Apps, Simulation
v0.38 Link Better MVS and Scene Recognition
v0.37 Link Mutli-View Stereo
v0.36 Link Random dot markers, SBA in Visual odometry, visualization
v0.35 Link Even better Chessboard, stereo, various
v0.34 Link More Concurrency, Chessboard, Lines
v0.33 Link Concurrency, SFM, QR Fixes
v0.32 Link Uncalibrated Stereo
v0.31 Link Sparse Bundle Adjustment
v0.30 Link Android and SFM
v0.29 Link BOverride, Background GMM, GVersion
v0.28 Link Fisheye calibration, Hex target, QR Code, polyline
v0.27 Link Module name changes, new calib target, new distortion
v0.26 Link Critical bug fixes, more examples, improved asymmetric grid
v0.25 Link 360 and fisheye support, Deep Learning, circle asym grid, ... etc
v0.24.1 Link Fixed dependency on a SNAPSHOT
v0.24 Link Replaced Xuggler with JavaCV
v0.23 Link Refactoring of image names