ADD: add new function compute_refl_from_zdr

MeteoSwiss · Oct 21, 2024 · 6ada752 · 6ada752
1 parent 7e5b5b4
commit 6ada752
Show file tree

Hide file tree

Showing 9 changed files with 3,822 additions and 1,327 deletions.
diff --git a/doc/source/examples/index.rst.new b/doc/source/examples/index.rst.new
@@ -0,0 +1,22 @@
+
+
+.. _sphx_glr_examples:
+
+Example Gallery
+===============
+
+The files used in these examples are available for download_.
+
+.. _download: https://adc.arm.gov/pyart/example_data/
+
+
+
+.. raw:: html
+
+    <div class="sphx-glr-thumbnails">
+
+
+.. raw:: html
+
+    </div>
+
diff --git a/pyart/correct/_fast_edge_finder.c b/pyart/correct/_fast_edge_finder.c
diff --git a/pyart/correct/_unwrap_1d.c b/pyart/correct/_unwrap_1d.c
diff --git a/pyart/io/_sigmetfile.c b/pyart/io/_sigmetfile.c
diff --git a/pyart/map/ckdtree.c b/pyart/map/ckdtree.c
diff --git a/pyart/retrieve/__init__.py b/pyart/retrieve/__init__.py
@@ -81,6 +81,7 @@
     compute_snr
     compute_l
     compute_cdr
+    compute_refl_from_zdr
     compute_noisedBZ
     compute_signal_power
     get_coeff_attg
@@ -228,6 +229,7 @@
 from .simple_moment_calculations import compute_rcs, compute_rcs_from_pr  # noqa
 from .simple_moment_calculations import compute_radial_noise_hs  # noqa
 from .simple_moment_calculations import compute_radial_noise_ivic  # noqa
+from .simple_moment_calculations import compute_refl_from_zdr # noqa
 from .qpe import est_rain_rate_z, est_rain_rate_zpoly, est_rain_rate_kdp  # noqa
 from .qpe import est_rain_rate_a, est_rain_rate_zkdp, est_rain_rate_za  # noqa
 from .qpe import est_rain_rate_hydro  # noqa

diff --git a/pyart/retrieve/_gecsx_functions_cython.c b/pyart/retrieve/_gecsx_functions_cython.c
diff --git a/pyart/retrieve/simple_moment_calculations.py b/pyart/retrieve/simple_moment_calculations.py
@@ -952,6 +952,56 @@ def compute_cdr(radar, rhohv_field=None, zdr_field=None, cdr_field=None):
     return cdr
 
 
+def compute_refl_from_zdr(radar, zdr_field=None, refl_field=None, ort_refl_field=None):
+    """
+    Computes the reflectivity at the orthogonal polarization
+    from zdr and the reflectivity at a given polarization
+
+    Parameters
+    ----------
+    radar : Radar
+        Radar object.
+    zdr_field : str, optional
+        Name of the ZDR field.
+    refl_field : str, optional
+        Name of the refl field.
+    ort_refl_field : str, optional
+        Name of the refl field at orthogonal polarization.
+
+    Returns
+    -------
+    ort_refl : dict
+        refl field at orthogonal polarization.
+
+    """
+    # parse the field parameters
+    if refl_field is None:
+        refl_field = get_field_name("reflectivity")
+    if zdr_field is None:
+        zdr_field = get_field_name("differential_reflectivity")
+    if ort_refl_field is None:
+        if refl_field.endswith('_vv'):
+            ort_refl_field = get_field_name("reflectivity")
+        else:
+            ort_refl_field = get_field_name("reflectivity_vv")
+
+    # extract fields from radar
+    radar.check_field_exists(refl_field)
+    radar.check_field_exists(zdr_field)
+
+    refl = radar.fields[refl_field]["data"]
+    zdrdB = radar.fields[zdr_field]["data"]
+
+    if refl_field.endswith('_vv'):
+        ort_refl_data = refl + zdrdB
+    else:
+        ort_refl_data = refl - zdrdB
+
+    ort_refl = get_metadata(ort_refl_field)
+    ort_refl["data"] = ort_refl_data
+
+    return ort_refl
+
 def compute_bird_density(
     radar, sigma_bird=11, vol_refl_field=None, bird_density_field=None
 ):

diff --git a/tests/aux_io/grid_odim.h5 b/tests/aux_io/grid_odim.h5