ezmsg-sigproc 2.5.0__py3-none-any.whl → 2.7.0__py3-none-any.whl

ezmsg/sigproc/window.py

@@ -5,21 +5,21 @@ import typing
 import ezmsg.core as ez
 import numpy.typing as npt
 import sparse
-from array_api_compat import is_pydata_sparse_namespace, get_namespace
+from array_api_compat import get_namespace, is_pydata_sparse_namespace
+from ezmsg.baseproc import (
+    BaseStatefulTransformer,
+    BaseTransformerUnit,
+    processor_state,
+)
 from ezmsg.util.messages.axisarray import (
     AxisArray,
+    replace,
     slice_along_axis,
     sliding_win_oneaxis,
-    replace,
 )
 
-from .base import (
-    BaseStatefulTransformer,
-    BaseTransformerUnit,
-    processor_state,
-)
-from .util.sparse import sliding_win_oneaxis as sparse_sliding_win_oneaxis
 from .util.profile import profile_subpub
+from .util.sparse import sliding_win_oneaxis as sparse_sliding_win_oneaxis
 
 
 class Anchor(enum.Enum):
@@ -55,9 +55,7 @@ class WindowState:
     out_dims: list[str] | None = None
 
 
-class WindowTransformer(
-    BaseStatefulTransformer[WindowSettings, AxisArray, AxisArray, WindowState]
-):
+class WindowTransformer(BaseStatefulTransformer[WindowSettings, AxisArray, AxisArray, WindowState]):
     """
     Apply a sliding window along the specified axis to input streaming data.
     The `windowing` method is perhaps the most useful and versatile method in ezmsg.sigproc, but its parameterization
@@ -99,19 +97,13 @@ class WindowTransformer(
         # if self.settings.newaxis is None:
         #     ez.logger.warning("`newaxis=None` will be replaced with `newaxis='win'`.")
         #     object.__setattr__(self.settings, "newaxis", "win")
-        if (
-            self.settings.window_shift is None
-            and self.settings.zero_pad_until != "input"
-        ):
+        if self.settings.window_shift is None and self.settings.zero_pad_until != "input":
             ez.logger.warning(
                 "`zero_pad_until` must be 'input' if `window_shift` is None. "
                 f"Ignoring received argument value: {self.settings.zero_pad_until}"
             )
             object.__setattr__(self.settings, "zero_pad_until", "input")
-        elif (
-            self.settings.window_shift is not None
-            and self.settings.zero_pad_until == "input"
-        ):
+        elif self.settings.window_shift is not None and self.settings.zero_pad_until == "input":
             ez.logger.warning(
                 "windowing is non-deterministic with `zero_pad_until='input'` as it depends on the size "
                 "of the first input. We recommend using `zero_pad_until='shift'` when `window_shift` is float-valued."
@@ -135,9 +127,7 @@ class WindowTransformer(
     def _reset_state(self, message: AxisArray) -> None:
         _newaxis = self.settings.newaxis or "win"
         if not self._state.newaxis_warned and _newaxis in message.dims:
-            ez.logger.warning(
-                f"newaxis {_newaxis} present in input dims. Using {_newaxis}_win instead"
-            )
+            ez.logger.warning(f"newaxis {_newaxis} present in input dims. Using {_newaxis}_win instead")
             self._state.newaxis_warned = True
             self.settings.newaxis = f"{_newaxis}_win"
 
@@ -154,33 +144,20 @@ class WindowTransformer(
             self._state.window_shift_samples = int(self.settings.window_shift * fs)
         if self.settings.zero_pad_until == "none":
             req_samples = self._state.window_samples
-        elif (
-            self.settings.zero_pad_until == "shift"
-            and self.settings.window_shift is not None
-        ):
+        elif self.settings.zero_pad_until == "shift" and self.settings.window_shift is not None:
             req_samples = self._state.window_shift_samples
         else:  # i.e. zero_pad_until == "input"
             req_samples = message.data.shape[axis_idx]
         n_zero = max(0, self._state.window_samples - req_samples)
-        init_buffer_shape = (
-            message.data.shape[:axis_idx]
-            + (n_zero,)
-            + message.data.shape[axis_idx + 1 :]
-        )
+        init_buffer_shape = message.data.shape[:axis_idx] + (n_zero,) + message.data.shape[axis_idx + 1 :]
         self._state.buffer = xp.zeros(init_buffer_shape, dtype=message.data.dtype)
 
         # Prepare reusable parts of output
         if self._state.out_newaxis is None:
-            self._state.out_dims = (
-                list(message.dims[:axis_idx])
-                + [_newaxis]
-                + list(message.dims[axis_idx:])
-            )
+            self._state.out_dims = list(message.dims[:axis_idx]) + [_newaxis] + list(message.dims[axis_idx:])
             self._state.out_newaxis = replace(
                 axis_info,
-                gain=0.0
-                if self.settings.window_shift is None
-                else axis_info.gain * self._state.window_shift_samples,
+                gain=0.0 if self.settings.window_shift is None else axis_info.gain * self._state.window_shift_samples,
                 offset=0.0,  # offset modified per-msg below
             )
 
@@ -204,9 +181,7 @@ class WindowTransformer(
         # is generally faster than np.roll and slicing anyway, but this could still
         # be a performance bottleneck for large memory arrays.
         # A circular buffer might be faster.
-        self._state.buffer = xp.concatenate(
-            (self._state.buffer, message.data), axis=axis_idx
-        )
+        self._state.buffer = xp.concatenate((self._state.buffer, message.data), axis=axis_idx)
 
         # Create a vector of buffer timestamps to track axis `offset` in output(s)
         buffer_t0 = 0.0
@@ -222,9 +197,7 @@ class WindowTransformer(
         if self.settings.window_shift is not None and self._state.shift_deficit > 0:
             n_skip = min(self._state.buffer.shape[axis_idx], self._state.shift_deficit)
             if n_skip > 0:
-                self._state.buffer = slice_along_axis(
-                    self._state.buffer, slice(n_skip, None), axis_idx
-                )
+                self._state.buffer = slice_along_axis(self._state.buffer, slice(n_skip, None), axis_idx)
                 buffer_t0 += n_skip * axis_info.gain
                 buffer_tlen -= n_skip
                 self._state.shift_deficit -= n_skip
@@ -249,20 +222,12 @@ class WindowTransformer(
                 self._state.buffer, slice(-self._state.window_samples, None), axis_idx
             )
             out_dat = self._state.buffer.reshape(
-                self._state.buffer.shape[:axis_idx]
-                + (1,)
-                + self._state.buffer.shape[axis_idx:]
-            )
-            win_offset = buffer_t0 + axis_info.gain * (
-                buffer_tlen - self._state.window_samples
+                self._state.buffer.shape[:axis_idx] + (1,) + self._state.buffer.shape[axis_idx:]
             )
+            win_offset = buffer_t0 + axis_info.gain * (buffer_tlen - self._state.window_samples)
         elif self._state.buffer.shape[axis_idx] >= self._state.window_samples:
             # Deterministic window shifts.
-            sliding_win_fun = (
-                sparse_sliding_win_oneaxis
-                if is_pydata_sparse_namespace(xp)
-                else sliding_win_oneaxis
-            )
+            sliding_win_fun = sparse_sliding_win_oneaxis if is_pydata_sparse_namespace(xp) else sliding_win_oneaxis
             out_dat = sliding_win_fun(
                 self._state.buffer,
                 self._state.window_samples,
@@ -273,18 +238,12 @@ class WindowTransformer(
 
             # Drop expired beginning of buffer and update shift_deficit
             multi_shift = self._state.window_shift_samples * out_dat.shape[axis_idx]
-            self._state.shift_deficit = max(
-                0, multi_shift - self._state.buffer.shape[axis_idx]
-            )
-            self._state.buffer = slice_along_axis(
-                self._state.buffer, slice(multi_shift, None), axis_idx
-            )
+            self._state.shift_deficit = max(0, multi_shift - self._state.buffer.shape[axis_idx])
+            self._state.buffer = slice_along_axis(self._state.buffer, slice(multi_shift, None), axis_idx)
         else:
             # Not enough data to make a new window. Return empty data.
             empty_data_shape = (
-                message.data.shape[:axis_idx]
-                + (0, self._state.window_samples)
-                + message.data.shape[axis_idx + 1 :]
+                message.data.shape[:axis_idx] + (0, self._state.window_samples) + message.data.shape[axis_idx + 1 :]
             )
             out_dat = xp.zeros(empty_data_shape, dtype=message.data.dtype)
             # out_newaxis will have first timestamp in input... but mostly meaningless because output is size-zero.
@@ -305,9 +264,7 @@ class WindowTransformer(
         return msg_out
 
 
-class Window(
-    BaseTransformerUnit[WindowSettings, AxisArray, AxisArray, WindowTransformer]
-):
+class Window(BaseTransformerUnit[WindowSettings, AxisArray, AxisArray, WindowTransformer]):
     SETTINGS = WindowSettings
     INPUT_SIGNAL = ez.InputStream(AxisArray)
     OUTPUT_SIGNAL = ez.OutputStream(AxisArray)
@@ -325,30 +282,19 @@ class Window(
         try:
             ret = self.processor(message)
             if ret.data.size > 0:
-                if (
-                    self.SETTINGS.newaxis is not None
-                    or self.SETTINGS.window_dur is None
-                ):
+                if self.SETTINGS.newaxis is not None or self.SETTINGS.window_dur is None:
                     # Multi-win mode or pass-through mode.
                     yield self.OUTPUT_SIGNAL, ret
                 else:
                     # We need to split out_msg into multiple yields, dropping newaxis.
                     axis_idx = ret.get_axis_idx("win")
                     win_axis = ret.axes["win"]
-                    offsets = win_axis.value(
-                        xp.asarray(range(ret.data.shape[axis_idx]))
-                    )
+                    offsets = win_axis.value(xp.asarray(range(ret.data.shape[axis_idx])))
                     for msg_ix in range(ret.data.shape[axis_idx]):
                         # Need to drop 'win' and replace self.SETTINGS.axis from axes.
                         _out_axes = {
-                            **{
-                                k: v
-                                for k, v in ret.axes.items()
-                                if k not in ["win", self.SETTINGS.axis]
-                            },
-                            self.SETTINGS.axis: replace(
-                                ret.axes[self.SETTINGS.axis], offset=offsets[msg_ix]
-                            ),
+                            **{k: v for k, v in ret.axes.items() if k not in ["win", self.SETTINGS.axis]},
+                            self.SETTINGS.axis: replace(ret.axes[self.SETTINGS.axis], offset=offsets[msg_ix]),
                         }
                         _ret = replace(
                             ret,

ezmsg_sigproc-2.7.0.dist-info/METADATA

@@ -0,0 +1,60 @@
+Metadata-Version: 2.4
+Name: ezmsg-sigproc
+Version: 2.7.0
+Summary: Timeseries signal processing implementations in ezmsg
+Author-email: Griffin Milsap <griffin.milsap@gmail.com>, Preston Peranich <pperanich@gmail.com>, Chadwick Boulay <chadwick.boulay@gmail.com>, Kyle McGraw <kmcgraw@blackrockneuro.com>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.10.15
+Requires-Dist: array-api-compat>=1.11.1
+Requires-Dist: ezmsg-baseproc>=1.1.0
+Requires-Dist: ezmsg>=3.6.0
+Requires-Dist: numba>=0.61.0
+Requires-Dist: numpy>=1.26.0
+Requires-Dist: pywavelets>=1.6.0
+Requires-Dist: scipy>=1.13.1
+Requires-Dist: sparse>=0.15.4
+Description-Content-Type: text/markdown
+
+# ezmsg-sigproc
+
+Signal processing primitives for the [ezmsg](https://www.ezmsg.org) message-passing framework.
+
+## Features
+
+* **Filtering** - Chebyshev, comb filters, and more
+* **Spectral analysis** - Spectrogram, spectrum, and wavelet transforms
+* **Resampling** - Downsample, decimate, and resample operations
+* **Windowing** - Sliding windows and buffering utilities
+* **Math operations** - Arithmetic, log, abs, difference, and more
+* **Signal generation** - Synthetic signal generators
+
+All modules use `AxisArray` as the primary data structure for passing signals between components.
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install ezmsg-sigproc
+```
+
+Or install from GitHub for the latest development version:
+
+```bash
+pip install git+https://github.com/ezmsg-org/ezmsg-sigproc.git@dev
+```
+
+## Documentation
+
+Full documentation is available at [ezmsg.org](https://www.ezmsg.org).
+
+## Development
+
+We use [`uv`](https://docs.astral.sh/uv/) for development.
+
+1. Fork and clone the repository
+2. `uv sync` to create a virtual environment and install dependencies
+3. `uv run pre-commit install` to set up linting and formatting hooks
+4. `uv run pytest tests` to run the test suite
+5. Submit a PR against the `dev` branch

ezmsg_sigproc-2.7.0.dist-info/RECORD

@@ -0,0 +1,64 @@
+ezmsg/sigproc/__init__.py,sha256=8K4IcOA3-pfzadoM6s2Sfg5460KlJUocGgyTJTJl96U,52
+ezmsg/sigproc/__version__.py,sha256=egp6dAw7S80JrGAUNYGJNY3iqzeSzC4Vs5c3SnC3SIY,704
+ezmsg/sigproc/activation.py,sha256=83vnTa3ZcC4Q3VSWcGfaqhCEqYRNySUOyVpMHZXfz-c,2755
+ezmsg/sigproc/adaptive_lattice_notch.py,sha256=ThUR48mbSHuThkimtD0j4IXNMrOVcpZgGhE7PCYfXhU,8818
+ezmsg/sigproc/affinetransform.py,sha256=umEsbEcuiCI02oljWueJnKaI0aJxJ0wqOjH5yXclEM0,8414
+ezmsg/sigproc/aggregate.py,sha256=yc3Hnak0yhucqlTCv9Isg6BKR24s6rMZqbZKpayyBgM,9048
+ezmsg/sigproc/bandpower.py,sha256=dAhH56sUrXNhcRFymTTwjdM_KcU5OxFzrR_sxIPAxyw,2264
+ezmsg/sigproc/base.py,sha256=SJvKEb8gw6mUMwlV5sH0iPG0bXrgS8tvkPwhI-j89MQ,3672
+ezmsg/sigproc/butterworthfilter.py,sha256=NKTGkgjvlmC1Dc9gD2Z6UBzUq12KicfnczrzM5ZTosk,5255
+ezmsg/sigproc/butterworthzerophase.py,sha256=QbJ_gGXrIfVOl_OybD07orO460owSMP5yTDMcGgASP0,4109
+ezmsg/sigproc/cheby.py,sha256=B8pGt5_pOBpNZCmaibNl_NKkyuasd8ZEJXeTDCTaino,3711
+ezmsg/sigproc/combfilter.py,sha256=MSxr1I-jBePW_9AuCiv3RQ1HUNxIsNhLk0q1Iu8ikAw,4766
+ezmsg/sigproc/coordinatespaces.py,sha256=NWbQVvizmiU4F3AIwHHhiZ30Kg2IeSW0fRaa-yXkn-c,4610
+ezmsg/sigproc/decimate.py,sha256=DCX9p4ZrcGoQ9di-jmPKqiKERTkvTAtSqLg8chQLp84,2336
+ezmsg/sigproc/denormalize.py,sha256=CaH34QJ3OvsnhZT7bhCw2KVxVKvaU24ui6BS5-oe_x0,3040
+ezmsg/sigproc/detrend.py,sha256=TxqZ41AdjsH_yOTj8fBoKTnbKCbdyzVibpCHWkFARYU,898
+ezmsg/sigproc/diff.py,sha256=PC8KJAqaXMsdS_kPlDSEtXpcQ5rk92Ze_TeUjsVwbN0,2782
+ezmsg/sigproc/downsample.py,sha256=Jqxt1Va1FrQLH1wUQpP0U79iQARTTHEKklKHy7yGL2o,3679
+ezmsg/sigproc/ewma.py,sha256=I6WZkf6yf8jnpLdeEAWfAcpui5erVcVMZo6hTMMvDvg,6247
+ezmsg/sigproc/ewmfilter.py,sha256=9AuvVn3TDdf5R4bVolYNM46AtDVHFJa8MLGltY6mYPE,4795
+ezmsg/sigproc/extract_axis.py,sha256=4beqJ0EyUkT9Pa1FdYa9IteHGaxkh87j5_rYiZlvIG4,1598
+ezmsg/sigproc/fbcca.py,sha256=JYFWsMDRJEWwUNujr4EsFL5t1ux-cnBGamNVrCRO_RA,12043
+ezmsg/sigproc/filter.py,sha256=rLmJCgPevoODTL3g_D6czwVvcCD4uK8hJJ0tKfTH5_w,11609
+ezmsg/sigproc/filterbank.py,sha256=tD7fn4dZzEvsmp_sSn16VVJ4WcJ5sN5lsSuNTLDCQZ8,13056
+ezmsg/sigproc/filterbankdesign.py,sha256=vLXQVJwoFEK4V6umqzcr1PJKcwv6pGO29klSWQXk7y0,4712
+ezmsg/sigproc/fir_hilbert.py,sha256=aurBCcpvsG69qD6Du2aHMye4HCBXF4RXzACdSxIy_Z8,10859
+ezmsg/sigproc/fir_pmc.py,sha256=Ze2pd9K8XrdDhgJZG2E7x-5C2hfd6kIns4bYjTJsBvc,6997
+ezmsg/sigproc/firfilter.py,sha256=7r_I476nYuixJsuwc_hQ0Fbq8WB0gnYBZUKs3zultOQ,3790
+ezmsg/sigproc/gaussiansmoothing.py,sha256=BfXm9YQoOtieM4ABK2KRgxeQz055rd7mqtTVqmjT3Rk,2672
+ezmsg/sigproc/kaiser.py,sha256=dIwgHbLXUHPtdotsGNLE9VG_clhcMgvVnSoFkMVgF9M,3483
+ezmsg/sigproc/messages.py,sha256=KQczHTeifn4BZycChN8ZcpfZoQW3lC_xuFmN72QT97s,925
+ezmsg/sigproc/quantize.py,sha256=uSM2z2xXwL0dgSltyzLEmlKjaJZ2meA3PDWX8_bM0Hs,2195
+ezmsg/sigproc/resample.py,sha256=3mm9pvxryNVhQuTCIMW3ToUkUfbVOCsIgvXUiurit1Y,11389
+ezmsg/sigproc/rollingscaler.py,sha256=j5hoWgJMbeDST7FXE6UBLSeR2hhfACIqQvFKr92ZTZA,8503
+ezmsg/sigproc/sampler.py,sha256=iOk2YoUX22u9iTjFKimzP5V074RDBVcmswgfyxvZRZo,10761
+ezmsg/sigproc/scaler.py,sha256=n0aGo272vs_MnFRtT1b3vVCQOzY-UEAxnqZKlpIldX8,4041
+ezmsg/sigproc/signalinjector.py,sha256=mB62H2b-ScgPtH1jajEpxgDHqdb-RKekQfgyNncsE8Y,2874
+ezmsg/sigproc/slicer.py,sha256=xLXxWf722V08ytVwvPimYjDKKj0pkC2HjdgCVaoaOvs,5195
+ezmsg/sigproc/spectral.py,sha256=wFzuihS7qJZMQcp0ds_qCG-zCbvh5DyhFRjn2wA9TWQ,322
+ezmsg/sigproc/spectrogram.py,sha256=g8xYWENzle6O5uEF-vfjsF5gOSDnJTwiu3ZudicO470,2893
+ezmsg/sigproc/spectrum.py,sha256=AAxrywIYpAPENRWvaaM2VjcKEaqMt6ra1E3Ao26jdZs,9523
+ezmsg/sigproc/transpose.py,sha256=Yx4losN7tKCacUt2GmFvjOSqJ0b3XhEepXzq_Z_iMCI,4381
+ezmsg/sigproc/wavelets.py,sha256=mN9TrZencyvKBfnuMiGZ_lzrE1O7DhVo05EYgCjXncg,7428
+ezmsg/sigproc/window.py,sha256=ZlawY4TPbLc46qIgcKhP4X7dpMDo4zNlnfzgV1eFaGU,15335
+ezmsg/sigproc/math/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ezmsg/sigproc/math/abs.py,sha256=_omQP4baHGu8MgKzNDMUsjrmA_yeXWNqKyTU7BiHCSE,741
+ezmsg/sigproc/math/add.py,sha256=lR4lB8-QdUfyARJcdf5sMQhbHtFpRNYt8_1zYzkVEhU,3659
+ezmsg/sigproc/math/clip.py,sha256=vJ8zpzVlTVPlkElsqyPVMOwyKBrgym8RD8BEOvf8g1o,1131
+ezmsg/sigproc/math/difference.py,sha256=TtAURz9TsW_Vk39sMJOT84P0xw0xDrgE3ToRi8MWVv4,4491
+ezmsg/sigproc/math/invert.py,sha256=SYJDNEb7snkVODnItfkkp8rhMrHEdyBmzg6qZkZLX2c,630
+ezmsg/sigproc/math/log.py,sha256=K8bZSm-ubTDY0oqwuc0IOMkdPIwpw1yysjTOG657kkQ,1488
+ezmsg/sigproc/math/scale.py,sha256=Zpzlz1NSLyvmggjs0pPypUKgXX99z2S3VXJ06fHok5M,942
+ezmsg/sigproc/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ezmsg/sigproc/util/asio.py,sha256=aAj0e7OoBvkRy28k05HL2s9YPCTxOddc05xMN-qd4lQ,577
+ezmsg/sigproc/util/axisarray_buffer.py,sha256=TGDeC6CXmmp7OUuiGd6xYQijRGYDE4QGdWxjK5Vs3nE,14057
+ezmsg/sigproc/util/buffer.py,sha256=83Gm0IuowmcMlXgLFB_rz8_ZPhkwG4DNNejyWJDKJl8,19658
+ezmsg/sigproc/util/message.py,sha256=ppN3IYtIAwrxWG9JOvgWFn1wDdIumkEzYFfqpH9VQkY,338
+ezmsg/sigproc/util/profile.py,sha256=eVOo9pXgusrnH1yfRdd2RsM7Dbe2UpyC0LJ9MfGpB08,416
+ezmsg/sigproc/util/sparse.py,sha256=NjbJitCtO0B6CENTlyd9c-lHEJwoCan-T3DIgPyeShw,4834
+ezmsg/sigproc/util/typeresolution.py,sha256=fMFzLi63dqCIclGFLcMdM870OYxJnkeWw6aWKNMk718,362
+ezmsg_sigproc-2.7.0.dist-info/METADATA,sha256=QtI9FWw5pFVEqs1Ma6tooyGj73dZ6IOnM0QueJnzeSY,1908
+ezmsg_sigproc-2.7.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+ezmsg_sigproc-2.7.0.dist-info/licenses/LICENSE,sha256=seu0tKhhAMPCUgc1XpXGGaCxY1YaYvFJwqFuQZAl2go,1100
+ezmsg_sigproc-2.7.0.dist-info/RECORD,,