ezmsg.sigproc.math.log#

Functions

log(base=10.0, clip_zero=False)[source]#

Take the logarithm of the data. See np.log for more details.

Parameters:

  • base (float) – The base of the logarithm. Default is 10.

  • clip_zero (bool) – If True, clip the data to the minimum positive value of the data type before taking the log.

Return type:

LogTransformer

Returns: LogTransformer.

Classes

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

Bases: BaseTransformerUnit[LogSettings, AxisArray, AxisArray, LogTransformer]

Parameters:

settings (Settings | None)

SETTINGS#

alias of LogSettings

class LogSettings(base: float = 10.0, clip_zero: bool = False)[source]#

Bases: Settings

Parameters:
base: float = 10.0#

The base of the logarithm. Default is 10.

clip_zero: bool = False#

If True, clip the data to the minimum positive value of the data type before taking the log.

__init__(base=10.0, clip_zero=False)#
Parameters:
Return type:

None

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

Bases: BaseTransformer[LogSettings, AxisArray, AxisArray]

Parameters:

settings (SettingsType)

class LogSettings(base: float = 10.0, clip_zero: bool = False)[source]#

Bases: Settings

Parameters:
base: float = 10.0#

The base of the logarithm. Default is 10.

clip_zero: bool = False#

If True, clip the data to the minimum positive value of the data type before taking the log.

__init__(base=10.0, clip_zero=False)#
Parameters:
Return type:

None

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

Bases: BaseTransformer[LogSettings, AxisArray, AxisArray]

Parameters:

settings (SettingsType)

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

Bases: BaseTransformerUnit[LogSettings, AxisArray, AxisArray, LogTransformer]

Parameters:

settings (Settings | None)

SETTINGS#

alias of LogSettings

log(base=10.0, clip_zero=False)[source]#

Take the logarithm of the data. See np.log for more details.

Parameters:

  • base (float) – The base of the logarithm. Default is 10.

  • clip_zero (bool) – If True, clip the data to the minimum positive value of the data type before taking the log.

Return type:

LogTransformer

Returns: LogTransformer.