cf.Field.override_units

Field.override_units(*args, **kwargs)[source]

Override the units.

The new units need not be equivalent to the original ones, and the data array elements will not be changed to reflect the new units. Therefore, this method should only be used when it is known that the data array values are correct but the units have incorrectly encoded.

Not to be confused with setting the units or Units attributes to units which are equivalent to the original units.

See also

calendar, override_calendar, units, Units

Parameters
units: str or Units

The new units for the data array.

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

Field or None

TODO

Examples

>>> f.Units
<Units: hPa>
>>> f.datum(0)
100000.0
>>> f.override_units('km', inplace=True)
>>> f.Units
<Units: km>
>>> f.datum(0)
100000.0
>>> f.override_units(Units('watts'), inplace=True)
>>> f.Units
<Units: watts>
>>> f.datum(0)
100000.0