<h1 align="center"> Pandora plugin libSGM </h1>
<h4 align="center">Semi-Global Matching algorithm plugin for <a href="https://github.com/CNES/Pandora"><img align="center" src="https://raw.githubusercontent.com/CNES/Pandora/master/doc/sources/Images/logo/logo_typo.svg?inline=false" width="64" height="64"/></a> .</h4>
<p align="center">
<a href="https://github.com/CNES/Pandora_plugin_libSGM/actions"><img src="https://github.com/CNES/Pandora_plugin_libSGM/actions/workflows/pandora_plugin_libsgm_ci.yml/badge.svg?branch=master"></a>
<a href="https://codecov.io/gh/CNES/Pandora_plugin_libSGM"> <img src="https://codecov.io/gh/CNES/Pandora_plugin_libSGM/branch/master/graph/badge.svg?token=O22Y1OF63L"></a>
<a href="https://opensource.org/licenses/Apache-2.0/"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
</p>
<p align="center">
<a href="#overview">Overview</a> •
<a href="#install">Install</a> •
<a href="#usage">Usage</a> •
<a href="#related">Related</a> •
<a href="#references">References</a>
</p>
## Overview
[Pandora](https://github.com/CNES/Pandora) stereo matching framework is designed to provide some state of the art stereo algorithms and to add others one as plugins.
This [Pandora plugin](https://pandora.readthedocs.io/en/stable/userguide/plugin.html) aims to optimize the cost volume following Semi-Global Matching algorithm, defined by [[Hirschmuller]](#Hirschmuller), with the [libSGM](https://github.com/CNES/Pandora_libSGM) library .
## Install
**pandora_plugin_libsgm** is available on Pypi and can be installed by:
```bash
pip install numpy
pip install pandora_plugin_libsgm
```
This command will installed required dependencies as [Pandora](https://github.com/CNES/Pandora) and [libSGM](https://github.com/CNES/Pandora_libSGM).
## Usage
Let's refer to [Pandora's readme](https://github.com/CNES/Pandora/blob/master/README.md) or [online documentation](https://pandora.readthedocs.io/?badge=latest) for further information about Pandora general functionalities.
More specifically, you can find :
- [SGM configuration file example](https://raw.githubusercontent.com/CNES/Pandora/master/data_samples/json_conf_files/a_semi_global_matching.json)
- [documentation about SGM theory and parameters](https://pandora.readthedocs.io/en/stable/userguide/plugins/plugin_libsgm.html)
## Related
[Pandora](https://github.com/CNES/Pandora) - A stereo matching framework
[libSGM](https://github.com/CNES/Pandora_libSGM) - C++/python implementation of semi-global matching algorithm
## References
Please cite the following paper when using Pandora and pandora_plugin_libsgm:
*Cournet, M., Sarrazin, E., Dumas, L., Michel, J., Guinet, J., Youssefi, D., Defonte, V., Fardet, Q., 2020. Ground-truth generation and disparity estimation for optical satellite imagery. ISPRS - International Archives of the Photogrammetry, Remote Sensing and Spatial Information Sciences.*
<a id="Hirschmuller">[Hirschmuller]</a>
*H. Hirschmuller, "Stereo Processing by Semiglobal Matching and Mutual Information," in IEEE Transactions on Pattern Analysis and Machine Intelligence, vol. 30, no. 2, pp. 328-341, Feb. 2008. doi: 10.1109/TPAMI.2007.1166*
Raw data
{
"_id": null,
"home_page": "https://github.com/CNES/Pandora_plugin_libsgm",
"name": "pandora-plugin-libsgm",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "CNES",
"author_email": "myriam.cournet@cnes.fr",
"download_url": "https://files.pythonhosted.org/packages/cf/51/46ce6a137bf867c625dc5d721ab7e57d89be0366ba14b4e36326b631b935/pandora_plugin_libsgm-1.5.0.tar.gz",
"platform": null,
"description": "<h1 align=\"center\"> Pandora plugin libSGM </h1>\n\n<h4 align=\"center\">Semi-Global Matching algorithm plugin for <a href=\"https://github.com/CNES/Pandora\"><img align=\"center\" src=\"https://raw.githubusercontent.com/CNES/Pandora/master/doc/sources/Images/logo/logo_typo.svg?inline=false\" width=\"64\" height=\"64\"/></a> .</h4>\n\n<p align=\"center\">\n <a href=\"https://github.com/CNES/Pandora_plugin_libSGM/actions\"><img src=\"https://github.com/CNES/Pandora_plugin_libSGM/actions/workflows/pandora_plugin_libsgm_ci.yml/badge.svg?branch=master\"></a>\n<a href=\"https://codecov.io/gh/CNES/Pandora_plugin_libSGM\"> <img src=\"https://codecov.io/gh/CNES/Pandora_plugin_libSGM/branch/master/graph/badge.svg?token=O22Y1OF63L\"></a>\n <a href=\"https://opensource.org/licenses/Apache-2.0/\"><img src=\"https://img.shields.io/badge/License-Apache%202.0-blue.svg\"></a>\n</p>\n\n<p align=\"center\">\n <a href=\"#overview\">Overview</a> \u2022\n <a href=\"#install\">Install</a> \u2022\n <a href=\"#usage\">Usage</a> \u2022\n <a href=\"#related\">Related</a> \u2022\n <a href=\"#references\">References</a>\n</p>\n\n## Overview\n\n[Pandora](https://github.com/CNES/Pandora) stereo matching framework is designed to provide some state of the art stereo algorithms and to add others one as plugins. \nThis [Pandora plugin](https://pandora.readthedocs.io/en/stable/userguide/plugin.html) aims to optimize the cost volume following Semi-Global Matching algorithm, defined by [[Hirschmuller]](#Hirschmuller), with the [libSGM](https://github.com/CNES/Pandora_libSGM) library .\n\n## Install\n\n**pandora_plugin_libsgm** is available on Pypi and can be installed by:\n\n```bash\npip install numpy\npip install pandora_plugin_libsgm\n```\n\nThis command will installed required dependencies as [Pandora](https://github.com/CNES/Pandora) and [libSGM](https://github.com/CNES/Pandora_libSGM).\n\n## Usage\n\nLet's refer to [Pandora's readme](https://github.com/CNES/Pandora/blob/master/README.md) or [online documentation](https://pandora.readthedocs.io/?badge=latest) for further information about Pandora general functionalities. \n\nMore specifically, you can find :\n- [SGM configuration file example](https://raw.githubusercontent.com/CNES/Pandora/master/data_samples/json_conf_files/a_semi_global_matching.json)\n- [documentation about SGM theory and parameters](https://pandora.readthedocs.io/en/stable/userguide/plugins/plugin_libsgm.html)\n\n\n## Related\n\n[Pandora](https://github.com/CNES/Pandora) - A stereo matching framework \n[libSGM](https://github.com/CNES/Pandora_libSGM) - C++/python implementation of semi-global matching algorithm \n\n## References\n\nPlease cite the following paper when using Pandora and pandora_plugin_libsgm: \n*Cournet, M., Sarrazin, E., Dumas, L., Michel, J., Guinet, J., Youssefi, D., Defonte, V., Fardet, Q., 2020. Ground-truth generation and disparity estimation for optical satellite imagery. ISPRS - International Archives of the Photogrammetry, Remote Sensing and Spatial Information Sciences.*\n\n<a id=\"Hirschmuller\">[Hirschmuller]</a> \n*H. Hirschmuller, \"Stereo Processing by Semiglobal Matching and Mutual Information,\" in IEEE Transactions on Pattern Analysis and Machine Intelligence, vol. 30, no. 2, pp. 328-341, Feb. 2008. doi: 10.1109/TPAMI.2007.1166*\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Pandora plugin to optimize the cost volume with the LibSGM library",
"version": "1.5.0",
"project_urls": {
"Homepage": "https://github.com/CNES/Pandora_plugin_libsgm"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cf5146ce6a137bf867c625dc5d721ab7e57d89be0366ba14b4e36326b631b935",
"md5": "69c1af92721306c24ca01c386afb5845",
"sha256": "aa14a9eaa3ea96232fa8e41d3007e6724dc9a161fa0052bcbd10e9c880857f7a"
},
"downloads": -1,
"filename": "pandora_plugin_libsgm-1.5.0.tar.gz",
"has_sig": false,
"md5_digest": "69c1af92721306c24ca01c386afb5845",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 3149840,
"upload_time": "2024-01-31T12:43:10",
"upload_time_iso_8601": "2024-01-31T12:43:10.896233Z",
"url": "https://files.pythonhosted.org/packages/cf/51/46ce6a137bf867c625dc5d721ab7e57d89be0366ba14b4e36326b631b935/pandora_plugin_libsgm-1.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-31 12:43:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CNES",
"github_project": "Pandora_plugin_libsgm",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "pandora-plugin-libsgm"
}
JSON
