cf.FieldAncillary.arccosh

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

Take the inverse hyperbolic cosine 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

cosh, arcsinh, arctanh, arccos

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 cosine 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.arccosh()
>>> g.Units
<Units: radians>
>>> print(g.array)
[[       nan        nan]
 [       nan 0.44356825]]

>>> print(f.array)
[1.2 1.0 0.8 0.6 --]
>>> f.arccosh(inplace=True)
>>> print(f.array)
[0.6223625037147786 0.0 nan nan --]
>>> f.masked_invalid(inplace=True)
>>> print(f.array)
[0.6223625037147786 0.0 -- -- --]