ezmsg.sigproc.math.clip#

Clips the data to be within the specified range.

Note

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

Functions

clip(min=None, max=None)[source]#

Clips the data to be within the specified range.

Parameters:

  • min (float | None) – Lower clip bound. If None, no lower clipping is applied.

  • max (float | None) – Upper clip bound. If None, no upper clipping is applied.

Returns:

ClipTransformer.

Return type:

ClipTransformer

Classes

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

Bases: BaseTransformerUnit[ClipSettings, AxisArray, AxisArray, ClipTransformer]

Parameters:

settings (Settings | None)

SETTINGS#

alias of ClipSettings

class ClipSettings(min: float | None = None, max: float | None = None)[source]#

Bases: Settings

Parameters:
min: float | None = None#

Lower clip bound. If None, no lower clipping is applied.

max: float | None = None#

Upper clip bound. If None, no upper clipping is applied.

__init__(min=None, max=None)#
Parameters:
Return type:

None

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

Bases: BaseTransformer[ClipSettings, AxisArray, AxisArray]

Parameters:

settings (SettingsType)

class ClipSettings(min: float | None = None, max: float | None = None)[source]#

Bases: Settings

Parameters:
min: float | None = None#

Lower clip bound. If None, no lower clipping is applied.

max: float | None = None#

Upper clip bound. If None, no upper clipping is applied.

__init__(min=None, max=None)#
Parameters:
Return type:

None

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

Bases: BaseTransformer[ClipSettings, AxisArray, AxisArray]

Parameters:

settings (SettingsType)

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

Bases: BaseTransformerUnit[ClipSettings, AxisArray, AxisArray, ClipTransformer]

Parameters:

settings (Settings | None)

SETTINGS#

alias of ClipSettings

clip(min=None, max=None)[source]#

Clips the data to be within the specified range.

Parameters:

  • min (float | None) – Lower clip bound. If None, no lower clipping is applied.

  • max (float | None) – Upper clip bound. If None, no upper clipping is applied.

Returns:

ClipTransformer.

Return type:

ClipTransformer