cloudnetpy 1.95.2__tar.gz → 1.95.3__tar.gz

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

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

{cloudnetpy-1.95.2 → 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.2 → cloudnetpy-1.95.3}/cloudnetpy/version.py

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

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

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