log

Luo_Suppe2026-08-15

gma.math.correction.log

[function] log(data, constant = 1, ignore_value = None, inverse = False):

Logarithmic transformation. Reference equation: Out = log2(1 + (data - vmin) / vptp) * vptp * constant.

Parameters:

data: array.

The data to be corrected.

**Optional:

constant = float. Default 1.

The constant term of the correction factor.

ignore_value = float||None. Default None.

The value that is not involved in the calculation.

inverse = bool. Default False.

Whether to perform the inverse change.

Returns:

Type: array.