Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated Documentation for retrieve/hydroclass_semisupervised function #1616

Merged
merged 5 commits into from
Aug 27, 2024
Merged

Updated Documentation for retrieve/hydroclass_semisupervised function #1616

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
aa578b6
class names added to the documentation
RBhupi Aug 22, 2024
82a8c63
example added
RBhupi Aug 22, 2024
00868be
description
RBhupi Aug 22, 2024
282e706
description refined
RBhupi Aug 22, 2024
40eb68b
Corrected spelling/punctuations
RBhupi Aug 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 28 additions & 4 deletions pyart/retrieve/echo_class.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -612,8 +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 precipitation echoes in the polarimetric radar data
into 9 hydrometeor types using a semi-supervised approach (Besic et al., 2016).

Parameters
----------
Expand Down Expand Up @@ -642,7 +644,17 @@ def hydroclass_semisupervised(
Returns
-------
hydro : dict
Hydrometeor classification field.
Hydrometeor classification.
- 0: Not classified
- 1: Aggregates
- 2: Ice crystals
- 3: Light rain
- 4: Rimed particles
- 5: Rain
- 6: Vertically oriented ice
- 7: Wet snow
- 8: Melting hail
- 9: Dry hail or high-density graupel

References
----------
Expand All @@ -651,6 +663,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,
Expand All @@ -660,8 +684,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",
Expand Down