cf.Index.cos

Index.cos(*args, **kwargs)

Take the trigonometric cosine of the data element-wise.

Units are accounted for in the calculation, so that the cosine of 90 degrees_east is 0.0, as is the cosine of 1.57079632 radians. If the units are not equivalent to radians (such as Kelvin) then they are treated as if they were radians.

The output units are ‘1’ (nondimensional).

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

See also

arccos, sin, tan, cosh

Parameters

inplace: bool, optional

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

i: deprecated at version 3.0.0

Use the inplace parameter instead.

Returns

Index or None

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

Examples:

>>> f.Units
<Units: degrees_east>
>>> print(f.array)
[[-90 0 90 --]]
>>> g = f.cos()
>>> g.Units
<Units: 1>
>>> print(g.array)
[[0.0 1.0 0.0 --]]

>>> f.Units
<Units: m s-1>
>>> print(f.array)
[[1 2 3 --]]
>>> f.cos(inplace=True)
>>> f.Units
<Units: 1>
>>> print(f.array)
[[0.540302305868 -0.416146836547 -0.9899924966 --]]