cloudnetpy 1.83.1__tar.gz → 1.84.0__tar.gz

{cloudnetpy-1.83.1/cloudnetpy.egg-info → cloudnetpy-1.84.0}/PKG-INFO

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

{cloudnetpy-1.83.1 → cloudnetpy-1.84.0}/cloudnetpy/categorize/categorize.py

@@ -93,7 +93,7 @@ def generate_categorize(
         if data.disdrometer is not None:
             data.disdrometer.interpolate_to_grid(time)
         if data.mwr is not None:
-            data.mwr.rebin_to_grid(time)
+            data.mwr.interpolate_to_grid(time)
         data.model.calc_attenuations(data.radar.radar_frequency)
         data.model.interpolate_to_common_height()
         model_gap_ind = data.model.interpolate_to_grid(time, height)

cloudnetpy-1.84.0/cloudnetpy/categorize/disdrometer.py

@@ -0,0 +1,37 @@
+"""Mwr module, containing the :class:`Mwr` class."""
+
+from os import PathLike
+
+import numpy.typing as npt
+
+from cloudnetpy.datasource import DataSource
+from cloudnetpy.exceptions import DisdrometerDataError
+from cloudnetpy.utils import interpolate_1d
+
+
+class Disdrometer(DataSource):
+    """Disdrometer class, child of DataSource.
+
+    Args:
+    ----
+         full_path: Cloudnet Level 1b disdrometer file.
+
+    """
+
+    def __init__(self, full_path: str | PathLike) -> None:
+        super().__init__(full_path)
+        self._init_rainfall_rate()
+
+    def interpolate_to_grid(self, time_grid: npt.NDArray) -> None:
+        for key, array in self.data.items():
+            self.data[key].data = interpolate_1d(
+                self.time, array.data, time_grid, max_time=1
+            )
+
+    def _init_rainfall_rate(self) -> None:
+        keys = ("rainfall_rate", "n_particles")
+        for key in keys:
+            if key not in self.dataset.variables:
+                msg = f"variable {key} is missing"
+                raise DisdrometerDataError(msg)
+            self.append_data(self.dataset.variables[key][:], key)

{cloudnetpy-1.83.1 → cloudnetpy-1.84.0}/cloudnetpy/categorize/lidar.py

@@ -4,12 +4,11 @@ import logging
 from os import PathLike
 from typing import Literal
 
-import numpy as np
 import numpy.typing as npt
 from numpy import ma
 
 from cloudnetpy.datasource import DataSource
-from cloudnetpy.utils import interpolate_2d_nearest
+from cloudnetpy.utils import get_gap_ind, interpolate_2d_nearest
 
 
 class Lidar(DataSource):
@@ -70,13 +69,3 @@ class Lidar(DataSource):
         self.append_data(float(self.getvar("wavelength")), "lidar_wavelength")
         self.append_data(0.5, "beta_error")
         self.append_data(3.0, "beta_bias")
-
-
-def get_gap_ind(
-    grid: npt.NDArray, new_grid: npt.NDArray, threshold: float
-) -> list[int]:
-    return [
-        ind
-        for ind, value in enumerate(new_grid)
-        if np.min(np.abs(grid - value)) > threshold
-    ]

{cloudnetpy-1.83.1 → cloudnetpy-1.84.0}/cloudnetpy/categorize/mwr.py

@@ -8,6 +8,7 @@ import numpy.typing as npt
 from cloudnetpy import utils
 from cloudnetpy.constants import G_TO_KG
 from cloudnetpy.datasource import DataSource
+from cloudnetpy.utils import interpolate_1d
 
 
 class Mwr(DataSource):
@@ -23,15 +24,11 @@ class Mwr(DataSource):
         self._init_lwp_data()
         self._init_lwp_error()
 
-    def rebin_to_grid(self, time_grid: npt.NDArray) -> None:
-        """Approximates lwp and its error in a grid using mean.
-
-        Args:
-            time_grid: 1D target time grid.
-
-        """
-        for array in self.data.values():
-            array.rebin_data(self.time, time_grid)
+    def interpolate_to_grid(self, time_grid: npt.NDArray, max_time: float = 1) -> None:
+        for key, array in self.data.items():
+            self.data[key].data = interpolate_1d(
+                self.time, array.data, time_grid, max_time=max_time
+            )
 
     def _init_lwp_data(self) -> None:
         lwp = self.dataset.variables["lwp"][:]

{cloudnetpy-1.83.1 → cloudnetpy-1.84.0}/cloudnetpy/utils.py

@@ -3,6 +3,7 @@
 import base64
 import datetime
 import hashlib
+import logging
 import os
 import re
 import textwrap
@@ -17,7 +18,12 @@ import numpy as np
 import numpy.typing as npt
 from numpy import ma
 from scipy import ndimage, stats
-from scipy.interpolate import RectBivariateSpline, RegularGridInterpolator, griddata
+from scipy.interpolate import (
+    RectBivariateSpline,
+    RegularGridInterpolator,
+    griddata,
+    interp1d,
+)
 
 from cloudnetpy.cloudnetarray import CloudnetArray
 from cloudnetpy.constants import SEC_IN_DAY, SEC_IN_HOUR, SEC_IN_MINUTE
@@ -413,6 +419,55 @@ def interpolate_2d_nearest(
     return fun((xx, yy)).T
 
 
+def interpolate_1d(
+    time: npt.NDArray, y: ma.MaskedArray, time_new: npt.NDArray, max_time: float
+) -> npt.NDArray:
+    """1D linear interpolation preserving the mask.
+
+    Args:
+        time: 1D array in fraction hour.
+        y: 1D masked array, data values.
+        time_new: 1D array, new time coordinates.
+        max_time: Maximum allowed gap in minutes. Values outside this gap will
+            be masked.
+    """
+    if np.max(time) > 24 or np.min(time) < 0:
+        msg = "Time vector must be in fraction hours between 0 and 24"
+        raise ValueError(msg)
+    if ma.is_masked(y):
+        if y.mask.all():
+            return ma.masked_all(time_new.shape)
+        time = time[~y.mask]
+        y = y[~y.mask]
+    fun = interp1d(time, y, fill_value=(y[0], y[-1]), bounds_error=False)
+    interpolated = ma.array(fun(time_new))
+    bad_idx = get_gap_ind(time, time_new, max_time / 60)
+
+    if len(bad_idx) > 0:
+        msg = f"Unable to interpolate for {len(bad_idx)} time steps"
+        logging.warning(msg)
+        interpolated[bad_idx] = ma.masked
+
+    return interpolated
+
+
+def get_gap_ind(
+    grid: npt.NDArray, new_grid: npt.NDArray, threshold: float
+) -> list[int]:
+    """Finds indices in new_grid that are too far from grid."""
+    if grid.size == 0:
+        return list(range(len(new_grid)))
+    idxs = np.searchsorted(grid, new_grid)
+    left_dist = np.where(idxs > 0, np.abs(new_grid - grid[idxs - 1]), np.inf)
+    right_dist = np.where(
+        idxs < len(grid),
+        np.abs(new_grid - grid[np.clip(idxs, 0, len(grid) - 1)]),
+        np.inf,
+    )
+    nearest = np.minimum(left_dist, right_dist)
+    return np.where(nearest > threshold)[0].tolist()
+
+
 def calc_relative_error(reference: npt.NDArray, array: npt.NDArray) -> npt.NDArray:
     """Calculates relative error (%)."""
     return ((array - reference) / reference) * 100

{cloudnetpy-1.83.1 → cloudnetpy-1.84.0}/cloudnetpy/version.py

@@ -1,4 +1,4 @@
 MAJOR = 1
-MINOR = 83
-PATCH = 1
+MINOR = 84
+PATCH = 0
 __version__ = f"{MAJOR}.{MINOR}.{PATCH}"

{cloudnetpy-1.83.1 → cloudnetpy-1.84.0/cloudnetpy.egg-info}/PKG-INFO

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

cloudnetpy-1.83.1/cloudnetpy/categorize/disdrometer.py

@@ -1,60 +0,0 @@
-"""Mwr module, containing the :class:`Mwr` class."""
-
-import logging
-from os import PathLike
-
-import numpy as np
-import numpy.typing as npt
-from numpy import ma
-from scipy.interpolate import interp1d
-
-from cloudnetpy.categorize.lidar import get_gap_ind
-from cloudnetpy.datasource import DataSource
-from cloudnetpy.exceptions import DisdrometerDataError
-
-
-class Disdrometer(DataSource):
-    """Disdrometer class, child of DataSource.
-
-    Args:
-    ----
-         full_path: Cloudnet Level 1b disdrometer file.
-
-    """
-
-    def __init__(self, full_path: str | PathLike) -> None:
-        super().__init__(full_path)
-        self._init_rainfall_rate()
-
-    def interpolate_to_grid(self, time_grid: npt.NDArray) -> None:
-        for key, array in self.data.items():
-            self.data[key].data = self._interpolate(array.data, time_grid)
-
-    def _init_rainfall_rate(self) -> None:
-        keys = ("rainfall_rate", "n_particles")
-        for key in keys:
-            if key not in self.dataset.variables:
-                msg = f"variable {key} is missing"
-                raise DisdrometerDataError(msg)
-            self.append_data(self.dataset.variables[key][:], key)
-
-    def _interpolate(self, y: ma.MaskedArray, x_new: npt.NDArray) -> npt.NDArray:
-        time = self.time
-        mask = ma.getmask(y)
-        if mask is not ma.nomask:
-            if np.all(mask):
-                return ma.masked_all(x_new.shape)
-            not_masked = ~mask
-            y = y[not_masked]
-            time = time[not_masked]
-        fun = interp1d(time, y, fill_value="extrapolate")
-        interpolated_array = ma.array(fun(x_new))
-        max_time = 1 / 60  # min -> fraction hour
-        mask_ind = get_gap_ind(time, x_new, max_time)
-
-        if len(mask_ind) > 0:
-            msg = f"Unable to interpolate disdrometer for {len(mask_ind)} time steps"
-            logging.warning(msg)
-            interpolated_array[mask_ind] = ma.masked
-
-        return interpolated_array