pywavelet 0.2.3__tar.gz → 0.2.4__tar.gz

{pywavelet-0.2.3 → pywavelet-0.2.4}/CHANGELOG.rst

@@ -5,6 +5,19 @@ CHANGELOG
 =========
 
 
+.. _changelog-v0.2.4:
+
+v0.2.4 (2025-01-24)
+===================
+
+Unknown
+-------
+
+* Merge branch 'main' of github.com:avivajpeyi/pywavelet into main (`d2c84d9`_)
+
+.. _d2c84d9: https://github.com/pywavelet/pywavelet/commit/d2c84d980b1701baf99e40ba6191cbd9336cfa59
+
+
 .. _changelog-v0.2.3:
 
 v0.2.3 (2025-01-24)
@@ -13,12 +26,21 @@ v0.2.3 (2025-01-24)
 Bug Fixes
 ---------
 
+* fix: add masks to filter out gaps (`26fe40a`_)
+
 * fix: add backend check for os.environ (`98c0818`_)
 
 * fix: add test for jax (`1940394`_)
 
+Chores
+------
+
+* chore(release): 0.2.3 (`d067461`_)
+
+.. _26fe40a: https://github.com/pywavelet/pywavelet/commit/26fe40ace80d5f9d598e1efeba2f8ca4a6f1043b
 .. _98c0818: https://github.com/pywavelet/pywavelet/commit/98c0818078190d829a23734f932f1f93c9932167
 .. _1940394: https://github.com/pywavelet/pywavelet/commit/194039437a3a9b3ada303d101b4e2573ab7d0afd
+.. _d067461: https://github.com/pywavelet/pywavelet/commit/d0674615df328774a0d80eb224b5c503fbd8f332
 
 
 .. _changelog-v0.2.2:

{pywavelet-0.2.3 → pywavelet-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pywavelet
-Version: 0.2.3
+Version: 0.2.4
 Summary: WDM wavelet transform your time/freq series!
 Author-email: Pywavelet Team <avi.vajpeyi@gmail.com>
 Project-URL: Homepage, https://pywavelet.github.io/pywavelet/

{pywavelet-0.2.3 → pywavelet-0.2.4}/src/pywavelet/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.2.3'
-__version_tuple__ = version_tuple = (0, 2, 3)
+__version__ = version = '0.2.4'
+__version_tuple__ = version_tuple = (0, 2, 4)

{pywavelet-0.2.3 → pywavelet-0.2.4}/src/pywavelet/types/wavelet.py

@@ -1,6 +1,7 @@
 from typing import List, Tuple
 
 import matplotlib.pyplot as plt
+import numpy as np
 
 from .common import fmt_timerange, is_documented_by, xp
 from .plotting import plot_wavelet_grid, plot_wavelet_trend
@@ -343,14 +344,18 @@ class Wavelet:
 
     def __mul__(self, other):
         """Element-wise multiplication of two Wavelet objects."""
-        if isinstance(other, Wavelet):
-            return Wavelet(
-                data=self.data * other.data, time=self.time, freq=self.freq
-            )
+        if isinstance(other, WaveletMask):
+            data = self.data.copy()
+            data[~other.mask] = np.nan
+            return Wavelet(data=data, time=self.time, freq=self.freq)
         elif isinstance(other, float):
             return Wavelet(
                 data=self.data * other, time=self.time, freq=self.freq
             )
+        elif isinstance(other, WaveletMask):
+            return Wavelet(
+                data=self.data * other.data, time=self.time, freq=self.freq
+            )
 
     def __truediv__(self, other):
         """Element-wise division of two Wavelet objects."""
@@ -445,11 +450,40 @@ class WaveletMask(Wavelet):
         return rpr
 
     @classmethod
-    def from_frange(
-        cls, time_grid: xp.ndarray, freq_grid: xp.ndarray, frange: List[float]
+    def from_restrictions(
+        cls,
+        time_grid: xp.ndarray,
+        freq_grid: xp.ndarray,
+        frange: List[float],
+        tgaps: List[Tuple[float, float]] = [],
     ):
+        """
+        Create a WaveletMask object from restrictions on time and frequency.
+
+        Parameters
+        ----------
+        time_grid : xp.ndarray
+            Array of time points.
+        freq_grid : xp.ndarray
+            Array of corresponding frequency points.
+        frange : List[float]
+            Frequency range to include.
+        tgaps : List[Tuple[float, float]]
+            List of time gaps to exclude.
+
+        Returns
+        -------
+        WaveletMask
+            A WaveletMask object with the specified restrictions.
+        """
         self = cls.zeros_from_grid(time_grid, freq_grid)
         self.data[
             (freq_grid >= frange[0]) & (freq_grid <= frange[1]), :
         ] = True
+
+        for tgap in tgaps:
+            self.data[
+                :, (time_grid >= tgap[0]) & (time_grid <= tgap[1])
+            ] = False
+        self.data = self.data.astype(bool)
         return self

{pywavelet-0.2.3 → pywavelet-0.2.4}/src/pywavelet.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pywavelet
-Version: 0.2.3
+Version: 0.2.4
 Summary: WDM wavelet transform your time/freq series!
 Author-email: Pywavelet Team <avi.vajpeyi@gmail.com>
 Project-URL: Homepage, https://pywavelet.github.io/pywavelet/

{pywavelet-0.2.3 → pywavelet-0.2.4}/tests/test_mask.py

@@ -13,25 +13,26 @@ def test_mask(plot_dir):
     psd = Wavelet(np.ones((h.Nf, h.Nt)), h.time, h.freq)
     assert compute_likelihood(d, h, psd) == 0
 
-    mask = WaveletMask.from_frange(h.time, h.freq, [f0 - 0.5, f0 + 0.5])
+    mask = WaveletMask.from_restrictions(h.time, h.freq, [f0 - 0.5, f0 + 0.5])
+    dmasked = d * mask
     assert np.isclose(compute_likelihood(d, h, psd, mask), 0)
+    assert np.isclose(compute_likelihood(dmasked, h, psd), 0)
+    # number of nans in dmasked.data
+    assert np.isnan(dmasked.data).sum() != 0
 
-    mask1 = WaveletMask.from_frange(h.time, h.freq, [f0 + 0.5, f0 + 1.5])
+    mask1 = WaveletMask.from_restrictions(
+        h.time, h.freq, [f0 + 0.5, f0 + 1.5], tgaps=[[1.7 * 60, 3.4 * 60]]
+    )
+    dmasked1 = d * mask1
     # assert np.isclose(compute_likelihood(d, h, psd_analysis, mask1), 0) == False
 
     # plt the 3 differnet datasets
     fig, axes = plt.subplots(1, 3, figsize=(12, 4), sharex=True, sharey=True)
-    kwgs = dict(
-        cmap="viridis",
-        aspect="auto",
-        origin="lower",
-        extent=[d.time[0], d.time[-1], d.freq[0], d.freq[-1]],
-    )
-    axes[0].imshow(d.data, **kwgs)
+    d.plot(ax=axes[0])
     axes[0].set_title("data")
-    axes[1].imshow(d.data * mask.mask, **kwgs)
+    (d * mask).plot(ax=axes[1])
     axes[1].set_title("data*mask[f0-0.5, f0+0.5]")
-    axes[2].imshow(d.data * mask1.mask, **kwgs)
+    (d * mask1).plot(ax=axes[2])
     axes[2].set_title("data*mask[f0+0.5, f0+1.5]")
     plt.tight_layout()
     fig.savefig(f"{plot_dir}/test_mask.png")