# Pandora2D
<h1 align="center">
<a href="https://pandora2d.readthedocs.io/?badge=latest"><img src="https://raw.githubusercontent.com/CNES/Pandora2D/master/doc/sources/Images/logo/logo_pandora2d.png?inline=false" alt="Pandora2D coregistration Framework" width="432"></a>
</h1>
<h4 align="center">Pandora2d is a tool based on <a href="https://github.com/CNES/Pandora">Pandora<a/> to provide disparity maps
for images pairs with a combination of vertical and horizontal stereo.</h4>
<p align="center">
<a><img src="https://github.com/CNES/Pandora2D/actions/workflows/pandora2d_ci.yml/badge.svg?branch=master"></a>
<a href='https://pandora2d.readthedocs.io/?badge=latest'><img src='https://readthedocs.org/projects/pandora2d/badge/?version=latest' alt='Documentation Status' /></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="#example-of-use">Example of use</a> •
<a href="#install">Install</a> •
<a href="#first-step">First Step</a> •
<a href="#to-go-further">To go further</a> •
<a href="#credits">Credits</a> •
<a href="#related">Related</a>
</p>
## Example of use
* Not-aligned Sentinel2 images from Ouarzazate's Solar Central.
Before Pandora2D | After Pandora2D
:-----------------:|:----------------:
 | 
## Install
Pandora2D is available on Pypi and can be installed by:
```bash
#install pandora2d latest release
pip install pandora2d
````
## First step
Pandora2d requires a `config.json` to declare the pipeline and the pair of images to process.
Download our data sample to start right away !
- [maricopa's pair with combination of vertical and horizontal stereo](https://raw.githubusercontent.com/CNES/Pandora2D/master/data_samples/images/maricopa.zip)
- [a configuration file](https://raw.githubusercontent.com/CNES/Pandora2D/master/data_samples/json_conf_files/a_basic_pipeline.json)
```bash
# Images pairs with a combination of vertical and horizontal stereo
wget https://raw.githubusercontent.com/CNES/Pandora2D/master/data_samples/images/maricopa.zip
# Config file
wget https://raw.githubusercontent.com/CNES/Pandora2D/master/data_samples/json_conf_files/a_basic_pipeline.json
#uncompress data
unzip maricopa.zip
# run Pandora2d
pandora2d a_basic_pipeline.json output_dir
# The columns disparity map is saved in "./res/columns_disparity.tif"
# The row disparity map is saved in "./res/row_disparity.tif"
```
## To go further
To create your own coregistration pipeline and choose among the variety of
algorithms we provide, please consult [our online documentation](https://pandora2d.readthedocs.io/en/latest/).
You will learn:
* which steps you can use and combine
* how to quickly set up a Pandora2D pipeline
## Credits
Our data test sample contains modified 'Copernicus Sentinel data [2021]' for Sentinel data, provided by the Peps Sentinel2 website (CNES).
## Related
* [Pandora](<https://github.com/cnes/pandora>) - stereo matching framework
Raw data
{
"_id": null,
"home_page": "https://pandora2d.readthedocs.io/",
"name": "pandora2d",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "CNES",
"author_email": "emmanuelle.sarrazin@cnes.fr",
"download_url": "https://files.pythonhosted.org/packages/43/b3/6840a0ec8ad3e5ad095c6ad07360e5866a3dc4a2197316f853ee6e7089ff/pandora2d-0.2.0.tar.gz",
"platform": "any",
"description": "# Pandora2D\n\n<h1 align=\"center\">\n<a href=\"https://pandora2d.readthedocs.io/?badge=latest\"><img src=\"https://raw.githubusercontent.com/CNES/Pandora2D/master/doc/sources/Images/logo/logo_pandora2d.png?inline=false\" alt=\"Pandora2D coregistration Framework\" width=\"432\"></a>\n</h1>\n\n<h4 align=\"center\">Pandora2d is a tool based on <a href=\"https://github.com/CNES/Pandora\">Pandora<a/> to provide disparity maps\nfor images pairs with a combination of vertical and horizontal stereo.</h4>\n\n<p align=\"center\">\n <a><img src=\"https://github.com/CNES/Pandora2D/actions/workflows/pandora2d_ci.yml/badge.svg?branch=master\"></a>\n <a href='https://pandora2d.readthedocs.io/?badge=latest'><img src='https://readthedocs.org/projects/pandora2d/badge/?version=latest' alt='Documentation Status' /></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=\"#example-of-use\">Example of use</a> \u2022\n <a href=\"#install\">Install</a> \u2022\n <a href=\"#first-step\">First Step</a> \u2022\n <a href=\"#to-go-further\">To go further</a> \u2022\n <a href=\"#credits\">Credits</a> \u2022\n <a href=\"#related\">Related</a> \n</p>\n\n## Example of use\n\n* Not-aligned Sentinel2 images from Ouarzazate's Solar Central.\n\nBefore Pandora2D | After Pandora2D\n:-----------------:|:----------------:\n | \n\n\n## Install\n\nPandora2D is available on Pypi and can be installed by:\n\n```bash\n #install pandora2d latest release\n pip install pandora2d\n````\n\n## First step\n\nPandora2d requires a `config.json` to declare the pipeline and the pair of images to process.\nDownload our data sample to start right away !\n\n- [maricopa's pair with combination of vertical and horizontal stereo](https://raw.githubusercontent.com/CNES/Pandora2D/master/data_samples/images/maricopa.zip)\n- [a configuration file](https://raw.githubusercontent.com/CNES/Pandora2D/master/data_samples/json_conf_files/a_basic_pipeline.json)\n\n```bash\n # Images pairs with a combination of vertical and horizontal stereo\n wget https://raw.githubusercontent.com/CNES/Pandora2D/master/data_samples/images/maricopa.zip\n # Config file\n wget https://raw.githubusercontent.com/CNES/Pandora2D/master/data_samples/json_conf_files/a_basic_pipeline.json\n #uncompress data\n unzip maricopa.zip\n # run Pandora2d\n pandora2d a_basic_pipeline.json output_dir\n\n # The columns disparity map is saved in \"./res/columns_disparity.tif\"\n # The row disparity map is saved in \"./res/row_disparity.tif\"\n```\n\n## To go further\n\nTo create your own coregistration pipeline and choose among the variety of\nalgorithms we provide, please consult [our online documentation](https://pandora2d.readthedocs.io/en/latest/).\n\nYou will learn:\n\n* which steps you can use and combine\n* how to quickly set up a Pandora2D pipeline\n\n## Credits\n\nOur data test sample contains modified 'Copernicus Sentinel data [2021]' for Sentinel data, provided by the Peps Sentinel2 website (CNES). \n\n\n## Related\n\n* [Pandora](<https://github.com/cnes/pandora>) - stereo matching framework\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "A coregistration tool",
"version": "0.2.0",
"project_urls": {
"Documentation": "https://pandora2d.readthedocs.io/en/latest/",
"Homepage": "https://pandora2d.readthedocs.io/",
"Source": "https://github.com/CNES/Pandora2D"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "43b36840a0ec8ad3e5ad095c6ad07360e5866a3dc4a2197316f853ee6e7089ff",
"md5": "e160194d3efa6311167309b725bc7a52",
"sha256": "c5afdc9df8b66e89f222aafcd13e1aba6d9c775b88f761550f2d52e79ce75a11"
},
"downloads": -1,
"filename": "pandora2d-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "e160194d3efa6311167309b725bc7a52",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7748942,
"upload_time": "2024-02-07T15:53:48",
"upload_time_iso_8601": "2024-02-07T15:53:48.243616Z",
"url": "https://files.pythonhosted.org/packages/43/b3/6840a0ec8ad3e5ad095c6ad07360e5866a3dc4a2197316f853ee6e7089ff/pandora2d-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-07 15:53:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CNES",
"github_project": "Pandora2D",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "pandora2d"
}
JSON
