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

ezmsg/sigproc/__version__.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.8.1'
-__version_tuple__ = version_tuple = (1, 8, 1)
+__version__ = version = '1.8.2'
+__version_tuple__ = version_tuple = (1, 8, 2)

ezmsg/sigproc/downsample.py

@@ -14,7 +14,7 @@ from .base import GenAxisArray
 
 @consumer
 def downsample(
-    axis: str | None = None, target_rate: float | None = None
+    axis: str | None = None, target_rate: float | None = None, factor: int | None = None
 ) -> typing.Generator[AxisArray, AxisArray, None]:
     """
     Construct a generator that yields a downsampled version of the data .send() to it.
@@ -28,6 +28,7 @@ def downsample(
             Note: The axis must exist in the message .axes and be of type AxisArray.LinearAxis.
         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.
+        factor: Explicitly specify downsample factor.  If specified, target_rate is ignored.
 
     Returns:
         A primed generator object ready to receive an :obj:`AxisArray` via `.send(axis_array)`
@@ -39,7 +40,7 @@ def downsample(
     msg_out = AxisArray(np.array([]), dims=[""])
 
     # state variables
-    factor: int = 0  # The integer downsampling factor. It will be determined based on the target rate.
+    q: 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}
@@ -61,19 +62,21 @@ def downsample(
             check_input["key"] = msg_in.key
             # Reset state variables
             s_idx = 0
-            if target_rate is None:
-                factor = 1
+            if factor is not None:
+                q = factor
+            elif target_rate is None:
+                q = 1
             else:
-                factor = int(1 / (axis_info.gain * target_rate))
-            if factor < 1:
+                q = int(1 / (axis_info.gain * target_rate))
+            if q < 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
+                q = 1
 
         n_samples = msg_in.data.shape[axis_idx]
-        samples = np.arange(s_idx, s_idx + n_samples) % factor
+        samples = np.arange(s_idx, s_idx + n_samples) % q
         if n_samples > 0:
             # Update state for next iteration.
             s_idx = samples[-1] + 1
@@ -92,7 +95,7 @@ def downsample(
                 **msg_in.axes,
                 axis: replace(
                     axis_info,
-                    gain=axis_info.gain * factor,
+                    gain=axis_info.gain * q,
                     offset=axis_info.offset + axis_info.gain * n_step,
                 ),
             },
@@ -107,6 +110,7 @@ class DownsampleSettings(ez.Settings):
 
     axis: str | None = None
     target_rate: float | None = None
+    factor: int | None = None
 
 
 class Downsample(GenAxisArray):
@@ -116,5 +120,7 @@ class Downsample(GenAxisArray):
 
     def construct_generator(self):
         self.STATE.gen = downsample(
-            axis=self.SETTINGS.axis, target_rate=self.SETTINGS.target_rate
+            axis=self.SETTINGS.axis,
+            target_rate=self.SETTINGS.target_rate,
+            factor=self.SETTINGS.factor,
         )

{ezmsg_sigproc-1.8.1.dist-info → ezmsg_sigproc-1.8.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ezmsg-sigproc
-Version: 1.8.1
+Version: 1.8.2
 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-Expression: MIT

{ezmsg_sigproc-1.8.1.dist-info → ezmsg_sigproc-1.8.2.dist-info}/RECORD

@@ -1,5 +1,5 @@
 ezmsg/sigproc/__init__.py,sha256=8K4IcOA3-pfzadoM6s2Sfg5460KlJUocGgyTJTJl96U,52
-ezmsg/sigproc/__version__.py,sha256=8ety3-vW-PuHKrxUFSl1a0H98STtZwISOYo9asXn_xo,511
+ezmsg/sigproc/__version__.py,sha256=zaeoU7Eq6PaWD3xKg_JynFq8PW2k7pyoCPnWj8bsvOI,511
 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
@@ -8,7 +8,7 @@ ezmsg/sigproc/base.py,sha256=1I0Dr8jz5u5mcdQu2SdrKAjujx2DQl05u9h0MO8yay0,1330
 ezmsg/sigproc/butterworthfilter.py,sha256=vZTY37FfLwa24bRZmeZGyO5323824wJosUrrZarb0_o,5402
 ezmsg/sigproc/cheby.py,sha256=yds5y1fOeBE1ljyH_EreBLxqFX4UetxB_3rwz3omHyc,3394
 ezmsg/sigproc/decimate.py,sha256=qxZoGmriviTNIUvTOA--U65CPWD1uTvQ9pij79-u00Q,2044
-ezmsg/sigproc/downsample.py,sha256=PYdrp7p6subP_qbGB2-3C14bd8W4tvC5oMKEmERQZmk,4049
+ezmsg/sigproc/downsample.py,sha256=qBv4WKRdFs_SRsG6aiL98tQ-XEVOtdAgfvhdLQx7szk,4282
 ezmsg/sigproc/ewmfilter.py,sha256=EPlocRdKORj575VV1YUzcNsVcq-pYgdEJ7_m9WfpVnY,4795
 ezmsg/sigproc/filter.py,sha256=n3_gColSPXe4pI-A2VDKfrdFHZgC-k4kqB8H6tnGIws,6969
 ezmsg/sigproc/filterbank.py,sha256=HqyVrvpnp2ZhzYE3BNBXC0IWStKq4nFC9F9-Mj8nxCQ,12562
@@ -33,7 +33,7 @@ ezmsg/sigproc/math/scale.py,sha256=lQKF02Mv9nTWfgc4OcMpQMCx993p57GSN-AADeO2fjY,1
 ezmsg/sigproc/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ezmsg/sigproc/util/profile.py,sha256=EZZ-GsvcgJEt1zP6bM26GfdKu7vhaqFtqFFGsM_AeC8,4670
 ezmsg/sigproc/util/sparse.py,sha256=8Ke0jh3jRPi_TwIdLTwLdojQiaqPs6QV-Edqpx81VoI,1036
-ezmsg_sigproc-1.8.1.dist-info/METADATA,sha256=BVy8Q7ckNa9Zh5U7fknMltU9MlAXKDMseHkp3j3xjiM,2439
-ezmsg_sigproc-1.8.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-ezmsg_sigproc-1.8.1.dist-info/licenses/LICENSE.txt,sha256=seu0tKhhAMPCUgc1XpXGGaCxY1YaYvFJwqFuQZAl2go,1100
-ezmsg_sigproc-1.8.1.dist-info/RECORD,,
+ezmsg_sigproc-1.8.2.dist-info/METADATA,sha256=uKEwp3mpeCvfC38hBDZ9JZB4ikAViYc7qnO7RSaFVqs,2439
+ezmsg_sigproc-1.8.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ezmsg_sigproc-1.8.2.dist-info/licenses/LICENSE.txt,sha256=seu0tKhhAMPCUgc1XpXGGaCxY1YaYvFJwqFuQZAl2go,1100
+ezmsg_sigproc-1.8.2.dist-info/RECORD,,