ezmsg-sigproc 1.6.0__py3-none-any.whl → 1.7.0__py3-none-any.whl

ezmsg/sigproc/__version__.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.6.0'
-__version_tuple__ = version_tuple = (1, 6, 0)
+__version__ = version = '1.7.0'
+__version_tuple__ = version_tuple = (1, 7, 0)

ezmsg/sigproc/decimate.py

@@ -1,8 +1,31 @@
+import typing
+
 import ezmsg.core as ez
 from ezmsg.util.messages.axisarray import AxisArray
 
 from .cheby import ChebyshevFilter, ChebyshevFilterSettings
 from .downsample import Downsample, DownsampleSettings
+from .filter import FilterCoefsMultiType
+
+
+class ChebyForDecimate(ChebyshevFilter):
+    """
+    A :obj:`ChebyshevFilter` node with a design filter method that additionally accepts a target sampling rate,
+     and if the target rate cannot be achieved it returns None, else it returns the filter coefficients.
+    """
+
+    def design_filter(
+        self,
+    ) -> typing.Callable[[float], FilterCoefsMultiType | None]:
+        def cheby_opt_design_fun(fs: float) -> FilterCoefsMultiType | None:
+            if fs is None:
+                return None
+            ds_factor = int(fs / (2.5 * self.SETTINGS.Wn))
+            if ds_factor < 2:
+                return None
+            partial_fun = super(ChebyForDecimate, self).design_filter()
+            return partial_fun(fs)
+        return cheby_opt_design_fun
 
 
 class Decimate(ez.Collection):
@@ -16,17 +39,18 @@ class Decimate(ez.Collection):
     INPUT_SIGNAL = ez.InputStream(AxisArray)
     OUTPUT_SIGNAL = ez.OutputStream(AxisArray)
 
-    FILTER = ChebyshevFilter()
+    FILTER = ChebyForDecimate()
     DOWNSAMPLE = Downsample()
 
     def configure(self) -> None:
+
         cheby_settings = ChebyshevFilterSettings(
-            order=8 if self.SETTINGS.factor > 1 else 0,
+            order=8,
             ripple_tol=0.05,
-            Wn=0.8 / self.SETTINGS.factor if self.SETTINGS.factor > 1 else None,
+            Wn=0.4 * self.SETTINGS.target_rate,
             btype="lowpass",
             axis=self.SETTINGS.axis,
-            wn_hz=False,
+            wn_hz=True,
         )
         self.FILTER.apply_settings(cheby_settings)
         self.DOWNSAMPLE.apply_settings(self.SETTINGS)

ezmsg/sigproc/downsample.py

@@ -14,7 +14,7 @@ from .base import GenAxisArray
 
 @consumer
 def downsample(
-    axis: str | None = None, factor: int = 1
+    axis: str | None = None, target_rate: float | None = None
 ) -> typing.Generator[AxisArray, AxisArray, None]:
     """
     Construct a generator that yields a downsampled version of the data .send() to it.
@@ -26,7 +26,8 @@ def downsample(
     Args:
         axis: The name of the axis along which to downsample.
             Note: The axis must exist in the message .axes and be of type AxisArray.LinearAxis.
-        factor: Downsampling factor.
+        target_rate: Desired rate after downsampling. The actual rate will be the nearest integer factor of the
+            input rate that is the same or higher than the target rate.
 
     Returns:
         A primed generator object ready to receive an :obj:`AxisArray` via `.send(axis_array)`
@@ -37,10 +38,8 @@ def downsample(
     """
     msg_out = AxisArray(np.array([]), dims=[""])
 
-    if factor < 1:
-        raise ValueError("Downsample factor must be at least 1 (no downsampling)")
-
     # state variables
+    factor: int = 0  # The integer downsampling factor. It will be determined based on the target rate.
     s_idx: int = 0  # Index of the next msg's first sample into the virtual rotating ds_factor counter.
 
     check_input = {"gain": None, "key": None}
@@ -62,6 +61,16 @@ def downsample(
             check_input["key"] = msg_in.key
             # Reset state variables
             s_idx = 0
+            if target_rate is None:
+                factor = 1
+            else:
+                factor = int(1 / (axis_info.gain * target_rate))
+            if factor < 1:
+                ez.logger.warning(
+                    f"Target rate {target_rate} cannot be achieved with input rate of {1/axis_info.gain}."
+                    "Setting factor to 1."
+                )
+                factor = 1
 
         n_samples = msg_in.data.shape[axis_idx]
         samples = np.arange(s_idx, s_idx + n_samples) % factor
@@ -97,7 +106,7 @@ class DownsampleSettings(ez.Settings):
     """
 
     axis: str | None = None
-    factor: int = 1
+    target_rate: float | None = None
 
 
 class Downsample(GenAxisArray):
@@ -107,5 +116,5 @@ class Downsample(GenAxisArray):
 
     def construct_generator(self):
         self.STATE.gen = downsample(
-            axis=self.SETTINGS.axis, factor=self.SETTINGS.factor
+            axis=self.SETTINGS.axis, target_rate=self.SETTINGS.target_rate
         )

{ezmsg_sigproc-1.6.0.dist-info → ezmsg_sigproc-1.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ezmsg-sigproc
-Version: 1.6.0
+Version: 1.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>
 License: MIT

{ezmsg_sigproc-1.6.0.dist-info → ezmsg_sigproc-1.7.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 ezmsg/sigproc/__init__.py,sha256=8K4IcOA3-pfzadoM6s2Sfg5460KlJUocGgyTJTJl96U,52
-ezmsg/sigproc/__version__.py,sha256=Ry70pc5l-IBhT9gahlkNwZPp4g0CzVEWqsat9H-UASY,411
+ezmsg/sigproc/__version__.py,sha256=2fEqxujmrV2dsREie2BmOYFLu66FowyHtZT2AoLuIzU,411
 ezmsg/sigproc/activation.py,sha256=LM-MtaNvFvmBZ1_EPNu--4K3-wIzsb7CUQ00fvMM69g,2642
 ezmsg/sigproc/affinetransform.py,sha256=R2P1f5JdNSpr30x8Pxoqv-J-nAasGl_UZR8o7sVqlaQ,8740
 ezmsg/sigproc/aggregate.py,sha256=6BqAujWe7_zzGPDJz7yh4ofPzJTU5z2lrclX-IuqXDU,6235
@@ -7,8 +7,8 @@ ezmsg/sigproc/bandpower.py,sha256=Mx8iUU-UMWKK5sgCXvxpUSA3522rW8Jg96asrT8MdpA,21
 ezmsg/sigproc/base.py,sha256=vut0BLjgc0mxYRbs7tDd9XzwRFA2_GcsgXZmIYovR0Y,1248
 ezmsg/sigproc/butterworthfilter.py,sha256=vZTY37FfLwa24bRZmeZGyO5323824wJosUrrZarb0_o,5402
 ezmsg/sigproc/cheby.py,sha256=yds5y1fOeBE1ljyH_EreBLxqFX4UetxB_3rwz3omHyc,3394
-ezmsg/sigproc/decimate.py,sha256=Cu2weOIKGoo_pUSpA90N47kuzcT6s7OAa1HaF7u3cY0,1286
-ezmsg/sigproc/downsample.py,sha256=oJ0VOZ0UrLAhce2bolSom23LD8Ob-8LCOmzqkrZCJ0E,3454
+ezmsg/sigproc/decimate.py,sha256=qxZoGmriviTNIUvTOA--U65CPWD1uTvQ9pij79-u00Q,2044
+ezmsg/sigproc/downsample.py,sha256=PYdrp7p6subP_qbGB2-3C14bd8W4tvC5oMKEmERQZmk,4049
 ezmsg/sigproc/ewmfilter.py,sha256=EPlocRdKORj575VV1YUzcNsVcq-pYgdEJ7_m9WfpVnY,4795
 ezmsg/sigproc/filter.py,sha256=n3_gColSPXe4pI-A2VDKfrdFHZgC-k4kqB8H6tnGIws,6969
 ezmsg/sigproc/filterbank.py,sha256=pySLNGppnG6Dx9r5jQpNSyWhd9qmvj6up2udG7RMNok,12410
@@ -30,7 +30,7 @@ ezmsg/sigproc/math/difference.py,sha256=I96Md2pyfCU5TSw35u1uS6FaPJRv0JpHQVhrTHv1
 ezmsg/sigproc/math/invert.py,sha256=T6PEhBCquKRJQF6LfUgqjXKSBsS_tvi4BJAqJ_5VCjw,895
 ezmsg/sigproc/math/log.py,sha256=i-iF2WDH18RWapYwlhAsiDdhzvuJY9mDWrNtjfuiyL8,1572
 ezmsg/sigproc/math/scale.py,sha256=lQKF02Mv9nTWfgc4OcMpQMCx993p57GSN-AADeO2fjY,1063
-ezmsg_sigproc-1.6.0.dist-info/METADATA,sha256=-Y0s91NhAEO_KWsBo1KQKPQE4IDyU-xp51rOa8FuUAo,2343
-ezmsg_sigproc-1.6.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-ezmsg_sigproc-1.6.0.dist-info/licenses/LICENSE.txt,sha256=seu0tKhhAMPCUgc1XpXGGaCxY1YaYvFJwqFuQZAl2go,1100
-ezmsg_sigproc-1.6.0.dist-info/RECORD,,
+ezmsg_sigproc-1.7.0.dist-info/METADATA,sha256=Nnz-8hSZBErjldQf3kxBfZ7xEtr9Woi9boBBVFtZ3DI,2343
+ezmsg_sigproc-1.7.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+ezmsg_sigproc-1.7.0.dist-info/licenses/LICENSE.txt,sha256=seu0tKhhAMPCUgc1XpXGGaCxY1YaYvFJwqFuQZAl2go,1100
+ezmsg_sigproc-1.7.0.dist-info/RECORD,,