Merge pull request #226 from johntruckenbrodt/feature/dem_enhance

DEM handling improvements
johntruckenbrodt · Sep 28, 2022 · f85219c · f85219c
2 parents 04fd4aa + 4b5f77d
commit f85219c
Show file tree

Hide file tree

Showing 17 changed files with 268 additions and 217 deletions.
diff --git a/docs/api/ancillary.rst b/docs/api/ancillary.rst
@@ -0,0 +1,19 @@
+Ancillary Functions
+===================
+
+.. automodule:: pyroSAR.ancillary
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+    .. autosummary::
+        :nosignatures:
+
+        find_datasets
+        getargs
+        groupby
+        groupbyTime
+        hasarg
+        multilook_factors
+        parse_datasetname
+        seconds
diff --git a/docs/api/auxdata.rst b/docs/api/auxdata.rst
@@ -0,0 +1,14 @@
+Auxiliary Data Tools
+====================
+
+.. automodule:: pyroSAR.auxdata
+    :members: dem_autoload, dem_create, get_egm_lookup
+    :undoc-members:
+    :show-inheritance:
+
+    .. autosummary::
+        :nosignatures:
+
+        dem_autoload
+        dem_create
+        get_egm_lookup
diff --git a/docs/api/datacube.rst b/docs/api/datacube.rst
@@ -0,0 +1,7 @@
+Datacube Tools
+==============
+
+.. automodule:: pyroSAR.datacube_util
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/drivers.rst b/docs/api/drivers.rst
@@ -0,0 +1,34 @@
+Drivers
+=======
+
+.. automodule:: pyroSAR.drivers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+    .. rubric:: classes
+
+    .. autosummary::
+        :nosignatures:
+
+        ID
+        BEAM_DIMAP
+        CEOS_PSR
+        CEOS_ERS
+        EORC_PSR
+        ESA
+        SAFE
+        TSX
+        Archive
+
+    .. rubric:: functions
+
+    .. autosummary::
+        :nosignatures:
+
+        identify
+        identify_many
+        filter_processed
+        getFileObj
+        parse_date
+        drop_archive
diff --git a/docs/figures/S1_bnr.png → docs/api/figures/S1_bnr.png b/docs/figures/S1_bnr.png → docs/api/figures/S1_bnr.png
diff --git a/docs/figures/gamma_geocode.graphml → docs/api/figures/gamma_geocode.graphml b/docs/figures/gamma_geocode.graphml → docs/api/figures/gamma_geocode.graphml
diff --git a/docs/figures/gamma_geocode.svg → docs/api/figures/gamma_geocode.svg b/docs/figures/gamma_geocode.svg → docs/api/figures/gamma_geocode.svg
diff --git a/docs/figures/snap_erode_edges.png → docs/api/figures/snap_erode_edges.png b/docs/figures/snap_erode_edges.png → docs/api/figures/snap_erode_edges.png
diff --git a/docs/figures/snap_geocode.graphml → docs/api/figures/snap_geocode.graphml b/docs/figures/snap_geocode.graphml → docs/api/figures/snap_geocode.graphml
diff --git a/docs/figures/snap_geocode.svg → docs/api/figures/snap_geocode.svg b/docs/figures/snap_geocode.svg → docs/api/figures/snap_geocode.svg
diff --git a/docs/figures/workflow_readme.txt → docs/api/figures/workflow_readme.txt b/docs/figures/workflow_readme.txt → docs/api/figures/workflow_readme.txt
diff --git a/docs/pyroSAR.rst → docs/api/gamma.rst b/docs/pyroSAR.rst → docs/api/gamma.rst
@@ -1,95 +1,8 @@
-Drivers
-=======
+GAMMA
+=====
 
-.. automodule:: pyroSAR.drivers
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-    .. rubric:: classes
-
-    .. autosummary::
-        :nosignatures:
-
-        ID
-        BEAM_DIMAP
-        CEOS_PSR
-        CEOS_ERS
-        EORC_PSR
-        ESA
-        SAFE
-        TSX
-        Archive
-
-    .. rubric:: functions
-
-    .. autosummary::
-        :nosignatures:
-
-        identify
-        identify_many
-        filter_processed
-        getFileObj
-        parse_date
-        drop_archive
-
-SNAP Processing
-===============
-
-.. automodule:: pyroSAR.snap.util
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-    .. autosummary::
-        :nosignatures:
-
-        geocode
-        noise_power
-
-Workflow Parsing and Execution
-------------------------------
-
-.. automodule:: pyroSAR.snap.auxil
-    :members: gpt, execute, parse_node, parse_recipe, split, groupbyWorkers, Workflow, Node, Par, Par_BandMath, dem_parametrize, geo_parametrize, mli_parametrize, orb_parametrize, sub_parametrize
-    :undoc-members:
-    :show-inheritance:
-
-    .. autosummary::
-        :nosignatures:
-
-        gpt
-        execute
-        parse_node
-        parse_recipe
-        split
-        groupbyWorkers
-        Workflow
-        Node
-        Par
-        Par_BandMath
-        dem_parametrize
-        geo_parametrize
-        mli_parametrize
-        orb_parametrize
-        sub_parametrize
-
-General Utilities
------------------
-
-.. automodule:: pyroSAR.snap.auxil
-    :members: erode_edges, writer
-    :undoc-members:
-    :show-inheritance:
-
-    .. autosummary::
-        :nosignatures:
-
-        erode_edges
-        writer
-
-GAMMA Processing
-================
+Processing
+----------
 
 .. automodule:: pyroSAR.gamma
     :members: geocode, convert2gamma, ISPPar, process, ovs, S1_deburst, correctOSV, multilook, par2hdr, UTM, calibrate
@@ -195,59 +108,3 @@ Within each function, the command name and all parameters are passed to function
     :members:
     :undoc-members:
     :show-inheritance:
-
-Sentinel-1 Tools
-================
-
-.. automodule:: pyroSAR.S1
-    :members: OSV, removeGRDBorderNoise
-    :undoc-members:
-    :show-inheritance:
-
-    .. autosummary::
-        :nosignatures:
-
-        OSV
-        removeGRDBorderNoise
-
-Auxiliary Data Tools
-====================
-
-.. automodule:: pyroSAR.auxdata
-    :members: dem_autoload, dem_create, get_egm_lookup
-    :undoc-members:
-    :show-inheritance:
-
-    .. autosummary::
-        :nosignatures:
-
-        dem_autoload
-        dem_create
-        get_egm_lookup
-
-Datacube Tools
-==============
-.. automodule:: pyroSAR.datacube_util
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-Ancillary Functions
-===================
-
-.. automodule:: pyroSAR.ancillary
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-    .. autosummary::
-        :nosignatures:
-
-        find_datasets
-        getargs
-        groupby
-        groupbyTime
-        hasarg
-        multilook_factors
-        parse_datasetname
-        seconds
diff --git a/docs/api/sentinel-1.rst b/docs/api/sentinel-1.rst
@@ -0,0 +1,13 @@
+Sentinel-1 Tools
+================
+
+.. automodule:: pyroSAR.S1
+    :members: OSV, removeGRDBorderNoise
+    :undoc-members:
+    :show-inheritance:
+
+    .. autosummary::
+        :nosignatures:
+
+        OSV
+        removeGRDBorderNoise
diff --git a/docs/api/snap.rst b/docs/api/snap.rst
@@ -0,0 +1,57 @@
+SNAP
+====
+
+Processing
+----------
+
+.. automodule:: pyroSAR.snap.util
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+    .. autosummary::
+        :nosignatures:
+
+        geocode
+        noise_power
+
+Workflow Parsing and Execution
+------------------------------
+
+.. automodule:: pyroSAR.snap.auxil
+    :members: gpt, execute, parse_node, parse_recipe, split, groupbyWorkers, Workflow, Node, Par, Par_BandMath, dem_parametrize, geo_parametrize, mli_parametrize, orb_parametrize, sub_parametrize
+    :undoc-members:
+    :show-inheritance:
+
+    .. autosummary::
+        :nosignatures:
+
+        gpt
+        execute
+        parse_node
+        parse_recipe
+        split
+        groupbyWorkers
+        Workflow
+        Node
+        Par
+        Par_BandMath
+        dem_parametrize
+        geo_parametrize
+        mli_parametrize
+        orb_parametrize
+        sub_parametrize
+
+General Utilities
+-----------------
+
+.. automodule:: pyroSAR.snap.auxil
+    :members: erode_edges, writer
+    :undoc-members:
+    :show-inheritance:
+
+    .. autosummary::
+        :nosignatures:
+
+        erode_edges
+        writer
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,33 +6,40 @@ General Topics
 ==============
 
 .. toctree::
-   :maxdepth: 1
+    :maxdepth: 1
 
-   general/installation
-   general/filenaming
-   general/OSV
-   general/DEM
-   general/snap
-   general/processing
-   general/logging
+    general/installation
+    general/filenaming
+    general/OSV
+    general/DEM
+    general/snap
+    general/processing
+    general/logging
 
 API Documentation
 =================
 
 .. toctree::
+    :maxdepth: 1
 
-   pyroSAR
+    api/drivers
+    api/snap
+    api/gamma
+    api/sentinel-1
+    api/auxdata
+    api/datacube
+    api/ancillary
 
 About
 =====
 
 .. toctree::
-   :maxdepth: 1
+    :maxdepth: 1
 
-   about/projects
-   about/changelog
-   about/publications
-   about/references
+    about/projects
+    about/changelog
+    about/publications
+    about/references
 
 Indices and tables
 ==================