ezmsg.sigproc.diff

Compute differences along an axis.

Note

This module supports the Array API standard, enabling use with NumPy, CuPy, PyTorch, and other compatible array libraries.

Functions

diff(axis=None, scale_by_fs=False)

Parameters:

• axis (str | None)

• scale_by_fs (bool)

Return type:

DiffTransformer

Classes

class DiffSettings(axis: str | None = None, scale_by_fs: bool = False)

Bases: Settings

Parameters:

• axis (str | None)

• scale_by_fs (bool)

axis: str | None = None

Deprecated since version 3.8.

Scheduled for removal in 4.0. The dimension messages accumulate along now comes from stream_dim; see ezmsg.sigproc.util.deprecation.

scale_by_fs: bool = False

__init__(axis=None, scale_by_fs=False)

Parameters:

• axis (str | None)

• scale_by_fs (bool)

Return type:

None

class DiffState

Bases: object

last_dat: NDArray | None = None

last_time: float | None = None

class DiffTransformer(*args, **kwargs)

Bases: BaseStatefulTransformer[DiffSettings, AxisArray, AxisArray, DiffState]

class DiffUnit(*args, settings=None, **kwargs)

Bases: BaseTransformerUnit[DiffSettings, AxisArray, AxisArray, DiffTransformer]

Parameters:

settings (Settings | None)

SETTINGS

alias of DiffSettings