Skip to content

Commit 2a6cd01

Browse files
committed
Improved README, added logo
1 parent 1e4ab65 commit 2a6cd01

File tree

1 file changed

+55
-43
lines changed

1 file changed

+55
-43
lines changed

README.md

Lines changed: 55 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
## BGSLibrary
2-
A Background Subtraction Library
1+
<p align="center">
2+
<img src="https://github.com/andrewssobral/bgslibrary/blob/master/docs/images/bgslibrary-logo.jpg?raw=true" alt="BGSLibrary" width="200">
3+
</p>
4+
5+
# BGSLibrary: A Background Subtraction Library
36

47
[![Release](https://img.shields.io/badge/Release-3.3.0-blue.svg)](https://github.com/andrewssobral/bgslibrary/wiki/Build-status) [![License: GPL v3](https://img.shields.io/badge/License-MIT-blue.svg)](http://www.gnu.org/licenses/gpl-3.0) [![Platform: Windows, Linux, OS X](https://img.shields.io/badge/Platform-Windows%2C%20Linux%2C%20OS%20X-blue.svg)](https://github.com/andrewssobral/bgslibrary/wiki/Build-status) [![OpenCV](https://img.shields.io/badge/OpenCV-2.4.x%2C%203.x%2C%204.x-blue.svg)](https://github.com/andrewssobral/bgslibrary/wiki/Build-status) [![Wrapper: Python, MATLAB](https://img.shields.io/badge/Wrapper-Java%2C%20Python%2C%20MATLAB-orange.svg)](https://github.com/andrewssobral/bgslibrary/wiki/Build-status) [![Algorithms](https://img.shields.io/badge/Algorithms-43-red.svg)](https://github.com/andrewssobral/bgslibrary/wiki/List-of-available-algorithms)
58

@@ -9,64 +12,80 @@ A Background Subtraction Library
912
</a>
1013
</p>
1114

12-
Last page update: **04/03/2023**
15+
## Introduction
16+
17+
The **BGSLibrary** (Background Subtraction Library) is a comprehensive C++ framework designed for background subtraction in computer vision applications, particularly for detecting moving objects in video streams. It provides an easy-to-use and extensible platform for researchers and developers to experiment with and implement various background subtraction techniques.
18+
19+
## Library Version
20+
21+
**3.3.0** (see **[Build Status](https://github.com/andrewssobral/bgslibrary/wiki/Build-status)** and **[Release Notes](https://github.com/andrewssobral/bgslibrary/wiki/Release-notes)** for more info)
22+
23+
## Background and Development
1324

14-
Library Version: **3.3.0** (see **[Build Status](https://github.com/andrewssobral/bgslibrary/wiki/Build-status)** and **[Release Notes](https://github.com/andrewssobral/bgslibrary/wiki/Release-notes)** for more info)
25+
The BGSLibrary was developed in early 2012 by [Andrews Cordolino Sobral](http://andrewssobral.wixsite.com/home) as a C++ framework with wrappers available for Python, Java, and MATLAB. It aims to facilitate foreground-background separation in videos using the OpenCV library.
1526

16-
The **BGSLibrary** was developed in early 2012 by [Andrews Sobral](http://andrewssobral.wixsite.com/home) as a C++ framework (with wrappers available for Python, Java and MATLAB) for foreground-background separation in videos using [OpenCV](http://www.opencv.org/). The bgslibrary is compatible with OpenCV versions 2.4.x, 3.x and 4.x, and can be compiled on Windows, Linux, and Mac OS X. It currently contains **43** algorithms and is available free of charge to all users, both academic and commercial. The library's source code is available under the [MIT license](https://opensource.org/licenses/MIT).
27+
## Compatibility
28+
29+
The library is compatible with OpenCV versions 2.4.x, 3.x, and 4.x. It can be compiled and used on Windows, Linux, and Mac OS X systems.
30+
31+
## Licensing
32+
33+
The library's source code is available under the [MIT license](https://opensource.org/licenses/MIT), making it free for both academic and commercial use.
34+
35+
## Getting started
1736

1837
* [List of available algorithms](https://github.com/andrewssobral/bgslibrary/wiki/List-of-available-algorithms)
1938
* [Algorithms benchmark](https://github.com/andrewssobral/bgslibrary/wiki/Algorithms-benchmark)
2039
* [Which algorithms really matter?](https://github.com/andrewssobral/bgslibrary/wiki/Which-algorithms-really-matter%3F)
2140
* [Library architecture](https://github.com/andrewssobral/bgslibrary/wiki/Library-architecture)
2241

23-
* Installation instructions
42+
### Installation instructions
2443

2544
You can either install BGSLibrary via [pre-built binary package](https://github.com/andrewssobral/bgslibrary/releases) or build it from source
2645

27-
* * [Windows installation](https://github.com/andrewssobral/bgslibrary/wiki/Installation-instructions---Windows)
28-
29-
* * [Ubuntu / OS X installation](https://github.com/andrewssobral/bgslibrary/wiki/Installation-instructions-Ubuntu-or-OSX)
46+
* [Windows installation](https://github.com/andrewssobral/bgslibrary/wiki/Installation-instructions---Windows)
47+
* [Ubuntu / OS X installation](https://github.com/andrewssobral/bgslibrary/wiki/Installation-instructions-Ubuntu-or-OSX)
3048

31-
Supported Compilers are:
49+
Supported Compilers:
3250

33-
GCC 4.8 and above
34-
Clang 3.4 and above
35-
MSVC 2015, 2017, 2019 or newer
51+
* GCC 4.8 and above
52+
* Clang 3.4 and above
53+
* MSVC 2015, 2017, 2019 or newer
3654

3755
Other compilers might work, but are not officially supported.
3856
The bgslibrary requires some features from the ISO C++ 2014 standard.
3957

40-
* Graphical User Interface
41-
42-
* * [C++ QT](https://github.com/andrewssobral/bgslibrary/wiki/Graphical-User-Interface:-QT) ***(Official)***
43-
* * [C++ MFC](https://github.com/andrewssobral/bgslibrary/wiki/Graphical-User-Interface:-MFC) ***(Deprecated)***
44-
* * [Java](https://github.com/andrewssobral/bgslibrary/wiki/Graphical-User-Interface:-Java) ***(Obsolete)***
58+
### Graphical User Interface
4559

46-
* Wrappers
60+
* [C++ QT](https://github.com/andrewssobral/bgslibrary/wiki/Graphical-User-Interface:-QT) ***(Official)***
61+
* [C++ MFC](https://github.com/andrewssobral/bgslibrary/wiki/Graphical-User-Interface:-MFC) ***(Deprecated)***
62+
* [Java](https://github.com/andrewssobral/bgslibrary/wiki/Graphical-User-Interface:-Java) ***(Obsolete)***
4763

48-
* * [Python](https://github.com/andrewssobral/bgslibrary/wiki/Wrapper:-Python) [![Downloads](https://static.pepy.tech/badge/pybgs)](https://pepy.tech/project/pybgs) [![Downloads](https://static.pepy.tech/badge/pybgs/month)](https://pepy.tech/project/pybgs) [![Downloads](https://static.pepy.tech/badge/pybgs/week)](https://pepy.tech/project/pybgs)
49-
* * [MATLAB](https://github.com/andrewssobral/bgslibrary/wiki/Wrapper:-MATLAB)
50-
* * [Java](https://github.com/andrewssobral/bgslibrary/wiki/Wrapper:-Java)
64+
### Wrappers
5165

66+
* [Python](https://github.com/andrewssobral/bgslibrary/wiki/Wrapper:-Python) [![Downloads](https://static.pepy.tech/badge/pybgs)](https://pepy.tech/project/pybgs) [![Downloads](https://static.pepy.tech/badge/pybgs/month)](https://pepy.tech/project/pybgs) [![Downloads](https://static.pepy.tech/badge/pybgs/week)](https://pepy.tech/project/pybgs)
67+
* [MATLAB](https://github.com/andrewssobral/bgslibrary/wiki/Wrapper:-MATLAB)
68+
* [Java](https://github.com/andrewssobral/bgslibrary/wiki/Wrapper:-Java)
5269

53-
* Usage examples
70+
### Usage examples
5471

55-
* * BGSlibrary examples folder: https://github.com/andrewssobral/bgslibrary/tree/master/examples
72+
* BGSlibrary examples folder
73+
* * <https://github.com/andrewssobral/bgslibrary/tree/master/examples>
74+
* BGSlibrary examples in C++
75+
* * <https://github.com/andrewssobral/bgslibrary-examples-cpp>
76+
* BGSlibrary examples in Python
77+
* * <https://github.com/andrewssobral/bgslibrary-examples-python>
5678

57-
* * BGSlibrary examples in C++: https://github.com/andrewssobral/bgslibrary-examples-cpp
58-
59-
* * BGSlibrary examples in Python: https://github.com/andrewssobral/bgslibrary-examples-python
79+
### More
6080

6181
* [Docker images](https://github.com/andrewssobral/bgslibrary/wiki/Docker-images)
6282
* [How to integrate BGSLibrary in your own CPP code](https://github.com/andrewssobral/bgslibrary/wiki/How-to-integrate-BGSLibrary-in-your-own-CPP-code)
6383
* [How to contribute](https://github.com/andrewssobral/bgslibrary/wiki/How-to-contribute)
6484
* [List of collaborators](https://github.com/andrewssobral/bgslibrary/wiki/List-of-collaborators)
6585
* [Release notes](https://github.com/andrewssobral/bgslibrary/wiki/Release-notes)
6686

67-
6887
## Algorithm compatibility across OpenCV versions
69-
---------------------------------------------------
88+
7089
| Algorithm | OpenCV < 3.0 (42) | 3.0 <= OpenCV <= 3.4.7 (41) | 3.4.7 < OpenCV < 4.0 (39) | OpenCV >= 4.0 (26) |
7190
|--------------------------------|:-----------:|:----------------------:|:---------------------:|:------------:|
7291
| AdaptiveBackgroundLearning | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
@@ -113,17 +132,14 @@ The bgslibrary requires some features from the ISO C++ 2014 standard.
113132
| WeightedMovingMean | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
114133
| WeightedMovingVariance | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
115134

116-
117-
118135
## Stargazers over time
119136

120137
[![Stargazers over time](https://starchart.cc/andrewssobral/bgslibrary.svg)](https://starchart.cc/andrewssobral/bgslibrary)
121138

122-
123-
Citation
124-
--------
139+
## Citation
125140

126141
If you use this library for your publications, please cite it as:
142+
127143
```
128144
@inproceedings{bgslibrary,
129145
author = {Sobral, Andrews},
@@ -135,7 +151,9 @@ month = {Jun},
135151
url = {https://github.com/andrewssobral/bgslibrary}
136152
}
137153
```
154+
138155
A chapter about the BGSLibrary has been published in the handbook on [Background Modeling and Foreground Detection for Video Surveillance](https://sites.google.com/site/backgroundsubtraction/).
156+
139157
```
140158
@incollection{bgslibrarychapter,
141159
author = {Sobral, Andrews and Bouwmans, Thierry},
@@ -146,25 +164,19 @@ year = {2014},
146164
}
147165
```
148166

167+
## References
149168

150-
Download PDF:
151169
* Sobral, Andrews. BGSLibrary: An OpenCV C++ Background Subtraction Library. IX Workshop de Visão Computacional (WVC'2013), Rio de Janeiro, Brazil, Jun. 2013. ([PDF](http://www.researchgate.net/publication/257424214_BGSLibrary_An_OpenCV_C_Background_Subtraction_Library) in brazilian-portuguese containing an english abstract).
152170

153171
* Sobral, Andrews; Bouwmans, Thierry. "BGS Library: A Library Framework for Algorithm’s Evaluation in Foreground/Background Segmentation". Chapter on the handbook "Background Modeling and Foreground Detection for Video Surveillance", CRC Press, Taylor and Francis Group, 2014. ([PDF](http://www.researchgate.net/publication/257424214_BGSLibrary_An_OpenCV_C_Background_Subtraction_Library) in english).
154172

155-
156-
Some references
157-
---------------
158-
159-
Some algorithms of the BGSLibrary were used successfully in the following papers:
173+
Some algorithms of the BGSLibrary were used successfully in the following papers:
160174

161175
* (2014) Sobral, Andrews; Vacavant, Antoine. A comprehensive review of background subtraction algorithms evaluated with synthetic and real videos. Computer Vision and Image Understanding (CVIU), 2014. ([Online](http://dx.doi.org/10.1016/j.cviu.2013.12.005)) ([PDF](http://www.researchgate.net/publication/259340906_A_comprehensive_review_of_background_subtraction_algorithms_evaluated_with_synthetic_and_real_videos))
162176

163177
* (2013) Sobral, Andrews; Oliveira, Luciano; Schnitman, Leizer; Souza, Felippe. (**Best Paper Award**) Highway Traffic Congestion Classification Using Holistic Properties. In International Conference on Signal Processing, Pattern Recognition and Applications (SPPRA'2013), Innsbruck, Austria, Feb 2013. ([Online](http://dx.doi.org/10.2316/P.2013.798-105)) ([PDF](http://www.researchgate.net/publication/233427564_HIGHWAY_TRAFFIC_CONGESTION_CLASSIFICATION_USING_HOLISTIC_PROPERTIES))
164178

165-
166-
Videos
167-
------
179+
## Videos
168180

169181
<p align="center">
170182
<a href="https://www.youtube.com/watch?v=_UbERwuQ0OU" target="_blank">

0 commit comments

Comments
 (0)