cf.Field.healpix_info

Field.healpix_info()[source]

Get information about the HEALPix grid, if there is one.

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

Added in version 3.20.0.

Returns:

dict

The information about the HEALPix axis, with some or all of the following dictionary keys:

  • 'coordinate_reference_key': The construct key of the healpix coordinate reference construct.

  • 'grid_mapping_name:healpix': The healpix coordinate reference construct.

  • 'indexing_scheme': The HEALPix indexing scheme.

  • 'refinement_level': The refinement level of the HEALPix grid.

  • 'domain_axis_key': The construct key of the HEALPix domain axis construct.

  • 'coordinate_key': The construct key of the healpix_index coordinate construct.

  • 'healpix_index': The healpix_index coordinate construct.

The dictionary will be empty if there is no HEALPix axis.

Examples

>>> f = cf.example_field(12)
>>> f.healpix_info()
{'coordinate_reference_key': 'coordinatereference0',
 'grid_mapping_name:healpix': <CF CoordinateReference: grid_mapping_name:healpix>,
 'indexing_scheme': 'nested',
 'refinement_level': 1,
 'domain_axis_key': 'domainaxis1',
 'coordinate_key': 'auxiliarycoordinate0',
 'healpix_index': <CF DimensionCoordinate: healpix_index(48)>}

>>> f = cf.example_field(0)
>>> healpix_info(f)
{}