cf.DomainAncillary.arctanh

DomainAncillary.arctanh(*args, **kwargs)[source]

Take the inverse hyperbolic tangent of the data element-wise.

Units are ignored in the calculation. The result has units of radians.

The “standard_name” and “long_name” properties are removed from the result.

New in version 3.2.0.

See also

tanh, arcsinh, arccosh, arctan

Parameters
inplace: bool, optional

If True then do the operation in-place and return None.

Returns
DomainAncillary or None

The construct with the inverse hyperbolic tangent of data values. If the operation was in-place then None is returned.

Examples

>>> print(f.array)
[[0.5 0.7]
 [0.9 1.1]]
>>> g = f.arctanh()
>>> g.Units
<Units: radians>
>>> print(g.array)
[[0.54930614 0.86730053]
 [1.47221949        nan]]

>>> print(f.array)
[1.2 1.0 0.8 0.6 --]
>>> f.arctanh(inplace=True)
>>> print(f.array)
[nan inf 1.0986122886681098 0.6931471805599453 --]
>>> f.mask_invalid(inplace=True)
>>> print(f.array)
[-- -- 1.0986122886681098 0.6931471805599453 --]