ezmsg.sigproc.math.clip

Functions

clip(a_min, a_max)

Clips the data to be within the specified range. See np.clip for more details.

Parameters:

• a_min (float) – Lower clip bound

• a_max (float) – Upper clip bound

Return type:

ClipTransformer

Returns: ClipTransformer.

Classes

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

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

Parameters:

settings (Settings | None)

SETTINGS

alias of ClipSettings

class ClipSettings(a_min: float, a_max: float)

Bases: Settings

Parameters:

• a_min (float)

• a_max (float)

a_min: float

Lower clip bound.

a_max: float

Upper clip bound.

__init__(a_min, a_max)

Parameters:

• a_min (float)

• a_max (float)

Return type:

None

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

Bases: BaseTransformer[ClipSettings, AxisArray, AxisArray]

Parameters:

settings (SettingsType)

class ClipSettings(a_min: float, a_max: float)

Bases: Settings

Parameters:

• a_min (float)

• a_max (float)

a_min: float

Lower clip bound.

a_max: float

Upper clip bound.

__init__(a_min, a_max)

Parameters:

• a_min (float)

• a_max (float)

Return type:

None

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

Bases: BaseTransformer[ClipSettings, AxisArray, AxisArray]

Parameters:

settings (SettingsType)

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

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

Parameters:

settings (Settings | None)

SETTINGS

alias of ClipSettings

clip(a_min, a_max)

Clips the data to be within the specified range. See np.clip for more details.

Parameters:

• a_min (float) – Lower clip bound

• a_max (float) – Upper clip bound

Return type:

ClipTransformer

Returns: ClipTransformer.