Merge branch '104-release-1-5-3' into 'master'

Resolve "Release 1.5.3"

Closes #104

See merge request 3d/PandoraBox/pandora_plugins/plugin_libsgm!147

AUTHORS.md

@@ -11,15 +11,15 @@ This file keeps track of authors contributions.
 
 ## Development Lead
 
-* Emmanuelle Sarrazin <emmanuelle.sarrazin@cnes.fr>
-* Natalia Jimenez <natalia.jimenez-diaz@csgroup.eu>
+* Emmanuel Dubois <emmanuel.dubois@cnes.fr>
 * Alice de Bardonnèche-Richard <alice.de-bardonneche-richard@csgroup.eu>
 * Marie Leconte <marie.leconte@csgroup.eu>
 * Elisa Duz <elisa.duz@csgroup.eu>
 * Philippe Mallet-Ladeira <philippe.mallet-ladeira@csgroup.eu>
 
 ## Contributors
 
+* Emmanuelle Sarrazin <emmanuelle.sarrazin@cnes.fr>
 * Veronique Defonte <veronique.defonte@csgroup.eu>
 * Quentin Fardet <quentin.fardet@csgroup.eu>
 * Mannaïg L'Haridon <mannaig.lharidon@csgroup.eu>
@@ -28,6 +28,7 @@ This file keeps track of authors contributions.
 * Mathis Roux <mathis.roux@csgroup.eu>
 * David Youssefi <David.Youssefi@cnes.fr>
 * Roman Malinowski <roman.malinowski@hds.utc.fr>
+* Natalia Jimenez <natalia.jimenez-diaz@csgroup.eu>
 
 Update here with new contributors.
 

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,22 +89,21 @@
 
 ### 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)
 
 ### Changed
 
 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]

README.md

@@ -1,6 +1,6 @@
 <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>
+<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/docs/source/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>
@@ -18,38 +18,38 @@
 
 ## 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  
 [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:   
+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> 
+<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*