doppy 0.3.0__cp310-abi3-macosx_11_0_arm64.whl → 0.3.2__cp310-abi3-macosx_11_0_arm64.whl

doppy/product/stare.py

@@ -29,6 +29,28 @@ class Stare:
     wavelength: float
     system_id: str
 
+    def __getitem__(
+        self,
+        index: int
+        | slice
+        | list[int]
+        | npt.NDArray[np.int64]
+        | npt.NDArray[np.bool_]
+        | tuple[slice, slice],
+    ) -> Stare:
+        if isinstance(index, (int, slice, list, np.ndarray)):
+            return Stare(
+                time=self.time[index],
+                radial_distance=self.radial_distance,
+                elevation=self.elevation[index],
+                beta=self.beta[index],
+                radial_velocity=self.radial_velocity[index],
+                mask=self.mask[index],
+                wavelength=self.wavelength,
+                system_id=self.system_id,
+            )
+        raise TypeError
+
     @classmethod
     def from_halo_data(
         cls,

doppy/product/stare_depol.py

@@ -1,9 +1,18 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from io import BufferedIOBase
+from pathlib import Path
+from typing import Sequence
+
 import numpy as np
 import numpy.typing as npt
 
+from doppy import options
 from doppy.product.stare import Stare
 
 
+@dataclass
 class StareDepol:
     """
     Stare product with depolarisation ratio derived from co-polarised and
@@ -21,6 +30,9 @@ class StareDepol:
     beta
         An array of backscatter coefficients for the co-polarised signal, in
         sr-1 m-1.
+    beta_cross
+        An array of backscatter coefficients for the cross-polarised signal, in
+        sr-1 m-1.
     radial_velocity
         An array of radial velocities of the co-polarised signal, in m s-1.
     mask
@@ -33,26 +45,55 @@ class StareDepol:
     system_id
         A string identifier for the lidar.
 
+
     Raises
     ------
     ValueError
         If the input `co` and `cross` products have mismatched wavelengths,
         system IDs, radial distances, or elevation angles, this exception is
         raised.
+
+
+    References
+    ----------
+    Aerosol particle depolarization ratio at 1565 nm measured with a Halo Doppler lidar
+        authors: Ville Vakkari, Holger Baars, Stephanie Bohlmann, Johannes Bühl,
+            Mika Komppula, Rodanthi-Elisavet Mamouri, and Ewan James O'Connor
+        doi: https://doi.org/10.5194/acp-21-5807-2021
     """
 
     time: npt.NDArray[np.datetime64]
     radial_distance: npt.NDArray[np.float64]
     elevation: npt.NDArray[np.float64]
     beta: npt.NDArray[np.float64]
+    beta_cross: npt.NDArray[np.float64]
     radial_velocity: npt.NDArray[np.float64]
     mask: npt.NDArray[np.bool_]
     depolarisation: npt.NDArray[np.float64]
+    mask_depolarisation: npt.NDArray[np.bool_]
+    mask_beta_cross: npt.NDArray[np.bool_]
+    polariser_bleed_through: float
     wavelength: float
     system_id: str
 
-    def __init__(self, co: Stare, cross: Stare):
-        if co.wavelength != cross.wavelength:
+    def __init__(
+        self,
+        co: Stare,
+        cross: Stare,
+        polariser_bleed_through: float = 0.0,
+    ):
+        """
+        Parameters
+        ----------
+        co: Stare
+            The co-polarised data.
+        cross: Stare
+            The cross-polarised data. The `cross.time` array is expected to be sorted.
+        polariser_bleed_through: float, default=0.0
+            The amount of bleed-through from the polariser.
+        """
+
+        if not np.isclose(co.wavelength, cross.wavelength):
             raise ValueError(
                 "Different wavelength in co and cross: "
                 f"{co.wavelength} vs {cross.wavelength}"
@@ -62,22 +103,78 @@ class StareDepol:
                 "Different system ID in co and cross: "
                 f"{co.system_id} vs {cross.system_id}"
             )
-        if not np.allclose(co.radial_distance, cross.radial_distance):
+        if not np.allclose(co.radial_distance, cross.radial_distance, atol=1):
             raise ValueError("Different radial distance in co and cross")
 
-        time_ind = np.argmin(np.abs(co.time - cross.time[:, np.newaxis]), axis=0)
-        cross_elevation = cross.elevation[time_ind]
-        cross_beta = cross.beta[time_ind, :]
+        if co.beta.shape[1] != cross.beta.shape[1]:
+            raise ValueError(
+                "Range dimension mismatch in co and cross: "
+                f"{co.beta.shape[1]} vs {cross.beta.shape[1]}"
+            )
+
+        ind = np.searchsorted(cross.time, co.time, side="left")
+        pick_ind = ind < len(cross.time)
+        time_diff_threshold = 2 * np.median(np.diff(co.time))
+        co_cross_timediff_below_threshold = (
+            cross.time[ind[pick_ind]] - co.time[pick_ind] < time_diff_threshold
+        )
+        pick_ind[pick_ind] &= co_cross_timediff_below_threshold
 
-        if not np.allclose(co.elevation, cross_elevation):
+        if not np.allclose(
+            co.elevation[pick_ind], cross.elevation[ind[pick_ind]], atol=1
+        ):
             raise ValueError("Different elevation in co and cross")
 
+        depolarisation = np.full_like(co.beta, np.nan)
+        co_beta = co.beta[pick_ind]
+        depolarisation[pick_ind] = (
+            cross.beta[ind[pick_ind]] - polariser_bleed_through * co_beta
+        ) / co_beta
+        cross_beta = np.full_like(co.beta, np.nan)
+        cross_beta[pick_ind] = cross.beta[ind[pick_ind]]
+
         self.time = co.time
         self.radial_distance = co.radial_distance
         self.elevation = co.elevation
         self.beta = co.beta
+        self.beta_cross = cross_beta
         self.radial_velocity = co.radial_velocity
         self.mask = co.mask
-        self.depolarisation = cross_beta / co.beta
+        self.depolarisation = depolarisation
+        self.mask_depolarisation = np.isnan(depolarisation)
+        self.mask_beta_cross = np.isnan(self.beta_cross)
+        self.polariser_bleed_through = polariser_bleed_through
         self.wavelength = co.wavelength
         self.system_id = co.system_id
+
+    @classmethod
+    def from_halo_data(
+        cls,
+        co_data: Sequence[str]
+        | Sequence[Path]
+        | Sequence[bytes]
+        | Sequence[BufferedIOBase],
+        co_data_bg: Sequence[str]
+        | Sequence[Path]
+        | Sequence[tuple[bytes, str]]
+        | Sequence[tuple[BufferedIOBase, str]],
+        cross_data: Sequence[str]
+        | Sequence[Path]
+        | Sequence[bytes]
+        | Sequence[BufferedIOBase],
+        cross_data_bg: Sequence[str]
+        | Sequence[Path]
+        | Sequence[tuple[bytes, str]]
+        | Sequence[tuple[BufferedIOBase, str]],
+        bg_correction_method: options.BgCorrectionMethod,
+        polariser_bleed_through: float = 0,
+    ) -> StareDepol:
+        co = Stare.from_halo_data(
+            data=co_data, data_bg=co_data_bg, bg_correction_method=bg_correction_method
+        )
+        cross = Stare.from_halo_data(
+            data=cross_data,
+            data_bg=cross_data_bg,
+            bg_correction_method=bg_correction_method,
+        )
+        return cls(co, cross, polariser_bleed_through)

{doppy-0.3.0.dist-info → doppy-0.3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: doppy
-Version: 0.3.0
+Version: 0.3.2
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10

{doppy-0.3.0.dist-info → doppy-0.3.2.dist-info}/RECORD

@@ -1,13 +1,13 @@
-doppy-0.3.0.dist-info/METADATA,sha256=_RBIW8LjmfrQG1DiFhhtYM0P7nPta48JCzszwAPkueI,4146
-doppy-0.3.0.dist-info/WHEEL,sha256=8YVHbP9g43_6FVsydzNKX35DdPN9RlBfh4bOfODYltg,103
-doppy-0.3.0.dist-info/entry_points.txt,sha256=9b_Ca7vJoh6AwL3W8qAPh_UmJ_1Pa6hi-TDfCTDjvSk,43
-doppy-0.3.0.dist-info/license_files/LICENSE,sha256=V-0iroMNMI8ctnLgUau1kdFvwhkYhr9vi-5kWKxw2wc,1089
+doppy-0.3.2.dist-info/METADATA,sha256=3SJc4Ud6JiZQHAjBfekQaHIluO7nCU-YZeVwB3MTw9M,4146
+doppy-0.3.2.dist-info/WHEEL,sha256=GmPQBnUDZgDWUSmU3r_BHIfcmbjw_LVs138d_NT7BE4,103
+doppy-0.3.2.dist-info/entry_points.txt,sha256=9b_Ca7vJoh6AwL3W8qAPh_UmJ_1Pa6hi-TDfCTDjvSk,43
+doppy-0.3.2.dist-info/licenses/LICENSE,sha256=V-0iroMNMI8ctnLgUau1kdFvwhkYhr9vi-5kWKxw2wc,1089
 doppy/options.py,sha256=73BDODO4OYHn2qOshhwz6u6G3J1kNd3uj6P0a3V4HBE,205
 doppy/__init__.py,sha256=Z9aEUlbPRWRUAoB8_-djkgrJuS4-6pjem4-mVSB6Z9I,191
 doppy/product/wind.py,sha256=MXm5HDoO3X6AzvpPHYPlpUXB_MYp_TBPP81aZ151wj8,13043
 doppy/product/__init__.py,sha256=C6s9cX20m9UwRsKo1lZH6TnYFfM5KmsX5MPUyShbgl4,235
-doppy/product/stare_depol.py,sha256=wlRVQPcWm14b1Gy_poXSNP8dzGw1qKlgT0KJ3YAXyKA,2897
-doppy/product/stare.py,sha256=jt1vHptufBFwUH5Un_0pk44eHKbAWnkhrU7HUI7gYJ4,19908
+doppy/product/stare_depol.py,sha256=vvOSYWfxEuQTDlohB72szhGVqMCDYA3yNkMAaU9wcD0,6209
+doppy/product/stare.py,sha256=4eV9xBNE1IPaOBLOr_whqj-9nHVEDGSZZH_AeIdCiMo,20603
 doppy/bench.py,sha256=iVNYveMVGGRES2oe3Orsn31jQFCKTXOmxRFuFiJ8_OA,248
 doppy/netcdf.py,sha256=FX151GC8fuRhm-veg94BGeOWqszGn6nnWT9BxbzoSO8,3895
 doppy/utils.py,sha256=qPtIYBJPaKKTmRWwJI93TFUuhJg7CAoecpyHCm5ZyxI,214
@@ -25,5 +25,5 @@ doppy/raw/halo_bg.py,sha256=kO03yGlKS-DpMMGHYuy_BuidyeUL38TxT5vMn8H_8lE,4809
 doppy/raw/halo_hpl.py,sha256=YFTepAWXvIfAVGgLZCadsc1d-VaOh7j2RB3cpb6Sv6k,18486
 doppy/raw/windcube.py,sha256=ZaOswQJbVDPBYj5oU1pTYmsX8F-mKIbjJRZmLYEMXP0,9906
 doppy/__main__.py,sha256=zrKQJVj0k0ypBQCGK65Czt9G9FZ_qx3ussw6Q9VJ14g,346
-doppy/rs.abi3.so,sha256=_qOfbxDJ1ZioH82IcB4shWiLvmWwmUyfFJGjqR6lmKA,2566816
-doppy-0.3.0.dist-info/RECORD,,
+doppy/rs.abi3.so,sha256=FBKhzC6ZkjrSdxVPaPQQ4yf724NjlRLACxWo_z_-msw,2566816
+doppy-0.3.2.dist-info/RECORD,,

{doppy-0.3.0.dist-info → doppy-0.3.2.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (1.7.0)
+Generator: maturin (1.7.1)
 Root-Is-Purelib: false
 Tag: cp310-abi3-macosx_11_0_arm64