cf.AuxiliaryCoordinate.arcsinh

AuxiliaryCoordinate.arcsinh(bounds=True, inplace=False)[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

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

Examples:

>>> d = cf.Data([[0, 1, 2], [3, -99, 5]], mask=[[0, 0, 0], [0, 1, 0]])
>>> print(d.array)
[[0  1 2]
 [3 -- 5]]
>>> e = d.arcsinh()
>>> e
<CF Data(2, 3): [[0.0, ..., 2.3124383412727525]] radians>
>>> print(e.array)
[[0.0 0.881373587019543 1.4436354751788103]
 [1.8184464592320668 -- 2.3124383412727525]]