dev

Author: davidhassell

cf/data/dask_utils.py

@@ -469,8 +469,8 @@ def cf_healpix_bounds(
     a,
     indexing_scheme,
     refinement_level=None,
-    lat=False,
-    lon=False,
+    latitude=False,
+    longitude=False,
     pole_longitude=None,
 ):
     """Calculate HEALPix cell bounds.
@@ -511,10 +511,10 @@ def cf_healpix_bounds(
             ``'nested_unique'`` (in which case *refinement_level* may
             be `None`).
 
-        lat: `bool`, optional
+        latitude: `bool`, optional
             If True then return latitude bounds.
 
-        lon: `bool`, optional
+        longitude: `bool`, optional
             If True then return longitude bounds.
 
         pole_longitude: `None` or number
@@ -532,21 +532,21 @@ def cf_healpix_bounds(
     **Examples**
 
     >>> cf.data.dask_utils.cf_healpix_bounds(
-    ...     np.array([0, 1, 2, 3]), 'nested', 1, lat=True
+    ...     np.array([0, 1, 2, 3]), 'nested', 1, latitude=True
     )
     array([[41.8103149 , 19.47122063,  0.        , 19.47122063],
            [66.44353569, 41.8103149 , 19.47122063, 41.8103149 ],
            [66.44353569, 41.8103149 , 19.47122063, 41.8103149 ],
            [90.        , 66.44353569, 41.8103149 , 66.44353569]])
     >>> cf.data.dask_utils.cf_healpix_bounds(
-    ...     np.array([0, 1, 2, 3]), 'nested', 1, lon=True
+    ...     np.array([0, 1, 2, 3]), 'nested', 1, longitude=True
     )
     array([[45. , 22.5, 45. , 67.5],
            [90. , 45. , 67.5, 90. ],
            [ 0. ,  0. , 22.5, 45. ],
            [45. ,  0. , 45. , 90. ]])
     >>> cf.data.dask_utils.cf_healpix_bounds(
-    ...     np.array([0, 1, 2, 3]), 'nested', 1, lon=True,
+    ...     np.array([0, 1, 2, 3]), 'nested', 1, longitude=True,
     ...     pole_longitude=3.14159
     )
     array([[45.     , 22.5    , 45.     , 67.5    ],
@@ -573,9 +573,9 @@ def cf_healpix_bounds(
             f"healpix_index array has one dimension. Got shape {a.shape}"
         )
 
-    if lat:
+    if latitude:
         pos = 1
-    elif lon:
+    elif longitude:
         pos = 0
 
     if indexing_scheme == "ring":
@@ -639,7 +639,7 @@ def cf_healpix_bounds(
 
 
 def cf_healpix_coordinates(
-    a, indexing_scheme, refinement_level=None, lat=False, lon=False
+    a, indexing_scheme, refinement_level=None, latitude=False, longitude=False
 ):
     """Calculate HEALPix cell centre coordinates.
 
@@ -674,10 +674,10 @@ def cf_healpix_coordinates(
             ``'nested_unique'`` (in which case *refinement_level* may
             be `None`).
 
-        lat: `bool`, optional
+        latitude: `bool`, optional
             If True then return latitude coordinates.
 
-        lon: `bool`, optional
+        longitude: `bool`, optional
             If True then return longitude coordinates.
 
     :Returns:
@@ -688,11 +688,11 @@ def cf_healpix_coordinates(
     **Examples**
 
     >>> cf.data.dask_utils.cf_healpix_coordinates(
-    ...     np.array([0, 1, 2, 3]), 'nested', 1, lat=True
+    ...     np.array([0, 1, 2, 3]), 'nested', 1, latitude=True
     )
     array([19.47122063, 41.8103149 , 41.8103149 , 66.44353569])
     >>> cf.data.dask_utils.cf_healpix_coordinates(
-    ...     np.array([0, 1, 2, 3]), 'nested', 1, lon=True
+    ...     np.array([0, 1, 2, 3]), 'nested', 1, longitude=True
     )
     array([45. , 67.5, 22.5, 45. ])
 
@@ -714,9 +714,9 @@ def cf_healpix_coordinates(
             f"healpix_index array has one dimension. Got shape {a.shape}"
         )
 
-    if lat:
+    if latitude:
         pos = 1
-    elif lon:
+    elif longitude:
         pos = 0
 
     match indexing_scheme:

cf/docstring/docstring.py

@@ -98,7 +98,7 @@
         M. Reinecke and E. Hivon: Efficient data structures for masks
         on 2D grids. A&A, 580 (2015)
         A132. https://doi.org/10.1051/0004-6361/201526549""",
-   # ----------------------------------------------------------------
+    # ----------------------------------------------------------------
     # Method description substitutions (3 levels of indentation)
     # ----------------------------------------------------------------
     # i: deprecated at version 3.0.0

cf/domain.py

@@ -273,9 +273,9 @@ def create_healpix(
         HEALPix indices are monotonically increasing.
 
         **References**
-        
+
         {{HEALPix references}}
-        
+
         .. versionadded:: NEXTVERSION
 
         .. seealso:: `cf.Domain.create_regular`,
@@ -404,20 +404,23 @@ def create_healpix(
         axis = domain.set_construct(d, copy=False)
 
         # auxiliary_coordinate: healpix_index
-        c = domain._AuxiliaryCoordinate()
+        c = domain._DimensionCoordinate()
         c.set_properties({"standard_name": "healpix_index"})
         c.nc_set_variable("healpix_index")
 
         # Create the healpix_index data
         if nested_unique:
-            index0 = 4 ** (refinement_level + 1)
+            start = 4 ** (refinement_level + 1)
         else:
-            index0 = 0
+            start = 0
 
-        c.set_data(
-            Data(da.arange(index0, index0 + ncells), units="1"), copy=False
-        )
+        stop = start + ncells
+        data = Data(da.arange(start, stop), units="1")
+
+        # Set cached data elements
+        data._set_cached_elements({0: start, -1: stop - 1})
 
+        c.set_data(data, copy=False)
         key = domain.set_construct(c, axes=axis, copy=False)
 
         # coordinate_reference: grid_mapping_name:healpix

cf/field.py

@@ -180,8 +180,6 @@
 # --------------------------------------------------------------------
 _collapse_ddof_methods = set(("sd", "var"))
 
-# _earth_radius = Data(6371229.0, "m")
-
 _relational_methods = (
     "__eq__",
     "__ne__",
@@ -4855,7 +4853,7 @@ def healpix_decrease_refinement_level(
         is raised (assuming that *check_healpix_index* is True).
 
         **References**
-        
+
         {{HEALPix references}}
 
         .. versionadded:: NEXTVERSION
@@ -5227,12 +5225,6 @@ def healpix_decrease_refinement_level(
         # ------------------------------------------------------------
         # Change the refinement level of the healpix_index coordinates
         # ------------------------------------------------------------
-        if healpix_index.construct_type == "dimension_coordinate":
-            # Ensure that healpix indices are auxiliary coordinates
-            healpix_index = f._AuxiliaryCoordinate(
-                source=healpix_index, copy=False
-            )
-
         healpix_index = healpix_index[::ncells] // ncells
         hp_key = f.set_construct(healpix_index, axes=axis, copy=False)
 
@@ -5279,7 +5271,7 @@ def healpix_increase_refinement_level(self, refinement_level, quantity):
         values are not changed.
 
         **References**
-        
+
         {{HEALPix references}}
 
         .. versionadded:: NEXTVERSION
@@ -5536,11 +5528,6 @@ def healpix_increase_refinement_level(self, refinement_level, quantity):
         # Create the healpix_index coordinates for the new refinement
         # level, and put them into the Field.
         healpix_index = hp["healpix_index"]
-        if healpix_index.construct_type == "dimension_coordinate":
-            # Ensure that healpix indices are auxiliary coordinates
-            healpix_index = f._AuxiliaryCoordinate(
-                source=healpix_index, copy=False
-            )
 
         # Save any cached data elements
         data = healpix_index.data
@@ -5589,7 +5576,8 @@ def healpix_increase_refinement_level(self, refinement_level, quantity):
         cr.set_coordinate(hp_key)
 
         if create_latlon:
-            # Create lat/lon coordinates for the new refinement level
+            # Create 1-d lat/lon coordinates for the new refinement
+            # level
             f.create_latlon_coordinates(two_d=False, inplace=True)
 
         return f
@@ -6025,7 +6013,9 @@ def collapse(
         .. versionadded:: 1.0
 
         .. seealso:: `bin`, `cell_area`, `convolution_filter`,
-                     `moving_window`, `radius`, `weights`
+                     `moving_window`,
+                     `healpix_decrease_refinement_level`, `radius`,
+                     `weights`
 
         :Parameters:
 
@@ -7621,7 +7611,9 @@ def collapse(
                         f.del_coordinate_reference(ref_key)
 
             # --------------------------------------------------------
-            # Remove a HEALPix coordinate reference
+            # Remove a HEALPix Coordinate Reference and Dimension
+            # Coordinate. (A HEALPix Auxiliary Coordinate gets removed
+            # later with the other 1-d Auxiliary Coordinates.)
             # --------------------------------------------------------
             healpix_axis = f.domain_axis(
                 "healpix_index", key=True, default=None
@@ -7632,6 +7624,12 @@ def collapse(
 
                 del_healpix_coordinate_reference(f)
 
+                key = f.dimension_coordinate(
+                    "healpix_index", key=True, default=None
+                )
+                if key is not None:
+                    f.del_construct(key)
+
             # ---------------------------------------------------------
             # Update dimension coordinates, auxiliary coordinates,
             # cell measures and domain ancillaries

cf/healpix.py

@@ -96,7 +96,7 @@ def _healpix_create_latlon_coordinates(f, pole_longitude):
         meta=meta,
         indexing_scheme=indexing_scheme,
         refinement_level=refinement_level,
-        lat=True,
+        latitude=True,
     )
     lat = f._AuxiliaryCoordinate(
         data=f._Data(dy, "degrees_north", copy=False),
@@ -110,7 +110,7 @@ def _healpix_create_latlon_coordinates(f, pole_longitude):
         meta=meta,
         indexing_scheme=indexing_scheme,
         refinement_level=refinement_level,
-        lon=True,
+        longitude=True,
     )
     lon = f._AuxiliaryCoordinate(
         data=f._Data(dy, "degrees_east", copy=False),
@@ -128,7 +128,7 @@ def _healpix_create_latlon_coordinates(f, pole_longitude):
         meta=meta,
         indexing_scheme=indexing_scheme,
         refinement_level=refinement_level,
-        lat=True,
+        latitude=True,
     )
     bounds = f._Bounds(data=dy)
     lat.set_bounds(bounds)
@@ -143,7 +143,7 @@ def _healpix_create_latlon_coordinates(f, pole_longitude):
         meta=meta,
         indexing_scheme=indexing_scheme,
         refinement_level=refinement_level,
-        lon=True,
+        longitude=True,
         pole_longitude=pole_longitude,
     )
     bounds = f._Bounds(data=dy)