From ed976c4305c6034a3c6030473bde0c47e80176bf Mon Sep 17 00:00:00 2001 From: Emmanuel Dubois Date: Fri, 22 Nov 2024 12:32:22 +0100 Subject: [PATCH 1/2] fix: quick clean and fix README --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 29cbbec..a4da494 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

Pandora plugin libSGM

-

Semi-Global Matching algorithm plugin for .

+

Semi-Global Matching algorithm plugin for .

@@ -18,29 +18,29 @@ ## 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 . +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. + +Go to [Pandora](https://github.com/CNES/Pandora) stereo matching framework for further documentation. ## 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). +This command will install required dependencies such 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. +Let's refer to [Pandora's readme](https://github.com/CNES/Pandora/blob/master/README.md) or [online documentation](https://pandora.readthedocs.io/) 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 @@ -48,8 +48,8 @@ More specifically, you can find : ## References -Please cite the following paper when using Pandora and pandora_plugin_libsgm: +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.* -[Hirschmuller] +[Hirschmuller] *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* From d8f9dd1e4d793815d4fdd4d7a389d3e310f5e307 Mon Sep 17 00:00:00 2001 From: Emmanuel Dubois Date: Fri, 22 Nov 2024 12:32:52 +0100 Subject: [PATCH 2/2] feat: update changelog, authors with 1.5.3 release --- AUTHORS.md | 5 +++-- CHANGELOG.md | 30 +++++++++++++++++++++--------- 2 files changed, 24 insertions(+), 11 deletions(-) diff --git a/AUTHORS.md b/AUTHORS.md index a20e5e8..1b31c2f 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -11,8 +11,7 @@ This file keeps track of authors contributions. ## Development Lead -* Emmanuelle Sarrazin -* Natalia Jimenez +* Emmanuel Dubois * Alice de Bardonnèche-Richard * Marie Leconte * Elisa Duz @@ -20,6 +19,7 @@ This file keeps track of authors contributions. ## Contributors +* Emmanuelle Sarrazin * Veronique Defonte * Quentin Fardet * Mannaïg L'Haridon @@ -28,6 +28,7 @@ This file keeps track of authors contributions. * Mathis Roux * David Youssefi * Roman Malinowski +* Natalia Jimenez Update here with new contributors. diff --git a/CHANGELOG.md b/CHANGELOG.md index 20d5b8b..86fb137 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,34 +1,48 @@ # Changelog +## 1.5.3 (November 2024) + +### Changed + +- Upgrade libsgm >0.5.0 with pybind evolution. works on python>3.10. + ## 1.5.2 (September 2024) +- no change from alpha1 after test. + ## 1.5.2a1 (September 2024) ### Changed + - Update numpy version. [#103] ## 1.5.1 (June 2024) ### Changed + - Fix numpy version. ## 1.5.1a2 (June 2024) ### Changed + - Update setup.cfg file with new pandora version. ## 1.5.1a1 (June 2024) ### Changed + - Change deprecated alias in setup.cfg. [#92] - Update use_confidence parameter type. [#101] ## 1.5.0 (January 2024) ### Added + - Added margin calculation for the treatment chain with ROI image. [#85] ### Changed + - Update user configuration file with new keys : "left" & "right". [#84] - Updating information in the various xarrays. [#96] - Replacing sys.exit by raises. [#97] @@ -39,17 +53,17 @@ ## 1.5.0a1 (November 2023) ### Changed + - Adding check for geometric_prior option in check_conf function. [#88] - New format for disparity in the user configuration file. [#87] - Change read_img function to create_dataset_from_inputs. [#83] - Update with new API of Pandora run and compute_cost_volume function. [#94] - ## 1.4.0 (April 2023) -### Added +### Added -- Update warnings mentioning semantic_segmentation step in pipeline. +- Update warnings mentioning semantic_segmentation step in pipeline. - Adapt tests to new check conf pandora's format. [#77] - Add multiband classifications. [#76] @@ -75,14 +89,14 @@ ### Added -- Add 3SGM (Semantic Segmentation for SGM) method. +- Add 3SGM (Semantic Segmentation for SGM) method. ### Changed - Force python version >= 3.7. [#63] - Delete MCCNN accurate penalties. [#67] - Change values for default penalties of MC CNN fast [#65] -- Udpate dependency to Pandora 1.3.0 +- Udpate dependency to Pandora 1.3.0 ## 1.1.1 (December 2021) @@ -90,7 +104,6 @@ Update python packaging. - ## 1.1.0 (June 2021) ### Added @@ -104,7 +117,7 @@ Update python packaging. ### BREAKING CHANGE - Penalties method : removes mc_cnn_penalty parameter, added mc_cnn_fast_penalty and mc_cnn_accurate_penalty parameters - to be able to automatically load the penalties according to the type of measure. + to be able to automatically load the penalties according to the type of measure. - Change compute_penalty to take images datasets as input. - Update depency to Pandora 1.0.0 version.[#59] @@ -136,5 +149,4 @@ Update python packaging. ### Fixed -- min_cost_paths calculation: fix creation of temporary disparity map to avoid dangerous DataArray manipulation. [#43] - +- min_cost_paths calculation: fix creation of temporary disparity map to avoid dangerous DataArray manipulation. [#43]