ezmsg.sigproc.affinetransform

Functions

affine_transform(weights, axis=None, right_multiply=True)

Perform affine transformations on streaming data.

Parameters:

• weights (ndarray | str | Path) – An array of weights or a path to a file with weights compatible with np.loadtxt.

• axis (str | None) – The name of the axis to apply the transformation to. Defaults to the leading (0th) axis in the array.

• right_multiply (bool) – Set False to transpose the weights before applying.

Returns:

AffineTransformTransformer.

Return type:

AffineTransformTransformer

common_rereference(mode='mean', axis=None, include_current=True)

Perform common average referencing (CAR) on streaming data.

Parameters:

• mode (str) – The statistical mode to apply – either “mean” or “median”

• axis (str | None) – The name of hte axis to apply the transformation to.

• include_current (bool) – Set False to exclude each channel from participating in the calculation of its reference.

Returns:

CommonRereferenceTransformer

Return type:

CommonRereferenceTransformer

zeros_for_noop(data, **ignore_kwargs)

Parameters:

data (ndarray[tuple[Any, ...], dtype[_ScalarT]])

Return type:

ndarray[tuple[Any, …], dtype[_ScalarT]]

Classes

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

Bases: BaseTransformerUnit[AffineTransformSettings, AxisArray, AxisArray, AffineTransformTransformer]

Parameters:

settings (Settings | None)

SETTINGS

alias of AffineTransformSettings

class AffineTransformSettings(weights, axis=None, right_multiply=True)

Bases: Settings

Settings for AffineTransform. See affine_transform for argument details.

Parameters:

• weights (ndarray | str | Path)

• axis (str | None)

• right_multiply (bool)

weights: ndarray | str | Path

An array of weights or a path to a file with weights compatible with np.loadtxt.

axis: str | None = None

The name of the axis to apply the transformation to. Defaults to the leading (0th) axis in the array.

right_multiply: bool = True

Set False to transpose the weights before applying.

__init__(weights, axis=None, right_multiply=True)

Parameters:

• weights (ndarray | str | Path)

• axis (str | None)

• right_multiply (bool)

Return type:

None

class AffineTransformState

Bases: object

weights: ndarray[tuple[Any, ...], dtype[_ScalarT]] | None = None

new_axis: AxisBase | None = None

class AffineTransformTransformer(*args, **kwargs)

Bases: BaseStatefulTransformer[AffineTransformSettings, AxisArray, AxisArray, AffineTransformState]

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

Bases: BaseTransformerUnit[CommonRereferenceSettings, AxisArray, AxisArray, CommonRereferenceTransformer]

Parameters:

settings (Settings | None)

SETTINGS

alias of CommonRereferenceSettings

class CommonRereferenceSettings(mode='mean', axis=None, include_current=True)

Bases: Settings

Settings for CommonRereference

Parameters:

• mode (str)

• axis (str | None)

• include_current (bool)

mode: str = 'mean'

The statistical mode to apply – either “mean” or “median”.

axis: str | None = None

The name of the axis to apply the transformation to.

__init__(mode='mean', axis=None, include_current=True)

Parameters:

• mode (str)

• axis (str | None)

• include_current (bool)

Return type:

None

include_current: bool = True

Set False to exclude each channel from participating in the calculation of its reference.

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

Bases: BaseTransformer[CommonRereferenceSettings, AxisArray, AxisArray]

Parameters:

settings (SettingsType)

class AffineTransformSettings(weights, axis=None, right_multiply=True)

Bases: Settings

Settings for AffineTransform. See affine_transform for argument details.

Parameters:

• weights (ndarray | str | Path)

• axis (str | None)

• right_multiply (bool)

weights: ndarray | str | Path

An array of weights or a path to a file with weights compatible with np.loadtxt.

axis: str | None = None

The name of the axis to apply the transformation to. Defaults to the leading (0th) axis in the array.

right_multiply: bool = True

Set False to transpose the weights before applying.

__init__(weights, axis=None, right_multiply=True)

Parameters:

• weights (ndarray | str | Path)

• axis (str | None)

• right_multiply (bool)

Return type:

None

class AffineTransformState

Bases: object

weights: ndarray[tuple[Any, ...], dtype[_ScalarT]] | None = None

new_axis: AxisBase | None = None

class AffineTransformTransformer(*args, **kwargs)

Bases: BaseStatefulTransformer[AffineTransformSettings, AxisArray, AxisArray, AffineTransformState]

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

Bases: BaseTransformerUnit[AffineTransformSettings, AxisArray, AxisArray, AffineTransformTransformer]

Parameters:

settings (Settings | None)

SETTINGS

alias of AffineTransformSettings

affine_transform(weights, axis=None, right_multiply=True)

Perform affine transformations on streaming data.

Parameters:

• weights (ndarray | str | Path) – An array of weights or a path to a file with weights compatible with np.loadtxt.

• axis (str | None) – The name of the axis to apply the transformation to. Defaults to the leading (0th) axis in the array.

• right_multiply (bool) – Set False to transpose the weights before applying.

Returns:

AffineTransformTransformer.

Return type:

AffineTransformTransformer

zeros_for_noop(data, **ignore_kwargs)

Parameters:

data (ndarray[tuple[Any, ...], dtype[_ScalarT]])

Return type:

ndarray[tuple[Any, …], dtype[_ScalarT]]

class CommonRereferenceSettings(mode='mean', axis=None, include_current=True)

Bases: Settings

Settings for CommonRereference

Parameters:

• mode (str)

• axis (str | None)

• include_current (bool)

mode: str = 'mean'

The statistical mode to apply – either “mean” or “median”.

axis: str | None = None

The name of the axis to apply the transformation to.

__init__(mode='mean', axis=None, include_current=True)

Parameters:

• mode (str)

• axis (str | None)

• include_current (bool)

Return type:

None

include_current: bool = True

Set False to exclude each channel from participating in the calculation of its reference.

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

Bases: BaseTransformer[CommonRereferenceSettings, AxisArray, AxisArray]

Parameters:

settings (SettingsType)

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

Bases: BaseTransformerUnit[CommonRereferenceSettings, AxisArray, AxisArray, CommonRereferenceTransformer]

Parameters:

settings (Settings | None)

SETTINGS

alias of CommonRereferenceSettings

common_rereference(mode='mean', axis=None, include_current=True)

Perform common average referencing (CAR) on streaming data.

Parameters:

• mode (str) – The statistical mode to apply – either “mean” or “median”

• axis (str | None) – The name of hte axis to apply the transformation to.

• include_current (bool) – Set False to exclude each channel from participating in the calculation of its reference.

Returns:

CommonRereferenceTransformer

Return type:

CommonRereferenceTransformer