From aa578b62a9d6e775e3d911508440292519f85535 Mon Sep 17 00:00:00 2001 From: Bhupendra Raut Date: Thu, 22 Aug 2024 15:30:20 -0500 Subject: [PATCH 1/5] class names added to the documentation --- pyart/retrieve/echo_class.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/pyart/retrieve/echo_class.py b/pyart/retrieve/echo_class.py index ac19ce5e826..121169313be 100644 --- a/pyart/retrieve/echo_class.py +++ b/pyart/retrieve/echo_class.py @@ -643,6 +643,16 @@ def hydroclass_semisupervised( ------- hydro : dict Hydrometeor classification field. + - 0: Not classified + - 1: Aggregates (large snowflakes or ice particles) + - 2: Ice crystals + - 3: Light rain + - 4: Rimed particles (ice particles coated with supercooled water) + - 5: Rain + - 6: Vertically oriented ice + - 7: Wet snow + - 8: Melting hail + - 9: Dry hail or high-density graupel References ---------- @@ -660,8 +670,8 @@ def hydroclass_semisupervised( If the radar frequency information is missing from the radar object, you can add it in `radar.instrument_parameters`, as follows: - .. code-block:: python + .. code-block:: python radar.instrument_parameters["frequency"] = { "long_name": "Radar frequency", "units": "Hz", From 82a8c63b702c2ef842570a9b218aded49e237d43 Mon Sep 17 00:00:00 2001 From: Bhupendra Raut Date: Thu, 22 Aug 2024 15:35:06 -0500 Subject: [PATCH 2/5] example added --- pyart/retrieve/echo_class.py | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/pyart/retrieve/echo_class.py b/pyart/retrieve/echo_class.py index 121169313be..a9e292581a1 100644 --- a/pyart/retrieve/echo_class.py +++ b/pyart/retrieve/echo_class.py @@ -642,12 +642,12 @@ def hydroclass_semisupervised( Returns ------- hydro : dict - Hydrometeor classification field. + Hydrometeor classification. - 0: Not classified - - 1: Aggregates (large snowflakes or ice particles) + - 1: Aggregates - 2: Ice crystals - 3: Light rain - - 4: Rimed particles (ice particles coated with supercooled water) + - 4: Rimed particles - 5: Rain - 6: Vertically oriented ice - 7: Wet snow @@ -661,6 +661,18 @@ def hydroclass_semisupervised( of polarimetric radar measurements: a semi-supervised approach, Atmos. Meas. Tech., 9, 4425-4445, doi:10.5194/amt-9-4425-2016, 2016 + USage + ----- + .. code-block:: python + hydro_class = pyart.retrieve.hydroclass_semisupervised( + radar, + refl_field="corrected_reflectivity", + zdr_field="corrected_differential_reflectivity", + kdp_field="specific_differential_phase", + rhv_field="uncorrected_cross_correlation_ratio", + temp_field="temperature", + ) + Notes ----- The default hydrometeor classification is valid for C-band radars. For X-band radars, From 00868bead9e8213fc9a5dd49f30e757b84a29e95 Mon Sep 17 00:00:00 2001 From: Bhupendra Raut Date: Thu, 22 Aug 2024 15:44:00 -0500 Subject: [PATCH 3/5] description --- pyart/retrieve/echo_class.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/pyart/retrieve/echo_class.py b/pyart/retrieve/echo_class.py index a9e292581a1..5975fb16d0f 100644 --- a/pyart/retrieve/echo_class.py +++ b/pyart/retrieve/echo_class.py @@ -612,8 +612,10 @@ def hydroclass_semisupervised( radar_freq=None, ): """ - Classifies precipitation echoes following the approach by Besic et al - (2016). + Classifies precipitation echoes following the approach by Besic et al (2016). + + The `hydroclass_semisupervised` function classifies polarimetric radar data into 9 hydrometeor types + using a semi-supervised approach (Besic et al., 2016). Parameters ---------- From 282e70697c03760288a58f0f65f33f7e0b9926bf Mon Sep 17 00:00:00 2001 From: Bhupendra Raut Date: Thu, 22 Aug 2024 15:46:32 -0500 Subject: [PATCH 4/5] description refined --- pyart/retrieve/echo_class.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pyart/retrieve/echo_class.py b/pyart/retrieve/echo_class.py index 5975fb16d0f..ee700e3b5af 100644 --- a/pyart/retrieve/echo_class.py +++ b/pyart/retrieve/echo_class.py @@ -612,10 +612,10 @@ def hydroclass_semisupervised( radar_freq=None, ): """ - Classifies precipitation echoes following the approach by Besic et al (2016). + Classifies precipitation echoes into hydrometeor types. - The `hydroclass_semisupervised` function classifies polarimetric radar data into 9 hydrometeor types - using a semi-supervised approach (Besic et al., 2016). + The `hydroclass_semisupervised` function classifies precipitation echoes in the polarimetric radar data + into 9 hydrometeor types using a semi-supervised approach (Besic et al., 2016). Parameters ---------- From 40eb68b15516686994a2e44f14b79fd5a34fef3e Mon Sep 17 00:00:00 2001 From: Bhupendra Raut Date: Thu, 22 Aug 2024 16:11:27 -0500 Subject: [PATCH 5/5] Corrected spelling/punctuations --- pyart/retrieve/echo_class.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyart/retrieve/echo_class.py b/pyart/retrieve/echo_class.py index ee700e3b5af..8057704ac22 100644 --- a/pyart/retrieve/echo_class.py +++ b/pyart/retrieve/echo_class.py @@ -663,7 +663,7 @@ def hydroclass_semisupervised( of polarimetric radar measurements: a semi-supervised approach, Atmos. Meas. Tech., 9, 4425-4445, doi:10.5194/amt-9-4425-2016, 2016 - USage + Usage ----- .. code-block:: python hydro_class = pyart.retrieve.hydroclass_semisupervised(