ezmsg-sigproc 1.8.2__py3-none-any.whl → 2.1.0__py3-none-any.whl

ezmsg/sigproc/wavelets.py

@@ -6,190 +6,191 @@ import pywt
 import ezmsg.core as ez
 from ezmsg.util.messages.axisarray import AxisArray
 from ezmsg.util.messages.util import replace
-from ezmsg.util.generator import consumer
 
-from .base import GenAxisArray
+from .base import (
+    BaseStatefulTransformer,
+    BaseTransformerUnit,
+    processor_state,
+)
 from .filterbank import filterbank, FilterbankMode, MinPhaseMode
 
 
-@consumer
-def cwt(
-    frequencies: list | tuple | npt.NDArray | None,
-    wavelet: str | pywt.ContinuousWavelet | pywt.Wavelet,
-    min_phase: MinPhaseMode = MinPhaseMode.NONE,
-    axis: str = "time",
-    scales: list | tuple | npt.NDArray | None = None,
-) -> typing.Generator[AxisArray, AxisArray, None]:
+class CWTSettings(ez.Settings):
+    """
+    Settings for :obj:`CWT`
+    See :obj:`cwt` for argument details.
     """
-    Perform a continuous wavelet transform.
-    The function is equivalent to the :obj:`pywt.cwt` function, but is designed to work with streaming data.
 
-    Args:
-        frequencies: The wavelet frequencies to use in Hz. If `None` provided then the scales will be used.
-          Note: frequencies will be sorted from smallest to largest.
-        wavelet: Wavelet object or name of wavelet to use.
-        min_phase: See filterbank MinPhaseMode for details.
-        axis: The target axis for operation. Note that this will be moved to the -1th dimension
-          because fft and matrix multiplication is much faster on the last axis.
-          This axis must be in the msg.axes and it must be of type AxisArray.LinearAxis.
-        scales: The scales to use. If None, the scales will be calculated from the frequencies.
-          Note: Scales will be sorted from largest to smallest.
-          Note: Use of scales is deprecated in favor of frequencies. Convert scales to frequencies using
-            `pywt.scale2frequency(wavelet, scales, precision=10) * fs` where fs is the sampling frequency.
+    frequencies: list | tuple | npt.NDArray | None
+    wavelet: str | pywt.ContinuousWavelet | pywt.Wavelet
+    min_phase: MinPhaseMode = MinPhaseMode.NONE
+    axis: str = "time"
+    scales: list | tuple | npt.NDArray | None = None
 
-    Returns:
-        A primed Generator object that expects an :obj:`AxisArray` via `.send(axis_array)` of continuous data
-        and yields an :obj:`AxisArray` with a continuous wavelet transform in its data.
-    """
-    precision = 10
-    msg_out: AxisArray | None = None
-
-    # Check parameters
-    if frequencies is None and scales is None:
-        raise ValueError("Either frequencies or scales must be provided.")
-    if frequencies is not None and scales is not None:
-        raise ValueError("Only one of frequencies or scales can be provided.")
-    if scales is not None:
-        scales = np.sort(scales)[::-1]
-        assert np.all(scales > 0), "scales must be positive."
-        assert scales.ndim == 1, "scales must be a 1D list, tuple, or array."
-
-    if not isinstance(wavelet, (pywt.ContinuousWavelet, pywt.Wavelet)):
-        wavelet = pywt.DiscreteContinuousWavelet(wavelet)
-
-    if frequencies is not None:
-        frequencies = np.sort(frequencies)
-        assert np.all(frequencies > 0), "frequencies must be positive."
-        assert frequencies.ndim == 1, "frequencies must be a 1D list, tuple, or array."
-
-    # State variables
+
+@processor_state
+class CWTState:
     neg_rt_scales: npt.NDArray | None = None
-    int_psi, wave_xvec = pywt.integrate_wavelet(wavelet, precision=precision)
-    int_psi = np.conj(int_psi) if wavelet.complex_cwt else int_psi
+    int_psi_scales: list[npt.NDArray] | None = None
     template: AxisArray | None = None
     fbgen: typing.Generator[AxisArray, AxisArray, None] | None = None
     last_conv_samp: npt.NDArray | None = None
 
-    # Reset if input changed
-    check_input = {
-        "kind": None,  # Need to recalc kernels at same complexity as input
-        "gain": None,  # Need to recalc freqs
-        "shape": None,  # Need to recalc template and buffer
-        "key": None,  # Buffer obsolete
-    }
-
-    while True:
-        msg_in: AxisArray = yield msg_out
-        ax_idx = msg_in.get_axis_idx(axis)
-        in_shape = msg_in.data.shape[:ax_idx] + msg_in.data.shape[ax_idx + 1 :]
-
-        b_reset = msg_in.data.dtype.kind != check_input["kind"]
-        b_reset = b_reset or msg_in.axes[axis].gain != check_input["gain"]
-        b_reset = b_reset or in_shape != check_input["shape"]
-        b_reset = b_reset or msg_in.key != check_input["key"]
-        b_reset = b_reset and msg_in.data.size > 0
-        if b_reset:
-            check_input["kind"] = msg_in.data.dtype.kind
-            check_input["gain"] = msg_in.axes[axis].gain
-            check_input["shape"] = in_shape
-            check_input["key"] = msg_in.key
-
-            if frequencies is not None:
-                scales = pywt.frequency2scale(
-                    wavelet, frequencies * msg_in.axes[axis].gain, precision=precision
-                )
-            neg_rt_scales = -np.sqrt(scales)[:, None]
-
-            # convert int_psi, wave_xvec to the same precision as the data
-            dt_data = msg_in.data.dtype  # _check_dtype(msg_in.data)
-            dt_cplx = np.result_type(dt_data, np.complex64)
-            dt_psi = dt_cplx if int_psi.dtype.kind == "c" else dt_data
-            int_psi = np.asarray(int_psi, dtype=dt_psi)
-            # TODO: Currently int_psi cannot be made non-complex once it is complex.
-
-            # Calculate waves for each scale
-            wave_xvec = np.asarray(wave_xvec, dtype=msg_in.data.real.dtype)
-            wave_range = wave_xvec[-1] - wave_xvec[0]
-            step = wave_xvec[1] - wave_xvec[0]
-            int_psi_scales = []
-            for scale in scales:
-                reix = (np.arange(scale * wave_range + 1) / (scale * step)).astype(int)
-                if reix[-1] >= int_psi.size:
-                    reix = np.extract(reix < int_psi.size, reix)
-                int_psi_scales.append(int_psi[reix][::-1])
-
-            # CONV is probably best because we often get huge kernels.
-            fbgen = filterbank(
-                int_psi_scales, mode=FilterbankMode.CONV, min_phase=min_phase, axis=axis
-            )
 
-            freqs = (
-                pywt.scale2frequency(wavelet, scales, precision)
-                / msg_in.axes[axis].gain
-            )
-            # Create output template
-            dummy_shape = in_shape + (len(scales), 0)
-            template = AxisArray(
-                np.zeros(
-                    dummy_shape, dtype=dt_cplx if wavelet.complex_cwt else dt_data
-                ),
-                dims=msg_in.dims[:ax_idx] + msg_in.dims[ax_idx + 1 :] + ["freq", axis],
-                axes={
-                    **msg_in.axes,
-                    "freq": AxisArray.CoordinateAxis(
-                        unit="Hz", data=freqs, dims=["freq"]
-                    ),
-                },
-                key=msg_in.key,
+class CWTTransformer(
+    BaseStatefulTransformer[CWTSettings, AxisArray, AxisArray, CWTState]
+):
+    def _hash_message(self, message: AxisArray) -> int:
+        ax_idx = message.get_axis_idx(self.settings.axis)
+        in_shape = message.data.shape[:ax_idx] + message.data.shape[ax_idx + 1 :]
+        return hash(
+            (
+                message.data.dtype.kind,
+                message.axes[self.settings.axis].gain,
+                in_shape,
+                message.key,
             )
-            last_conv_samp = np.zeros(
-                dummy_shape[:-1] + (1,), dtype=template.data.dtype
+        )
+
+    def _reset_state(self, message: AxisArray) -> None:
+        precision = 10
+
+        # Process wavelet
+        wavelet = (
+            self.settings.wavelet
+            if isinstance(self.settings.wavelet, (pywt.ContinuousWavelet, pywt.Wavelet))
+            else pywt.DiscreteContinuousWavelet(self.settings.wavelet)
+        )
+        # Process wavelet integration
+        int_psi, wave_xvec = pywt.integrate_wavelet(wavelet, precision=precision)
+        int_psi = np.conj(int_psi) if wavelet.complex_cwt else int_psi
+
+        # Calculate scales and frequencies
+        if self.settings.frequencies is not None:
+            frequencies = np.sort(np.array(self.settings.frequencies))
+            scales = pywt.frequency2scale(
+                wavelet,
+                frequencies * message.axes[self.settings.axis].gain,
+                precision=precision,
             )
+        else:
+            scales = np.sort(self.settings.scales)[::-1]
+
+        self._state.neg_rt_scales = -np.sqrt(scales)[:, None]
+
+        # Convert to appropriate dtype
+        dt_data = message.data.dtype
+        dt_cplx = np.result_type(dt_data, np.complex64)
+        dt_psi = dt_cplx if int_psi.dtype.kind == "c" else dt_data
+        int_psi = np.asarray(int_psi, dtype=dt_psi)
+        # Note: Currently int_psi cannot be made non-complex once it is complex.
+
+        # Calculate waves for each scale
+        wave_xvec = np.asarray(wave_xvec, dtype=message.data.real.dtype)
+        wave_range = wave_xvec[-1] - wave_xvec[0]
+        step = wave_xvec[1] - wave_xvec[0]
+        self._state.int_psi_scales = []
+        for scale in scales:
+            reix = (np.arange(scale * wave_range + 1) / (scale * step)).astype(int)
+            if reix[-1] >= int_psi.size:
+                reix = np.extract(reix < int_psi.size, reix)
+            self._state.int_psi_scales.append(int_psi[reix][::-1])
+
+        # Setup filterbank generator
+        self._state.fbgen = filterbank(
+            self._state.int_psi_scales,
+            mode=FilterbankMode.CONV,
+            min_phase=self.settings.min_phase,
+            axis=self.settings.axis,
+        )
 
-        conv_msg = fbgen.send(msg_in)
+        # Create output template
+        ax_idx = message.get_axis_idx(self.settings.axis)
+        in_shape = message.data.shape[:ax_idx] + message.data.shape[ax_idx + 1 :]
+        freqs = (
+            pywt.scale2frequency(wavelet, scales, precision)
+            / message.axes[self.settings.axis].gain
+        )
+        dummy_shape = in_shape + (len(scales), 0)
+        self._state.template = AxisArray(
+            np.zeros(dummy_shape, dtype=dt_cplx if wavelet.complex_cwt else dt_data),
+            dims=message.dims[:ax_idx]
+            + message.dims[ax_idx + 1 :]
+            + ["freq", self.settings.axis],
+            axes={
+                **message.axes,
+                "freq": AxisArray.CoordinateAxis(unit="Hz", data=freqs, dims=["freq"]),
+            },
+            key=message.key,
+        )
+        self._state.last_conv_samp = np.zeros(
+            dummy_shape[:-1] + (1,), dtype=self._state.template.data.dtype
+        )
+
+    def _process(self, message: AxisArray) -> AxisArray:
+        conv_msg = self._state.fbgen.send(message)
 
         # Prepend with last_conv_samp before doing diff
-        dat = np.concatenate((last_conv_samp, conv_msg.data), axis=-1)
-        coef = neg_rt_scales * np.diff(dat, axis=-1)
-        # Store last_conv_samp for next iteration.
-        last_conv_samp = conv_msg.data[..., -1:]
+        dat = np.concatenate((self._state.last_conv_samp, conv_msg.data), axis=-1)
+        coef = self._state.neg_rt_scales * np.diff(dat, axis=-1)
+        # Store last_conv_samp for next iteration
+        self._state.last_conv_samp = conv_msg.data[..., -1:]
 
-        if template.data.dtype.kind != "c":
+        if self._state.template.data.dtype.kind != "c":
             coef = coef.real
 
         # pywt.cwt slices off the beginning and end of the result where the convolution overran. We don't have
         #  that luxury when streaming.
         # d = (coef.shape[-1] - msg_in.data.shape[ax_idx]) / 2.
         # coef = coef[..., math.floor(d):-math.ceil(d)]
-        msg_out = replace(
-            template, data=coef, axes={**template.axes, axis: msg_in.axes[axis]}
+        return replace(
+            self._state.template,
+            data=coef,
+            axes={
+                **self._state.template.axes,
+                self.settings.axis: message.axes[self.settings.axis],
+            },
         )
 
 
-class CWTSettings(ez.Settings):
-    """
-    Settings for :obj:`CWT`
-    See :obj:`cwt` for argument details.
-    """
-    frequencies: list | tuple | npt.NDArray | None
-    wavelet: str | pywt.ContinuousWavelet | pywt.Wavelet
-    min_phase: MinPhaseMode = MinPhaseMode.NONE
-    axis: str = "time"
-    scales: list | tuple | npt.NDArray | None = None
+class CWT(BaseTransformerUnit[CWTSettings, AxisArray, AxisArray, CWTTransformer]):
+    SETTINGS = CWTSettings
 
 
-class CWT(GenAxisArray):
-    """
-    :obj:`Unit` for :obj:`common_rereference`.
+def cwt(
+    frequencies: list | tuple | npt.NDArray | None,
+    wavelet: str | pywt.ContinuousWavelet | pywt.Wavelet,
+    min_phase: MinPhaseMode = MinPhaseMode.NONE,
+    axis: str = "time",
+    scales: list | tuple | npt.NDArray | None = None,
+) -> CWTTransformer:
     """
+    Perform a continuous wavelet transform.
+    The function is equivalent to the :obj:`pywt.cwt` function, but is designed to work with streaming data.
 
-    SETTINGS = CWTSettings
+    Args:
+        frequencies: The wavelet frequencies to use in Hz. If `None` provided then the scales will be used.
+          Note: frequencies will be sorted from smallest to largest.
+        wavelet: Wavelet object or name of wavelet to use.
+        min_phase: See filterbank MinPhaseMode for details.
+        axis: The target axis for operation. Note that this will be moved to the -1th dimension
+          because fft and matrix multiplication is much faster on the last axis.
+          This axis must be in the msg.axes and it must be of type AxisArray.LinearAxis.
+        scales: The scales to use. If None, the scales will be calculated from the frequencies.
+          Note: Scales will be sorted from largest to smallest.
+          Note: Use of scales is deprecated in favor of frequencies. Convert scales to frequencies using
+            `pywt.scale2frequency(wavelet, scales, precision=10) * fs` where fs is the sampling frequency.
 
-    def construct_generator(self):
-        self.STATE.gen = cwt(
-            frequencies=self.SETTINGS.frequencies,
-            wavelet=self.SETTINGS.wavelet,
-            min_phase=self.SETTINGS.min_phase,
-            axis=self.SETTINGS.axis,
-            scales=self.SETTINGS.scales,
+    Returns:
+        A primed Generator object that expects an :obj:`AxisArray` via `.send(axis_array)` of continuous data
+        and yields an :obj:`AxisArray` with a continuous wavelet transform in its data.
+    """
+    return CWTTransformer(
+        CWTSettings(
+            frequencies=frequencies,
+            wavelet=wavelet,
+            min_phase=min_phase,
+            axis=axis,
+            scales=scales,
         )
+    )