Add zea.inverse: recover channel data from beamformed images

.github/workflows/tests.yaml

@@ -303,6 +303,9 @@ jobs:
           - name: pipeline
             dirs: pipeline
             label: pipeline
+          - name: inverse
+            dirs: inverse
+            label: inverse
           - name: data-metrics
             dirs: "data metrics"
             label: data+metrics

docs/source/_autosummary/zea.rst

@@ -47,6 +47,7 @@ zea
    display
    doppler
    func
+   inverse
    io_lib
    log
    metrics

docs/source/conf.py

@@ -122,7 +122,7 @@
 # for redirecting empty toc items to their parent
 redirects = {
     f"notebooks/{page}.html": f"../examples.html#{page}"
-    for page in ["data", "pipeline", "models", "metrics", "agent"]
+    for page in ["data", "pipeline", "inverse", "models", "metrics", "agent"]
 }
 
 # this will make sure that when an __all__ is defined in a module, the members
@@ -251,6 +251,9 @@ def _skip_reexported_members(app, what, name, obj, skip, options):
     r"^https://github\.com/[^/]+/[^/]+/blob/[0-9a-f]{40}/",
     # GitHub 429s bots; branch link (not a permalink), so not covered above.
     r"^https://github\.com/moono/lpips-tf2\.x/blob/master/example_export_script/convert_to_tensorflow\.py$",
+    # GitHub 429s bots; repo-root link (not a permalink), so not covered above.
+    # Referenced by the inverse beamforming notebooks as the original study.
+    r"^https://github\.com/sankethvedula/das-inverse$",
 ]
 linkcheck_anchors_ignore_for_url = [
     r"^https://github\.com/[^/]+/[^/]+/blob/",  # line anchors are JS-rendered

docs/source/examples.rst

@@ -19,6 +19,14 @@ Pipeline
 
     notebooks/pipeline
 
+Inversion
+---------
+
+.. toctree::
+    :maxdepth: 2
+
+    notebooks/inverse
+
 Models
 ------
 

docs/source/notebooks/inverse.rst

@@ -0,0 +1,9 @@
+Inversion
+=========
+
+.. toctree::
+    :maxdepth: 1
+
+    inverse/fish_example
+    inverse/cirs_example
+    inverse/carotid_example