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='time', scale_by_fs=False)[source]#
Parameters:
Return type:

DiffTransformer

Classes

class DiffSettings(axis: str | None = None, scale_by_fs: bool = False)[source]#

Bases: Settings

Parameters:

  • axis (str | None)

  • scale_by_fs (bool)

axis: str | None = None#
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[source]#

Bases: object

last_dat: ndarray[tuple[Any, ...], dtype[_ScalarT]] | None = None#
last_time: float | None = None#
class DiffTransformer(*args, **kwargs)[source]#

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

class DiffUnit(*args, settings=None, **kwargs)[source]#

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

Parameters:

settings (Settings | None)

SETTINGS#

alias of DiffSettings

class DiffSettings(axis: str | None = None, scale_by_fs: bool = False)[source]#

Bases: Settings

Parameters:

  • axis (str | None)

  • scale_by_fs (bool)

axis: str | None = None#
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[source]#

Bases: object

last_dat: ndarray[tuple[Any, ...], dtype[_ScalarT]] | None = None#
last_time: float | None = None#
class DiffTransformer(*args, **kwargs)[source]#

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

class DiffUnit(*args, settings=None, **kwargs)[source]#

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

Parameters:

settings (Settings | None)

SETTINGS#

alias of DiffSettings

diff(axis='time', scale_by_fs=False)[source]#
Parameters:
Return type:

DiffTransformer