gstools.transform.boxcox
- gstools.transform.boxcox(fld, lmbda=1, shift=0, field='field', store=True, process=False, keep_mean=True)[source]
(Inverse) Box-Cox transformation to denormalize data.
After this transformation, the again Box-Cox transformed field is normal distributed.
See: https://en.wikipedia.org/wiki/Power_transform#Box%E2%80%93Cox_transformation
- Parameters
fld (
Field
) – Field class containing a generated field.lmbda (
float
, optional) – The lambda parameter of the Box-Cox transformation. Forlmbda=0
one obtains the log-normal transformation. Default:1
shift (
float
, optional) – The shift parameter from the two-parametric Box-Cox transformation. The field will be shifted by that value before transformation. Default:0
field (
str
, optional) – Name of field to be transformed. The default is “field”.store (
str
orbool
, optional) – Whether to store field inplace (True/False) or under a given name. The default is True.process (
bool
, optional) – Whether to process in/out fields with trend, normalizer and mean of given Field instance. The default is False.keep_mean (
bool
, optional) – Whether to keep the mean of the field if process=True. The default is True.
- Returns
Transformed field.
- Return type