pywavelet 0.1.0__tar.gz → 0.1.2__tar.gz

{pywavelet-0.1.0 → pywavelet-0.1.2}/CHANGELOG.rst

@@ -5,16 +5,60 @@ CHANGELOG
 =========
 
 
+.. _changelog-v0.1.2:
+
+v0.1.2 (2025-01-20)
+===================
+
+Bug Fixes
+---------
+
+* fix: adjust the WaveletMask repr (`50c6201`_)
+
+.. _50c6201: https://github.com/pywavelet/pywavelet/commit/50c6201efb7689dd9757a5e4c6047d241015cb96
+
+
+.. _changelog-v0.1.1:
+
+v0.1.1 (2025-01-16)
+===================
+
+Chores
+------
+
+* chore(release): 0.1.1 (`bd15453`_)
+
+Unknown
+-------
+
+* Merge branch 'main' of github.com:avivajpeyi/pywavelet into main (`69eefa2`_)
+
+.. _bd15453: https://github.com/pywavelet/pywavelet/commit/bd15453e028705548232b802b2d21bbebd307ca7
+.. _69eefa2: https://github.com/pywavelet/pywavelet/commit/69eefa29b7873c30fcb74ad1e051eb20101a277a
+
+
 .. _changelog-v0.1.0:
 
 v0.1.0 (2025-01-15)
 ===================
 
+Bug Fixes
+---------
+
+* fix: refactor type outside transforms (`efb8878`_)
+
+Chores
+------
+
+* chore(release): 0.1.0 (`c5a3fde`_)
+
 Features
 --------
 
 * feat: add wavelet mask and more tests (`e009903`_)
 
+.. _efb8878: https://github.com/pywavelet/pywavelet/commit/efb88789f8468ff18f99abaf6168bb8fc0f5947b
+.. _c5a3fde: https://github.com/pywavelet/pywavelet/commit/c5a3fdea455c16478f04049f14bc35dfcf4efb15
 .. _e009903: https://github.com/pywavelet/pywavelet/commit/e00990300d9c013438580c2bc47ea93570fd95be
 
 

{pywavelet-0.1.0 → pywavelet-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pywavelet
-Version: 0.1.0
+Version: 0.1.2
 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.1.0 → pywavelet-0.1.2}/src/pywavelet/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.1.0'
-__version_tuple__ = version_tuple = (0, 1, 0)
+__version__ = version = '0.1.2'
+__version_tuple__ = version_tuple = (0, 1, 2)

{pywavelet-0.1.0 → pywavelet-0.1.2}/src/pywavelet/logger.py

@@ -1,11 +1,15 @@
+import logging
 import sys
 import warnings
+
 from rich.logging import RichHandler
-import logging
 
 FORMAT = "%(message)s"
 logging.basicConfig(
-    level="INFO", format=FORMAT, datefmt="[%X]", handlers=[RichHandler(rich_tracebacks=True)]
+    level="INFO",
+    format=FORMAT,
+    datefmt="[%X]",
+    handlers=[RichHandler(rich_tracebacks=True)],
 )
 
 logger = logging.getLogger("pywavelet")

{pywavelet-0.1.0 → pywavelet-0.1.2}/src/pywavelet/transforms/__init__.py

@@ -1,4 +1,4 @@
-from .forward import from_freq_to_wavelet, from_time_to_wavelet, compute_bins
+from .forward import from_freq_to_wavelet, from_time_to_wavelet
 from .inverse import from_wavelet_to_freq, from_wavelet_to_time
 
 __all__ = [
@@ -6,5 +6,4 @@ __all__ = [
     "from_wavelet_to_freq",
     "from_time_to_wavelet",
     "from_freq_to_wavelet",
-    "compute_bins",
 ]

pywavelet-0.1.2/src/pywavelet/transforms/forward/__init__.py

@@ -0,0 +1,3 @@
+from .main import from_freq_to_wavelet, from_time_to_wavelet
+
+__all__ = ["from_time_to_wavelet", "from_freq_to_wavelet"]

{pywavelet-0.1.0 → pywavelet-0.1.2}/src/pywavelet/transforms/forward/from_freq.py

@@ -1,8 +1,10 @@
 """helper functions for transform_freq"""
+
 import numpy as np
 from numba import njit
 from numpy import fft
 
+
 def transform_wavelet_freq_helper(
     data: np.ndarray, Nf: int, Nt: int, phif: np.ndarray
 ) -> np.ndarray:
@@ -13,8 +15,16 @@ def transform_wavelet_freq_helper(
     __core(Nf, Nt, DX, freq_strain, phif, wave)
     return wave
 
+
 # @njit()
-def __core(Nf:int, Nt:int, DX:np.ndarray, freq_strain:np.ndarray, phif:np.ndarray, wave:np.ndarray):
+def __core(
+    Nf: int,
+    Nt: int,
+    DX: np.ndarray,
+    freq_strain: np.ndarray,
+    phif: np.ndarray,
+    wave: np.ndarray,
+):
     for f_bin in range(0, Nf + 1):
         __fill_wave_1(f_bin, Nt, Nf, DX, freq_strain, phif)
         # Numba doesn't support np.ifft so we cant jit this
@@ -22,8 +32,6 @@ def __core(Nf:int, Nt:int, DX:np.ndarray, freq_strain:np.ndarray, phif:np.ndarra
         __fill_wave_2(f_bin, DX_trans, wave, Nt, Nf)
 
 
-
-
 @njit()
 def __fill_wave_1(
     f_bin: int,
@@ -55,6 +63,7 @@ def __fill_wave_1(
         else:
             DX[i] = phif[j] * data[jj]
 
+
 @njit()
 def __fill_wave_2(
     f_bin: int, DX_trans: np.ndarray, wave: np.ndarray, Nt: int, Nf: int
@@ -72,7 +81,7 @@ def __fill_wave_2(
                 if (n + f_bin) % 2:
                     wave[n, f_bin] = -DX_trans[n].imag
                 else:
-                    wave[n, f_bin] =  DX_trans[n].real
+                    wave[n, f_bin] = DX_trans[n].real
             else:
                 if (n + f_bin) % 2:
                     wave[n, f_bin] = DX_trans[n].imag

{pywavelet-0.1.0 → pywavelet-0.1.2}/src/pywavelet/transforms/forward/from_time.py

@@ -1,4 +1,5 @@
 """helper functions for transform_time.py"""
+
 import numpy as np
 from numba import njit
 from numpy import fft
@@ -20,7 +21,18 @@ def transform_wavelet_time_helper(
     __core(Nf, Nt, K, ND, wdata, data_pad, phi, wave, mult)
     return wave
 
-def __core(Nf: int, Nt: int, K: int, ND: int, wdata: np.ndarray, data_pad: np.ndarray, phi: np.ndarray, wave: np.ndarray, mult: int) -> None:
+
+def __core(
+    Nf: int,
+    Nt: int,
+    K: int,
+    ND: int,
+    wdata: np.ndarray,
+    data_pad: np.ndarray,
+    phi: np.ndarray,
+    wave: np.ndarray,
+    mult: int,
+) -> None:
     for time_bin_i in range(0, Nt):
         __fill_wave_1(time_bin_i, K, ND, Nf, wdata, data_pad, phi)
         wdata_trans = np.fft.rfft(wdata, K)

{pywavelet-0.1.0 → pywavelet-0.1.2}/src/pywavelet/transforms/forward/main.py

@@ -3,15 +3,15 @@ from typing import Union
 import numpy as np
 
 from ...logger import logger
+from ...types import FrequencySeries, TimeSeries, Wavelet
+from ...types.wavelet_bins import _get_bins, _preprocess_bins
 from ..phi_computer import phi_vec, phitilde_vec_norm
-from ..types import FrequencySeries, TimeSeries, Wavelet
 from .from_freq import transform_wavelet_freq_helper
 from .from_time import transform_wavelet_time_helper
-from .wavelet_bins import _get_bins, _preprocess_bins
-
 
 __all__ = ["from_time_to_wavelet", "from_freq_to_wavelet"]
 
+
 def from_time_to_wavelet(
     timeseries: TimeSeries,
     Nf: Union[int, None] = None,
@@ -74,9 +74,7 @@ def from_time_to_wavelet(
     mult = min(mult, Nt // 2)  # Ensure mult is not larger than ND/2
     phi = phi_vec(Nf, dt=dt, d=nx, q=mult)
     wave = transform_wavelet_time_helper(timeseries.data, Nf, Nt, phi, mult).T
-    return Wavelet(
-        wave * np.sqrt(2), time=t_bins, freq=f_bins
-    )
+    return Wavelet(wave * np.sqrt(2), time=t_bins, freq=f_bins)
 
 
 def from_freq_to_wavelet(
@@ -117,12 +115,6 @@ def from_freq_to_wavelet(
     t_bins, f_bins = _get_bins(freqseries, Nf, Nt)
     dt = freqseries.dt
     phif = phitilde_vec_norm(Nf, Nt, dt=dt, d=nx)
-    wave = transform_wavelet_freq_helper(
-        freqseries.data, Nf, Nt, phif
-    )
-
-    return Wavelet(
-        (2 / Nf) * wave.T * np.sqrt(2),
-        time=t_bins,
-        freq=f_bins
-    )
+    wave = transform_wavelet_freq_helper(freqseries.data, Nf, Nt, phif)
+
+    return Wavelet((2 / Nf) * wave.T * np.sqrt(2), time=t_bins, freq=f_bins)

{pywavelet-0.1.0 → pywavelet-0.1.2}/src/pywavelet/transforms/inverse/main.py

@@ -1,7 +1,7 @@
 import numpy as np
 
 from ...transforms.phi_computer import phi_vec, phitilde_vec_norm
-from ..types import FrequencySeries, TimeSeries, Wavelet
+from ...types import FrequencySeries, TimeSeries, Wavelet
 from .to_freq import inverse_wavelet_freq_helper_fast
 from .to_time import inverse_wavelet_time_helper_fast
 
@@ -9,6 +9,7 @@ __all__ = ["from_wavelet_to_time", "from_wavelet_to_freq"]
 
 INV_ROOT2 = 1.0 / np.sqrt(2)
 
+
 def from_wavelet_to_time(
     wave_in: Wavelet,
     dt: float,
@@ -55,9 +56,7 @@ def from_wavelet_to_time(
 
 
 def from_wavelet_to_freq(
-    wave_in: Wavelet,
-    dt: float,
-    nx:float=4.0
+    wave_in: Wavelet, dt: float, nx: float = 4.0
 ) -> FrequencySeries:
     """
     Perform an inverse wavelet transform to the frequency domain.

{pywavelet-0.1.0 → pywavelet-0.1.2}/src/pywavelet/transforms/inverse/to_freq.py

@@ -1,4 +1,5 @@
 """functions for computing the inverse wavelet transforms"""
+
 import numpy as np
 from numba import njit
 from numpy import fft
@@ -12,13 +13,20 @@ def inverse_wavelet_freq_helper_fast(
     ND = Nf * Nt
 
     prefactor2s = np.zeros(Nt, np.complex128)
-    res = np.zeros(ND//2 +1, dtype=np.complex128)
+    res = np.zeros(ND // 2 + 1, dtype=np.complex128)
     __core(Nf, Nt, prefactor2s, wave_in, phif, res)
 
-
     return res
 
-def __core(Nf: int, Nt: int, prefactor2s: np.ndarray, wave_in: np.ndarray, phif: np.ndarray, res: np.ndarray) -> None:
+
+def __core(
+    Nf: int,
+    Nt: int,
+    prefactor2s: np.ndarray,
+    wave_in: np.ndarray,
+    phif: np.ndarray,
+    res: np.ndarray,
+) -> None:
     for m in range(0, Nf + 1):
         __pack_wave_inverse(m, Nt, Nf, prefactor2s, wave_in)
         fft_prefactor2s = np.fft.fft(prefactor2s)

{pywavelet-0.1.0 → pywavelet-0.1.2}/src/pywavelet/transforms/inverse/to_time.py

@@ -1,4 +1,5 @@
 """functions for computing the inverse wavelet transforms"""
+
 import numpy as np
 from numba import njit
 from numpy import fft
@@ -21,7 +22,16 @@ def inverse_wavelet_time_helper_fast(
     return res[:ND]
 
 
-def __core(Nf: int, Nt: int, K: int, ND: int, wave_in: np.ndarray, phi: np.ndarray, res: np.ndarray, afins:np.ndarray) -> None:
+def __core(
+    Nf: int,
+    Nt: int,
+    K: int,
+    ND: int,
+    wave_in: np.ndarray,
+    phi: np.ndarray,
+    res: np.ndarray,
+    afins: np.ndarray,
+) -> None:
     for n in range(0, Nt):
         if n % 2 == 0:
             pack_wave_time_helper_compact(n, Nf, Nt, wave_in, afins)
@@ -29,9 +39,9 @@ def __core(Nf: int, Nt: int, K: int, ND: int, wave_in: np.ndarray, phi: np.ndarr
             unpack_time_wave_helper_compact(n, Nf, Nt, K, phi, ffts_fin, res)
 
     # wrap boundary conditions
-    res[: min(K + Nf, ND)] += res[ND: min(ND + K + Nf, 2 * ND)]
+    res[: min(K + Nf, ND)] += res[ND : min(ND + K + Nf, 2 * ND)]
     if K + Nf > ND:
-        res[: K + Nf - ND] += res[2 * ND: ND + K * Nf]
+        res[: K + Nf - ND] += res[2 * ND : ND + K * Nf]
 
 
 def unpack_time_wave_helper(

{pywavelet-0.1.0/src/pywavelet/transforms → pywavelet-0.1.2/src/pywavelet}/types/__init__.py

@@ -1,4 +1,3 @@
 from .frequencyseries import FrequencySeries
 from .timeseries import TimeSeries
-from .wavelet import Wavelet
-from .wavelet_mask import WaveletMask
+from .wavelet import Wavelet, WaveletMask

{pywavelet-0.1.0/src/pywavelet/transforms → pywavelet-0.1.2/src/pywavelet}/types/common.py

@@ -1,9 +1,9 @@
-from typing import Literal, Tuple
+from typing import Tuple, Union
 
 import numpy as xp
-from numpy.fft import irfft, fft, rfft, rfftfreq
+from numpy.fft import fft, irfft, rfft, rfftfreq  # type: ignore
 
-from ...logger import logger
+from ..logger import logger
 
 
 def _len_check(d):
@@ -19,7 +19,7 @@ def is_documented_by(original):
     return wrapper
 
 
-def fmt_time(seconds: float, units=False) -> Tuple[str, str]:
+def fmt_time(seconds: float, units=False) -> Union[str, Tuple[str, str]]:
     """Returns formatted time and units [ms, s, min, hr, day]"""
     t, u = "", ""
     if seconds < 1e-3:
@@ -42,12 +42,12 @@ def fmt_time(seconds: float, units=False) -> Tuple[str, str]:
 
 def fmt_timerange(trange):
     t0 = fmt_time(trange[0])
-    tend, units = fmt_time(trange[1], units = True)
+    tend, units = fmt_time(trange[1], units=True)
     return f"[{t0}, {tend}] {units}"
 
 
-def fmt_pow2(n:float)->str:
+def fmt_pow2(n: float) -> str:
     pow2 = xp.log2(n)
     if pow2.is_integer():
         return f"2^{int(pow2)}"
-    return f"{n:,}"
+    return f"{n:,}"

{pywavelet-0.1.0/src/pywavelet/transforms → pywavelet-0.1.2/src/pywavelet}/types/frequencyseries.py

@@ -1,11 +1,13 @@
+from typing import Optional, Tuple, Union
+
 import matplotlib.pyplot as plt
-from typing import Tuple, Union, Optional
 
-from .common import is_documented_by, xp, irfft, fmt_time, fmt_pow2
+from .common import fmt_pow2, fmt_time, irfft, is_documented_by, xp
 from .plotting import plot_freqseries, plot_periodogram
 
 __all__ = ["FrequencySeries"]
 
+
 class FrequencySeries:
     """
     A class to represent a one-sided frequency series, with various methods for
@@ -39,9 +41,13 @@ class FrequencySeries:
             If any frequency is negative or if `data` and `freq` do not have the same length.
         """
         if xp.any(freq < 0):
-            raise ValueError("FrequencySeries must be one-sided (only non-negative frequencies)")
+            raise ValueError(
+                "FrequencySeries must be one-sided (only non-negative frequencies)"
+            )
         if len(data) != len(freq):
-            raise ValueError(f"data and freq must have the same length ({len(data)} != {len(freq)})")
+            raise ValueError(
+                f"data and freq must have the same length ({len(data)} != {len(freq)})"
+            )
         self.data = data
         self.freq = freq
         self.t0 = t0
@@ -53,10 +59,10 @@ class FrequencySeries:
         )
 
     @is_documented_by(plot_periodogram)
-    def plot_periodogram(self, ax=None, **kwargs) -> Tuple[plt.Figure, plt.Axes]:
-        return plot_periodogram(
-            self.data, self.freq, self.fs, ax=ax, **kwargs
-        )
+    def plot_periodogram(
+        self, ax=None, **kwargs
+    ) -> Tuple[plt.Figure, plt.Axes]:
+        return plot_periodogram(self.data, self.freq, self.fs, ax=ax, **kwargs)
 
     def __len__(self):
         """Return the length of the frequency series."""
@@ -127,7 +133,9 @@ class FrequencySeries:
         n = fmt_pow2(len(self))
         return f"FrequencySeries(n={n}, frange=[{self.range[0]:.2f}, {self.range[1]:.2f}] Hz, T={dur}, fs={self.fs:.2f} Hz)"
 
-    def noise_weighted_inner_product(self, other: "FrequencySeries", psd:"FrequencySeries") -> float:
+    def noise_weighted_inner_product(
+        self, other: "FrequencySeries", psd: "FrequencySeries"
+    ) -> float:
         """
         Compute the noise-weighted inner product of two FrequencySeries.
 
@@ -144,9 +152,11 @@ class FrequencySeries:
             The noise-weighted inner product of the two FrequencySeries.
         """
         integrand = xp.real(xp.conj(self.data) * other.data / psd.data)
-        return (4 * self.dt/self.ND) * xp.nansum(integrand)
+        return (4 * self.dt / self.ND) * xp.nansum(integrand)
 
-    def matched_filter_snr(self, other: "FrequencySeries", psd: "FrequencySeries") -> float:
+    def matched_filter_snr(
+        self, other: "FrequencySeries", psd: "FrequencySeries"
+    ) -> float:
         """
         Compute the signal-to-noise ratio (SNR) of a matched filter.
 
@@ -199,15 +209,15 @@ class FrequencySeries:
 
         # Create and return a TimeSeries object
         from .timeseries import TimeSeries
-        return TimeSeries(time_data, time)
 
+        return TimeSeries(time_data, time)
 
     def to_wavelet(
-            self,
-            Nf: Union[int, None] = None,
-            Nt: Union[int, None] = None,
-            nx: Optional[float] = 4.0,
-        )->"Wavelet":
+        self,
+        Nf: Union[int, None] = None,
+        Nt: Union[int, None] = None,
+        nx: Optional[float] = 4.0,
+    ) -> "Wavelet":
         """
         Convert the frequency series to a wavelet using inverse Fourier transform.
 
@@ -216,9 +226,9 @@ class FrequencySeries:
         Wavelet
             The corresponding wavelet.
         """
-        from ..forward import from_freq_to_wavelet
-        return from_freq_to_wavelet(self, Nf=Nf, Nt=Nt, nx=nx)
+        from ..transforms.forward import from_freq_to_wavelet
 
+        return from_freq_to_wavelet(self, Nf=Nf, Nt=Nt, nx=nx)
 
     def __eq__(self, other):
         """Check if two FrequencySeries objects are equal."""
@@ -228,10 +238,8 @@ class FrequencySeries:
 
     def __copy__(self):
         return FrequencySeries(
-            xp.copy(self.data),
-            xp.copy(self.freq),
-            t0=self.t0
+            xp.copy(self.data), xp.copy(self.freq), t0=self.t0
         )
 
     def copy(self):
-        return self.__copy__()
+        return self.__copy__()