Rename _GMT_DATASET.to_dataframe to .to_pandas and _GMT_GRID.to_dataarray/_GMT_IMAGE.to_dataarray to .to_xarray (#3798)

Author: seisman

pygmt/clib/session.py

@@ -2204,7 +2204,7 @@ def virtualfile_to_dataset(
         if output_type == "strings":  # strings output
             return result.to_strings()
 
-        result = result.to_dataframe(
+        result = result.to_pandas(
             header=header, column_names=column_names, dtype=dtype, index_col=index_col
         )
         if output_type == "numpy":  # numpy.ndarray output
@@ -2273,7 +2273,7 @@ def virtualfile_to_raster(
                 self["GMT_IS_IMAGE"]: "image",
                 self["GMT_IS_CUBE"]: "cube",
             }[family]
-        return self.read_virtualfile(vfname, kind=kind).contents.to_dataarray()
+        return self.read_virtualfile(vfname, kind=kind).contents.to_xarray()
 
     def extract_region(self) -> np.ndarray:
         """

pygmt/datatypes/dataset.py

@@ -172,7 +172,7 @@ def to_strings(self) -> np.ndarray[Any, np.dtype[np.str_]]:
             textvector = [item if item is not None else b"" for item in textvector]
         return np.char.decode(textvector) if textvector else np.array([], dtype=np.str_)
 
-    def to_dataframe(
+    def to_pandas(
         self,
         header: int | None = None,
         column_names: pd.Index | None = None,
@@ -229,7 +229,7 @@ def to_dataframe(
         ...             lib.call_module("read", [tmpfile.name, vouttbl, "-Td"])
         ...             ds = lib.read_virtualfile(vouttbl, kind="dataset")
         ...             text = ds.contents.to_strings()
-        ...             df = ds.contents.to_dataframe(header=0)
+        ...             df = ds.contents.to_pandas(header=0)
         >>> text
         array(['TEXT1 TEXT23', 'TEXT4 TEXT567', 'TEXT8 TEXT90',
            'TEXT123 TEXT456789'], dtype='<U18')

pygmt/datatypes/grid.py

@@ -95,7 +95,7 @@ class _GMT_GRID(ctp.Structure):  # noqa: N801
         ("hidden", ctp.c_void_p),
     ]
 
-    def to_dataarray(self) -> xr.DataArray:
+    def to_xarray(self) -> xr.DataArray:
         """
         Convert a _GMT_GRID object to a :class:`xarray.DataArray` object.
 
@@ -113,7 +113,7 @@ def to_dataarray(self) -> xr.DataArray:
         ...         # Read the grid from the virtual file
         ...         grid = lib.read_virtualfile(voutgrd, kind="grid")
         ...         # Convert to xarray.DataArray and use it later
-        ...         da = grid.contents.to_dataarray()
+        ...         da = grid.contents.to_xarray()
         >>> da  # doctest: +NORMALIZE_WHITESPACE, +ELLIPSIS
         <xarray.DataArray 'z' (lat: 14, lon: 8)>...
         array([[347.5, 344.5, 386. , 640.5, 617. , 579. , 646.5, 671. ],

pygmt/datatypes/image.py

@@ -96,7 +96,7 @@ class _GMT_IMAGE(ctp.Structure):  # noqa: N801
         ("hidden", ctp.c_void_p),
     ]
 
-    def to_dataarray(self) -> xr.DataArray:
+    def to_xarray(self) -> xr.DataArray:
         """
         Convert a _GMT_IMAGE object to an :class:`xarray.DataArray` object.
 
@@ -114,7 +114,7 @@ def to_dataarray(self) -> xr.DataArray:
         ...         # Read the image from the virtual file
         ...         image = lib.read_virtualfile(voutimg, kind="image")
         ...         # Convert to xarray.DataArray and use it later
-        ...         da = image.contents.to_dataarray()
+        ...         da = image.contents.to_xarray()
         >>> da  # doctest: +NORMALIZE_WHITESPACE, +ELLIPSIS
         <xarray.DataArray 'z' (band: 3, y: 180, x: 360)>...
         array([[[ 10,  10,  10, ...,  10,  10,  10],

pygmt/tests/test_clib_read_data.py

@@ -59,7 +59,7 @@ def test_clib_read_data_dataset():
 
         with Session() as lib:
             ds = lib.read_data(tmpfile.name, kind="dataset").contents
-            df = ds.to_dataframe(header=0)
+            df = ds.to_pandas(header=0)
             expected_df = pd.DataFrame(
                 data={
                     "x": [1.0, 4.0, 7.0, 10.0],
@@ -85,7 +85,7 @@ def test_clib_read_data_grid(expected_xrgrid):
     """
     with Session() as lib:
         grid = lib.read_data("@static_earth_relief.nc", kind="grid").contents
-        xrgrid = grid.to_dataarray()
+        xrgrid = grid.to_xarray()
         xr.testing.assert_equal(xrgrid, expected_xrgrid)
         assert grid.header.contents.n_bands == 1  # Explicitly check n_bands
 
@@ -113,7 +113,7 @@ def test_clib_read_data_grid_two_steps(expected_xrgrid):
         lib.read_data(infile, kind="grid", mode="GMT_DATA_ONLY", data=data_ptr)
 
         # Full check
-        xrgrid = data_ptr.contents.to_dataarray()
+        xrgrid = data_ptr.contents.to_xarray()
         xr.testing.assert_equal(xrgrid, expected_xrgrid)
 
 
@@ -126,7 +126,7 @@ def test_clib_read_data_grid_actual_image(expected_xrimage):
         # Explicitly check n_bands. Only one band is read for 3-band images.
         assert image.header.contents.n_bands == 1
 
-        xrimage = image.to_dataarray()
+        xrimage = image.to_xarray()
         assert xrimage.shape == (180, 360)
         assert xrimage.coords["x"].data.min() == -179.5
         assert xrimage.coords["x"].data.max() == 179.5
@@ -153,7 +153,7 @@ def test_clib_read_data_image(expected_xrimage):
     with Session() as lib:
         image = lib.read_data("@earth_day_01d", kind="image").contents
 
-        xrimage = image.to_dataarray()
+        xrimage = image.to_xarray()
         assert xrimage.shape == (3, 180, 360)
         assert xrimage.coords["x"].data.min() == -179.5
         assert xrimage.coords["x"].data.max() == 179.5
@@ -187,7 +187,7 @@ def test_clib_read_data_image_two_steps(expected_xrimage):
         # Read the data
         lib.read_data(infile, kind="image", mode="GMT_DATA_ONLY", data=data_ptr)
 
-        xrimage = image.to_dataarray()
+        xrimage = image.to_xarray()
         assert xrimage.shape == (3, 180, 360)
         assert xrimage.coords["x"].data.min() == -179.5
         assert xrimage.coords["x"].data.max() == 179.5