diff --git a/README.md b/README.md index 14403e5..c23490f 100644 --- a/README.md +++ b/README.md @@ -1 +1,41 @@ -# sgm \ No newline at end of file +# Semi-Global Matching on the GPU + +This is the implementation of [Embedded real-time stereo estimation via Semi-Global Matching on the GPU](http://www.sciencedirect.com/science/article/pii/S1877050916306561), [D. Hernandez-Juarez](http://www.cvc.uab.es/people/dhernandez/) et al, ICCS 2016. + +## How to compile and test + +Simply use CMake and target the output directory as "build". In command line this would be (from the project root folder): + +``` +mkdir build +cd build +cmake .. +make +``` + +## How to use it + +Type: `./sgm dir p1 p2` + +The arguments `p1` and `p2` are semi-global matching parameters, for more information read the SGM paper. + +`dir` is the name of the directory which needs this format: + +``` +dir +---- left (images taken from the left camera) +---- right (right camera) +---- disparities (results will be here) +``` + +## Related Publications + +[Embedded real-time stereo estimation via Semi-Global Matching on the GPU](http://www.sciencedirect.com/science/article/pii/S1877050916306561) +[D. Hernandez-Juarez](http://www.cvc.uab.es/people/dhernandez/), A. Chacón, A. Espinosa, D. Vázquez, J. C. Moure, and A. M. López +ICCS2016 – International Conference on Computational Science 2016 + +## Requirements + +- OpenCV +- CUDA +- CMake