cf.FieldAncillary.arcsinh

FieldAncillary.arcsinh(*args, **kwargs)[source]

Take the inverse hyperbolic sine 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.1.0.

See also

sinh

Parameters
inplace: bool, optional

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

Returns
FieldAncillary or None

The construct with the inverse hyperbolic sine 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.arcsinh()
>>> g.Units
<Units: radians>
>>> print(g.array)
[[0.48121183 0.65266657]
 [0.80886694 0.95034693]]

>>> print(f.array)
[1.2 1.0 0.8 0.6 --]
>>> f.arcsinh(inplace=True)
>>> print(f.array)
[1.015973134179692 0.881373587019543 0.732668256045411 0.5688248987322475
 --]