cloudnetpy 1.95.1__tar.gz → 1.95.3__tar.gz

{cloudnetpy-1.95.1/cloudnetpy.egg-info → cloudnetpy-1.95.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloudnetpy
-Version: 1.95.1
+Version: 1.95.3
 Summary: Python package for Cloudnet processing
 Author: Simo Tukiainen
 License: MIT License

{cloudnetpy-1.95.1 → cloudnetpy-1.95.3}/cloudnetpy/categorize/model.py

@@ -101,6 +101,8 @@ class Model(DataSource):
         """
         half_height = height_grid - np.diff(height_grid, prepend=self.alt_site) / 2
         for key in self.fields_dense + self.fields_atten:
+            if key not in self.data_sparse:
+                continue
             array = self.data_sparse[key][:]
             valid_profiles = _find_number_of_valid_profiles(array)
             if valid_profiles < 2:

{cloudnetpy-1.95.1 → cloudnetpy-1.95.3}/cloudnetpy/instruments/kazr.py

@@ -39,6 +39,13 @@ KEYMAP_CFR = {
     "signal_to_noise_ratio_crosspolar_v": "SNRx",
 }
 
+# Same format with short SNR names (e.g. olikazrgeM1.a1)
+KEYMAP_CFR_SHORT = {
+    **{k: v for k, v in KEYMAP_CFR.items() if v not in ("SNR", "SNRx")},
+    "snr_copol": "SNR",
+    "snr_xpol": "SNRx",
+}
+
 # KAZR moments (e.g. sgpkazrgeC1.a1) and corrected moments (sgpkazrcorgeC1.c1)
 KEYMAP_COR = {
     "reflectivity_copol": "Zh",
@@ -66,7 +73,8 @@ def kazr2nc(
     screened using the ARM significant detection mask and LDR is calculated
     from the cross- and co-polar reflectivities. LDR is screened using the
     cross-polar SNR and removed completely if the cross-polar channel is found
-    unreliable. Velocities of the non-corrected formats are dealiased using
+    unreliable. Stationary clutter layers (zero velocity and spectral width)
+    are removed. Velocities of the non-corrected formats are dealiased using
     velocity continuity.
 
     Args:
@@ -105,6 +113,7 @@ def kazr2nc(
     kazr.screen_ldr()
     kazr.correct_ldr_leakage()
     kazr.screen_noise(snr_limit)
+    kazr.screen_stationary_clutter()
     kazr.dealias_velocity()
     kazr.add_correction_bits()
     kazr.mask_invalid_data()
@@ -187,6 +196,46 @@ class Kazr(CloudnetInstrument):
             if cloudnet_array.data.ndim == 2:
                 cloudnet_array.mask_indices(is_noise)
 
+    def screen_stationary_clutter(
+        self,
+        v_lim: float = 0.03,
+        width_lim: float = 0.05,
+        min_fraction: float = 0.05,
+    ) -> None:
+        """Masks stationary clutter layers.
+
+        Some KAZRs (e.g. Oliktok 2015-2019) show persistent echoes with zero
+        Doppler velocity and minimal spectral width in fixed range gates, also
+        well above the ground (1.5-2 km at Oliktok). Pixels with near-zero
+        velocity and width are masked in range gates where such pixels are
+        found in at least `min_fraction` of the profiles. Real hydrometeors
+        with zero velocity have larger spectral width due to turbulence.
+        """
+        if "width" not in self.data:
+            return
+        v = self.data["v"][:]
+        width = self.data["width"][:]
+        is_stationary = ma.filled(
+            (ma.abs(v) < v_lim) & (width < width_lim), fill_value=False
+        )
+        fraction = np.mean(is_stationary, axis=0)
+        is_clutter = is_stationary & (fraction >= min_fraction)
+        if not np.any(is_clutter):
+            return
+        gates = np.nonzero(fraction >= min_fraction)[0]
+        height = self.data["range"].data
+        logging.info(
+            "Masking stationary clutter in %s range gates (%.0f-%.0f m)",
+            len(gates),
+            height[gates[0]],
+            height[gates[-1]],
+        )
+        is_valid = ~ma.getmaskarray(self.data["Zh"][:]) & ~is_clutter
+        is_valid = utils.remove_small_objects(is_valid, max_size=20, connectivity=2)
+        for cloudnet_array in self.data.values():
+            if cloudnet_array.data.ndim == 2:
+                cloudnet_array.mask_indices(~is_valid)
+
     def dealias_velocity(self) -> None:
         """Unfolds aliased Doppler velocities using continuity."""
         if self.corrected:
@@ -282,6 +331,8 @@ class Kazr(CloudnetInstrument):
     def _init_metadata(self, nc: netCDF4.Dataset) -> None:
         if "reflectivity" in nc.variables:
             self.keymap = KEYMAP_CFR
+            if "snr_copol" in nc.variables:
+                self.keymap = KEYMAP_CFR_SHORT
         elif "reflectivity_copol" in nc.variables:
             self.keymap = KEYMAP_COR
             self.corrected = "significant_detection_mask" in nc.variables

{cloudnetpy-1.95.1 → cloudnetpy-1.95.3}/cloudnetpy/plotting/plotting.py

@@ -1293,6 +1293,7 @@ def _get_max_gap_in_minutes(figure_data: FigureData) -> float:
         "radar": 5,
         "cpr-simulation": 60,
         "weather-radar": 20,
+        "iwc-weather-radar": 20,
     }
     return max_allowed_gap.get(file_type, 10)
 

cloudnetpy-1.95.3/cloudnetpy/products/iwc_weather_radar.py

@@ -0,0 +1,106 @@
+from os import PathLike
+from uuid import UUID
+
+import numpy as np
+from numpy import ma
+
+from cloudnetpy import output, utils
+from cloudnetpy.categorize.disdrometer import DataSource
+from cloudnetpy.categorize.model import Model
+from cloudnetpy.cloudnetarray import CloudnetArray
+from cloudnetpy.constants import T0
+from cloudnetpy.metadata import COMMON_ATTRIBUTES, MetaData
+
+
+def generate_iwc_from_weather_radar(
+    weather_radar_file: str | PathLike,
+    model_file: str | PathLike,
+    output_file: str | PathLike,
+    uuid: str | UUID | None = None,
+) -> UUID:
+    uuid = utils.get_uuid(uuid)
+    radar = WrRadar(weather_radar_file)
+    if radar.altitude is None:
+        msg = "Altitude is missing"
+        raise ValueError(msg)
+    if radar.height is None or radar.height_agl is None:
+        msg = "Height is missing"
+        raise ValueError(msg)
+    model = Model(model_file, radar.altitude)
+    model.interpolate_to_common_height()
+    model.interpolate_to_grid(radar.time, radar.height)
+
+    height_agl = radar.height_agl
+    z = radar.data["Z"][:]
+    v = radar.data["v"][:]
+    rho_hv = radar.data["rho_hv"][:]
+    temp = model.data_dense["temperature"]
+
+    is_noise = (height_agl < 3000) & (rho_hv < 0.8) & (z < -20)
+    is_ice = (z > -30) & (np.abs(v) < 2) & (temp < T0)
+    is_rain = (z > 10) & (v < 0) & (temp > T0 - 10)
+
+    output_data = {
+        "time": CloudnetArray(radar.time, "time"),
+        "height": CloudnetArray(radar.height, "height"),
+        "radar_frequency": CloudnetArray(radar.radar_frequency, "radar_frequency"),
+    }
+
+    z_rain = ma.masked_where(is_noise | ~is_rain, z)
+    rainfall_rate = (utils.db2lin(z_rain) / 200) ** 0.625  # Marshall-Palmer
+    output_data["rainfall_rate"] = CloudnetArray(
+        rainfall_rate * 1e-3 / 3600, "rainfall_rate"
+    )
+
+    z_ice = ma.masked_where(is_noise | is_rain | ~is_ice, z)
+    iwc = ma.power(10, 0.060 * z_ice - 0.0197 * temp - 1.70)  # Hogan et al. (2006)
+    output_data["iwc"] = CloudnetArray(1000 * iwc, "iwc")
+
+    date = radar.get_date()
+    attributes = output.add_time_attribute(WEATHER_RADAR_RET_ATTRIBUTES, date)
+    output.update_attributes(output_data, attributes)
+
+    dimensions = {"time": len(radar.time), "height": len(radar.height)}
+    with output.init_file(output_file, dimensions, output_data, uuid) as nc:
+        nc.cloudnet_file_type = "iwc-weather-radar"
+        vars_from_source = (
+            "altitude",
+            "latitude",
+            "longitude",
+        )
+        output.copy_variables(radar.dataset, nc, vars_from_source)
+        output.copy_global(radar.dataset, nc, ("year", "month", "day", "location"))
+        nc.title = f"Ice water content (weather radar) retrieval from {radar.location}"
+        nc.source = "\n".join(sorted([radar.source, model.source]))
+        nc.source_file_uuids = output.get_source_uuids([radar, model])
+        output.merge_history(nc, nc.cloudnet_file_type, radar, (model,))
+
+    return uuid
+
+
+class WrRadar(DataSource):
+    def __init__(self, full_path: str | PathLike) -> None:
+        super().__init__(full_path, radar=True)
+        self.radar_frequency = float(self.getvar("radar_frequency"))
+        self.location = getattr(self.dataset, "location", "")
+        self._init_data()
+
+    def _init_data(self) -> None:
+        self.append_data(self.getvar("Zh"), "Z", units="dBZ")
+        self.append_data(self.getvar("v"), "v")
+        self.append_data(self.getvar("rho_hv"), "rho_hv")
+
+
+WEATHER_RADAR_RET_ATTRIBUTES = {
+    "height": COMMON_ATTRIBUTES["height"]._replace(dimensions=("height",)),
+    "iwc": MetaData(
+        long_name="Ice water content",
+        units="kg m-3",
+        dimensions=("time", "height"),
+    ),
+    "rainfall_rate": MetaData(
+        long_name="Rainfall rate",
+        units="m s-1",
+        dimensions=("time", "height"),
+    ),
+}

{cloudnetpy-1.95.1 → cloudnetpy-1.95.3}/cloudnetpy/version.py

@@ -1,4 +1,4 @@
 MAJOR = 1
 MINOR = 95
-PATCH = 1
+PATCH = 3
 __version__ = f"{MAJOR}.{MINOR}.{PATCH}"

{cloudnetpy-1.95.1 → cloudnetpy-1.95.3/cloudnetpy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloudnetpy
-Version: 1.95.1
+Version: 1.95.3
 Summary: Python package for Cloudnet processing
 Author: Simo Tukiainen
 License: MIT License

{cloudnetpy-1.95.1 → cloudnetpy-1.95.3}/cloudnetpy.egg-info/SOURCES.txt

@@ -137,6 +137,7 @@ cloudnetpy/products/epsilon_lidar.py
 cloudnetpy/products/epsilon_radar.py
 cloudnetpy/products/ier.py
 cloudnetpy/products/iwc.py
+cloudnetpy/products/iwc_weather_radar.py
 cloudnetpy/products/lwc.py
 cloudnetpy/products/mie_lu_tables.nc
 cloudnetpy/products/mwr_tools.py