cf.DomainAncillary.sinh

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

Take the hyperbolic sine of the data element-wise.

Units are accounted for in the calculation. If the units are not equivalent to radians (such as Kelvin) then they are treated as if they were radians. For example, the the hyperbolic sine of 90 degrees_north is 2.30129890, as is the hyperbolic sine of 1.57079632 radians.

The output units are changed to ‘1’ (nondimensional).

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

New in version 3.1.0.

See also

arcsinh, cosh, tanh, sin

Parameters
inplace: bool, optional

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

Returns
DomainAncillary or None

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

Examples

>>> f.Units
<Units: degrees_north>
>>> print(f.array)
[[-90 0 90 --]]
>>> g = f.sinh(inplace=True)
>>> g.Units
<Units: 1>
>>> print(g.array)
[[-2.3012989023072947 0.0 2.3012989023072947 --]]

>>> f.Units
<Units: m s-1>
>>> print(f.array)
[[1 2 3 --]]
>>> f.sinh(inplace=True)
>>> f.Units
<Units: 1>
>>> print(f.array)
[[1.1752011936438014 3.626860407847019 10.017874927409903 --]]