cf.FieldAncillary.override_units

FieldAncillary.override_units(units, i=False)[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 units or Units attributes to units which are equivalent to the original units.

See also

calendar, override_calendar, units, Units

Examples 1: 
>>> g = f.override_units('m')
Parameters:
units: str or cf.Units

The new units for the data array.

i: bool, optional

If True then update the field ancillary in place. By default a new field ancillary is created. In either case, a field ancillary is returned.
Returns:

out: cf.FieldAncillary
Examples 2: 
>>> f.Units
<CF Units: hPa>
>>> f.datum(0)
100000.0
>>> f.override_units('km')
>>> f.Units
<CF Units: km>
>>> f.datum(0)
100000.0
>>> f.override_units(cf.Units('watts'))
>>> f.Units
<CF Units: watts>
>>> f.datum(0)
100000.0