cf.Field.healpix_to_ugrid

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

Convert a HEALPix domain to a UGRID domain.

See CF Appendix F: Grid Mappings. https://doi.org/10.5281/zenodo.14274886

Added in version 3.20.0.

See also

healpix_info, create_latlon_coordinates

Parameters:
cache: bool, optional

If True (the default) then cache in memory the first and last of any newly-created UGRID coordinates and bounds. This may slightly slow down the coordinate creation process, but may greatly speed up, and reduce the memory requirement of, a future inspection of the coordinates and bounds. Even when cache is True, new cached coordinate values can only be created if the existing healpix_index coordinates themselves have cached first and last values.

inplace: bool, optional

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

Returns:
Field or None

The Field converted to UGRID, or None if the operation was in-place.

Examples

>>> f = cf.example_field(12)
>>> print(f)
Field: air_temperature (ncvar%tas)
----------------------------------
Data            : air_temperature(time(2), healpix_index(48)) K
Cell methods    : time(2): mean area: mean
Dimension coords: time(2) = [2025-06-16 00:00:00, 2025-07-16 12:00:00] proleptic_gregorian
                : healpix_index(48) = [0, ..., 47]
                : height(1) = [1.5] m
Coord references: grid_mapping_name:healpix
>>> print(f.healpix_to_ugrid())
Field: air_temperature (ncvar%tas)
----------------------------------
Data            : air_temperature(time(2), ncdim%cell(48)) K
Cell methods    : time(2): mean area: mean
Dimension coords: time(2) = [2025-06-16 00:00:00, 2025-07-16 12:00:00] proleptic_gregorian
                : height(1) = [1.5] m
Auxiliary coords: latitude(ncdim%cell(48)) = [19.47122063449069, ..., -19.47122063449069] degrees_north
                : longitude(ncdim%cell(48)) = [45.0, ..., 315.0] degrees_east
Coord references: grid_mapping_name:latitude_longitude
Topologies      : cell:face(ncdim%cell(48), 4) = [[774, ..., 3267]]