Deprecate boundary() for geographic_boundary()

docs/source/howtos/spherical_geometry.rst

@@ -73,7 +73,7 @@ satellite passes. See trollschedule_ how to generate a list of satellite overpas
 
  >>> from pyresample.spherical_utils import GetNonOverlapUnions
 
- >>> area_boundary = area_def.boundary(vertices_per_side=100) # doctest: +SKIP
+ >>> area_boundary = area_def.geographic_boundary(vertices_per_side=100) # doctest: +SKIP
  >>> area_boundary = area_boundary.contour_poly # doctest: +SKIP
 
  >>> list_of_polygons = []

pyresample/future/geometry/_subset.py

@@ -103,7 +103,7 @@ def _get_area_boundary(area_to_cover: AreaDefinition) -> GeographicBoundary:
             vertices_per_side = None
         else:
             vertices_per_side = max(max(*area_to_cover.shape) // 100 + 1, 3)
-        return area_to_cover.boundary(vertices_per_side=vertices_per_side, force_clockwise=True)
+        return area_to_cover.geographic_boundary(vertices_per_side=vertices_per_side, order="clockwise")
     except ValueError as err:
         raise NotImplementedError("Can't determine boundary of area to cover") from err
 

pyresample/geometry.py

@@ -292,7 +292,8 @@ def is_geostationary(self):
         """Whether this geometry is in a geostationary satellite projection or not."""
         return False
 
-    def get_bbox_lonlats(self, vertices_per_side: Optional[int] = None, force_clockwise: bool = True,
+    def get_bbox_lonlats(self, vertices_per_side: Optional[int] = None,
+                         force_clockwise: bool = True,
                          frequency: Optional[int] = None) -> tuple:
         """Return the bounding box lons and lats sides.
 
@@ -335,7 +336,7 @@ def get_bbox_lonlats(self, vertices_per_side: Optional[int] = None, force_clockw
         vertices_per_side = vertices_per_side or frequency
         sides_lons, sides_lats = self._get_boundary_sides(coordinates="geographic",
                                                           vertices_per_side=vertices_per_side)
-        warnings.warn("`get_bbox_lonlats` is pending deprecation. Use `area.boundary().sides` instead",
+        warnings.warn("`get_bbox_lonlats` is pending deprecation. Use `area.geographic_boundary().sides` instead",
                       PendingDeprecationWarning, stacklevel=2)
         if force_clockwise and not self._corner_is_clockwise(
                 sides_lons[0][-2], sides_lats[0][-2],
@@ -518,10 +519,10 @@ def get_edge_lonlats(self, vertices_per_side=None, frequency=None):
             warnings.warn("The `frequency` argument is pending deprecation, use `vertices_per_side` instead.",
                           PendingDeprecationWarning, stacklevel=2)
         msg = "`get_edge_lonlats` is pending deprecation"
-        msg += "Use `area.boundary(vertices_per_side=vertices_per_side).contour()` instead."
+        msg += "Use `area.geographic_boundary(vertices_per_side=vertices_per_side).contour()` instead."
         warnings.warn(msg, PendingDeprecationWarning, stacklevel=2)
         vertices_per_side = vertices_per_side or frequency
-        lons, lats = self.boundary(vertices_per_side=vertices_per_side).contour()
+        lons, lats = self.geographic_boundary(vertices_per_side=vertices_per_side).contour()
         return lons, lats
 
     def boundary(self, *, vertices_per_side=None, force_clockwise=False, frequency=None):
@@ -1121,7 +1122,7 @@ def compute_optimal_bb_area(self, proj_dict=None, resolution=None):
         proj_dict = self.compute_bb_proj_params(proj_dict)
 
         area = DynamicAreaDefinition(area_id, description, proj_dict)
-        lons, lats = self.boundary(vertices_per_side=None).contour()
+        lons, lats = self.geographic_boundary(vertices_per_side=None).contour()
         return area.freeze((lons, lats), shape=(height, width))
 
 
@@ -2910,7 +2911,7 @@ def get_geostationary_bounding_box(geos_area, nb_points=50):
 
     """
     warnings.warn("'get_geostationary_bounding_box' is deprecated. Please call "
-                  "'area.boundary().contour()' instead.",
+                  "'area.geographic_boundary().contour()' instead.",
                   DeprecationWarning, stacklevel=2)
     return _get_geostationary_bounding_box_in_lonlats(geos_area, nb_points)
 

pyresample/gradient/__init__.py

@@ -373,7 +373,7 @@ def _get_border_lonlats(geo_def: AreaDefinition, vertices_per_side=None):
     """Get the border x- and y-coordinates."""
     if geo_def.is_geostationary:
         vertices_per_side = 3600
-    lon_b, lat_b = geo_def.boundary(vertices_per_side=vertices_per_side).contour(closed=True)
+    lon_b, lat_b = geo_def.geographic_boundary(vertices_per_side=vertices_per_side).contour(closed=True)
     return lon_b, lat_b
 
 

pyresample/slicer.py

@@ -128,7 +128,7 @@ def _get_chunk_polygons_for_swath_to_crop(swath_to_crop):
         line_slice = expand_slice(line_slice)
         col_slice = expand_slice(col_slice)
         smaller_swath = swath_to_crop[line_slice, col_slice]
-        smaller_poly = smaller_swath.boundary(vertices_per_side=10).polygon(shapely=True)
+        smaller_poly = smaller_swath.geographic_boundary(vertices_per_side=10).polygon(shapely=True)
         res.append((smaller_poly, (line_slice, col_slice)))
     return res
 

pyresample/test/test_geometry/test_area.py

@@ -2113,7 +2113,7 @@ def test_get_boundary_sides_call_geostationary_utility(self, request, area_def_n
     def test_polar_south_pole_projection(self, south_pole_area):
         """Test boundary for polar projection around the South Pole."""
         areadef = south_pole_area
-        boundary = areadef.boundary(force_clockwise=False)
+        boundary = areadef.geographic_boundary(order=None)
 
         # Check boundary shape
         height, width = areadef.shape
@@ -2131,7 +2131,7 @@ def test_north_pole_projection(self, north_pole_area):
         """Test boundary for polar projection around the North Pole."""
         areadef = north_pole_area
 
-        boundary = areadef.boundary(force_clockwise=False)
+        boundary = areadef.geographic_boundary(order=None)
 
         # Check boundary shape
         height, width = areadef.shape
@@ -2151,24 +2151,24 @@ def test_full_disc_geostationary_projection(self, geos_fd_area):
 
         # Check default boundary shape
         default_n_vertices = 50
-        boundary = areadef.boundary(vertices_per_side=None)
+        boundary = areadef.geographic_boundary(vertices_per_side=None, order=None)
         assert boundary.vertices.shape == (default_n_vertices, 2)
 
         # Check minimum boundary vertices
         n_vertices = 3
         minimum_n_vertices = 4
-        boundary = areadef.boundary(vertices_per_side=n_vertices)
+        boundary = areadef.geographic_boundary(vertices_per_side=n_vertices, order=None)
         assert boundary.vertices.shape == (minimum_n_vertices, 2)
 
         # Check odd number of vertices per side
         # - Rounded to the sequent even number (to construct the sides)
         n_odd_vertices = 5
-        boundary = areadef.boundary(vertices_per_side=n_odd_vertices)
+        boundary = areadef.geographic_boundary(vertices_per_side=n_odd_vertices)
         assert boundary.vertices.shape == (n_odd_vertices + 1, 2)
 
         # Check boundary vertices
         n_vertices = 10
-        boundary = areadef.boundary(vertices_per_side=n_vertices, force_clockwise=False)
+        boundary = areadef.geographic_boundary(vertices_per_side=n_vertices, order=None)
 
         # Check boundary vertices is in correct order
         expected_vertices = np.array([[-7.54251621e+01, 3.53432890e+01],
@@ -2186,7 +2186,7 @@ def test_full_disc_geostationary_projection(self, geos_fd_area):
     def test_global_platee_caree_projection(self, global_platee_caree_area):
         """Test boundary for global platee caree projection."""
         areadef = global_platee_caree_area
-        boundary = areadef.boundary(force_clockwise=False)
+        boundary = areadef.geographic_boundary(order=None)
 
         # Check boundary shape
         height, width = areadef.shape
@@ -2211,7 +2211,7 @@ def test_global_platee_caree_projection(self, global_platee_caree_area):
     def test_minimal_global_platee_caree_projection(self, global_platee_caree_minimum_area):
         """Test boundary for global platee caree projection."""
         areadef = global_platee_caree_minimum_area
-        boundary = areadef.boundary(force_clockwise=False)
+        boundary = areadef.geographic_boundary(order=None)
 
         # Check boundary shape
         height, width = areadef.shape
@@ -2228,7 +2228,7 @@ def test_minimal_global_platee_caree_projection(self, global_platee_caree_minimu
     def test_local_area_projection(self, local_meter_area):
         """Test local area projection in meter."""
         areadef = local_meter_area
-        boundary = areadef.boundary(force_clockwise=False)
+        boundary = areadef.geographic_boundary(order=None)
 
         # Check boundary shape
         height, width = areadef.shape

pyresample/test/test_geometry/test_swath.py

@@ -604,7 +604,7 @@ def test_swath_definition(self, create_test_swath):
 
         # Define SwathDefinition and retrieve GeographicBoundary
         swath_def = create_test_swath(lons, lats)
-        boundary = swath_def.boundary(force_clockwise=False)
+        boundary = swath_def.geographic_boundary(order=None)
 
         # Check boundary shape
         height, width = swath_def.shape