From 74992dd339713d730710dc803c943ebb72da9813 Mon Sep 17 00:00:00 2001 From: John Truckenbrodt Date: Thu, 21 Sep 2023 15:12:52 +0200 Subject: [PATCH] version 0.22.0 changelog, documentation improvements --- docs/source/about/changelog.rst | 17 +++++++++++++++++ docs/source/api/auxdata.rst | 5 ++++- pyroSAR/auxdata.py | 5 +++-- pyroSAR/snap/auxil.py | 8 +++++--- 4 files changed, 29 insertions(+), 6 deletions(-) diff --git a/docs/source/about/changelog.rst b/docs/source/about/changelog.rst index 0df7d6e8..b81cb4e7 100644 --- a/docs/source/about/changelog.rst +++ b/docs/source/about/changelog.rst @@ -934,3 +934,20 @@ Auxiliary Data Handling - function :func:`pyroSAR.auxdata.dem_create`: + new argument `resampleAlg` to change the resampling algorithm + +0.22.0 | 2023-09-21 +=================== + +Drivers +------- +- class :class:`pyroSAR.drivers.Archive`: + + + allow multiple products with same `outname_base`, e.g. Sentinel-1 GRD and SLC; this required the introduction of a second primary key in the database + + method :meth:`~pyroSAR.drivers.Archive.import_outdated`: option to import data from an old database with only one primary key; this requires the old + database to be opened in legacy mode (new argument `legacy=True`) + +- class :class:`pyroSAR.drivers.SAFE`: support for handling Sentinel-1 OCN products (metadata reading and database handling) + +Auxiliary Data Handling +----------------------- +- class :class:`pyroSAR.auxdata.DEMHandler`: enabled handling of southern hemisphere geometries. diff --git a/docs/source/api/auxdata.rst b/docs/source/api/auxdata.rst index f4425158..c4878fdd 100644 --- a/docs/source/api/auxdata.rst +++ b/docs/source/api/auxdata.rst @@ -2,7 +2,7 @@ Auxiliary Data Tools ==================== .. automodule:: pyroSAR.auxdata - :members: dem_autoload, dem_create, get_egm_lookup + :members: dem_autoload, dem_create, get_egm_lookup, getasse30_hdr, get_dem_options, DEMHandler :undoc-members: :show-inheritance: @@ -12,3 +12,6 @@ Auxiliary Data Tools dem_autoload dem_create get_egm_lookup + getasse30_hdr + get_dem_options + DEMHandler diff --git a/pyroSAR/auxdata.py b/pyroSAR/auxdata.py index e12bae2b..59472ae1 100644 --- a/pyroSAR/auxdata.py +++ b/pyroSAR/auxdata.py @@ -408,8 +408,9 @@ def dem_create(src, dst, t_srs=None, tr=None, threads=None, class DEMHandler: """ - | An interface to obtain DEM data for selected geometries. - | The files are downloaded into the ESA SNAP auxiliary data directory structure. + An interface to obtain DEM data for selected geometries. + The files are downloaded into the ESA SNAP auxiliary data directory structure. + This class is the foundation for the convenience function :func:`~pyroSAR.auxdata.dem_autoload`. Parameters ---------- diff --git a/pyroSAR/snap/auxil.py b/pyroSAR/snap/auxil.py index 415f377d..c3f135e3 100644 --- a/pyroSAR/snap/auxil.py +++ b/pyroSAR/snap/auxil.py @@ -331,18 +331,20 @@ def gpt(xmlfile, tmpdir, groups=None, cleanup=True, each (sub-)workflow containing this operator will be executed with the define executable; - e.g. ``{'Terrain-Flattening': '/home/user/snap/bin/gpt'}`` + gpt_args: list[str] or None a list of additional arguments to be passed to the gpt call - - e.g. ``['-x', '-c', '2048M']`` for increased tile cache size and intermediate clearing + - e.g. ``['-x', '-c', '2048M']`` for increased tile cache size and intermediate clearing + removeS1BorderNoiseMethod: str the border noise removal method to be applied, See :func:`pyroSAR.S1.removeGRDBorderNoise` for details; one of the following: - 'ESA': the pure implementation as described by ESA - 'pyroSAR': the ESA method plus the custom pyroSAR refinement. This is only applied if the IPF version is - < 2.9 where additional noise removal was necessary. The outpur of the additional noise removal is stored - in the subdirectory bnr of `tmpdir`. + < 2.9 where additional noise removal was necessary. The output of the additional noise removal is stored + in the subdirectory bnr of `tmpdir`. Returns -------