gstools.transform.binary

gstools.transform.binary(fld, divide=None, upper=None, lower=None, field='field', store=True, process=False, keep_mean=True)[source]

Binary transformation.

After this transformation, the field only has two values.

Parameters:

fld (Field) – Field class containing a generated field.
divide (float, optional) – The dividing value. Default: fld.mean
upper (float, optional) – The resulting upper value of the field. Default: mean + sqrt(fld.model.sill)
lower (float, optional) – The resulting lower value of the field. Default: mean - sqrt(fld.model.sill)
field (str, optional) – Name of field to be transformed. The default is “field”.
store (str or bool, 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:

numpy.ndarray