Use enums GridType and GridReg in tests

Author: seisman

pygmt/datatypes/grid.py

@@ -165,7 +165,7 @@ def to_dataarray(self) -> xr.DataArray:
             axis:           Y
             actual_range:   [-24. -10.]
         >>> da.gmt.registration, da.gmt.gtype
-        (1, 1)
+        (<GridReg.PIXEL: 1>, <GridType.GEOGRAPHIC: 1>)
         """
         # The grid header
         header = self.header.contents

pygmt/datatypes/image.py

@@ -166,7 +166,7 @@ def to_dataarray(self) -> xr.DataArray:
             axis:          Y
             actual_range:  [-90.  90.]
         >>> da.gmt.registration, da.gmt.gtype
-        (1, 1)
+        (<GridReg.PIXEL: 1>, <GridType.GEOGRAPHIC: 1>)
         """
         # The image header
         header = self.header.contents

pygmt/src/tilemap.py

@@ -6,6 +6,7 @@
 
 from pygmt.clib import Session
 from pygmt.datasets.tile_map import load_tile_map
+from pygmt.enums import GridType
 from pygmt.helpers import build_arg_list, fmt_docstring, kwargs_to_strings, use_alias
 
 try:
@@ -121,7 +122,7 @@ def tilemap(
         zoom_adjust=zoom_adjust,
     )
     if lonlat:
-        raster.gmt.gtype = 1  # Set to geographic type
+        raster.gmt.gtype = GridType.GEOGRAPHIC
 
     # Only set region if no_clip is None or False, so that plot is clipped to exact
     # bounding box region

pygmt/tests/test_binstats.py

@@ -7,6 +7,7 @@
 import numpy.testing as npt
 import pytest
 from pygmt import binstats
+from pygmt.enums import GridReg, GridType
 from pygmt.helpers import GMTTempFile
 
 
@@ -42,8 +43,8 @@ def test_binstats_no_outgrid():
         region="g",
     )
     assert temp_grid.dims == ("y", "x")
-    assert temp_grid.gmt.gtype == 0  # Cartesian grid
-    assert temp_grid.gmt.registration == 0  # Gridline registration
+    assert temp_grid.gmt.gtype == GridType.CARTESIAN
+    assert temp_grid.gmt.registration == GridReg.GRIDLINE
     npt.assert_allclose(temp_grid.max(), 35971536)
     npt.assert_allclose(temp_grid.min(), 53)
     npt.assert_allclose(temp_grid.median(), 1232714.5)

pygmt/tests/test_datasets_earth_age.py

@@ -5,6 +5,7 @@
 import numpy as np
 import numpy.testing as npt
 from pygmt.datasets import load_earth_age
+from pygmt.enums import GridReg
 
 
 def test_earth_age_01d():
@@ -18,7 +19,7 @@ def test_earth_age_01d():
     assert data.attrs["units"] == "Myr"
     assert data.attrs["horizontal_datum"] == "WGS84"
     assert data.shape == (181, 361)
-    assert data.gmt.registration == 0
+    assert data.gmt.registration == GridReg.GRIDLINE
     npt.assert_allclose(data.lat, np.arange(-90, 91, 1))
     npt.assert_allclose(data.lon, np.arange(-180, 181, 1))
     npt.assert_allclose(data.min(), 0.37, atol=0.01)
@@ -31,7 +32,7 @@ def test_earth_age_01d_with_region():
     """
     data = load_earth_age(resolution="01d", region=[-10, 10, -5, 5])
     assert data.shape == (11, 21)
-    assert data.gmt.registration == 0
+    assert data.gmt.registration == GridReg.GRIDLINE
     npt.assert_allclose(data.lat, np.arange(-5, 6, 1))
     npt.assert_allclose(data.lon, np.arange(-10, 11, 1))
     npt.assert_allclose(data.min(), 11.13, atol=0.01)
@@ -45,7 +46,7 @@ def test_earth_age_01m_default_registration():
     """
     data = load_earth_age(resolution="01m", region=[-10, -9, 3, 5])
     assert data.shape == (121, 61)
-    assert data.gmt.registration == 0
+    assert data.gmt.registration == GridReg.GRIDLINE
     assert data.coords["lat"].data.min() == 3.0
     assert data.coords["lat"].data.max() == 5.0
     assert data.coords["lon"].data.min() == -10.0

pygmt/tests/test_datasets_earth_day.py

@@ -5,6 +5,7 @@
 import numpy as np
 import numpy.testing as npt
 from pygmt.datasets import load_blue_marble
+from pygmt.enums import GridReg, GridType
 
 
 def test_blue_marble_01d():
@@ -18,8 +19,8 @@ def test_blue_marble_01d():
     assert data.attrs["description"] == "NASA Day Images"
     assert data.shape == (3, 180, 360)
     assert data.dtype == "uint8"
-    assert data.gmt.registration == 1
-    assert data.gmt.gtype == 1
+    assert data.gmt.registration == GridReg.PIXEL
+    assert data.gmt.gtype == GridType.GEOGRAPHIC
     npt.assert_allclose(data.y, np.arange(89.5, -90.5, -1))
     npt.assert_allclose(data.x, np.arange(-179.5, 180.5, 1))
     npt.assert_allclose(data.min(), 10, atol=1)
@@ -33,8 +34,8 @@ def test_blue_marble_01d_with_region():
     data = load_blue_marble(resolution="01d", region=[-10, 10, -5, 5])
     assert data.shape == (3, 10, 20)
     assert data.dtype == "uint8"
-    assert data.gmt.registration == 1
-    assert data.gmt.gtype == 1
+    assert data.gmt.registration == GridReg.PIXEL
+    assert data.gmt.gtype == GridType.GEOGRAPHIC
     npt.assert_allclose(data.y, np.arange(4.5, -5.5, -1))
     npt.assert_allclose(data.x, np.arange(-9.5, 10.5, 1))
     npt.assert_allclose(data.min(), 10, atol=1)

pygmt/tests/test_datasets_earth_free_air_anomaly.py

@@ -5,6 +5,7 @@
 import numpy as np
 import numpy.testing as npt
 from pygmt.datasets import load_earth_free_air_anomaly
+from pygmt.enums import GridReg
 
 
 def test_earth_faa_01d():
@@ -18,7 +19,7 @@ def test_earth_faa_01d():
     assert data.attrs["units"] == "mGal"
     assert data.attrs["horizontal_datum"] == "WGS84"
     assert data.shape == (181, 361)
-    assert data.gmt.registration == 0
+    assert data.gmt.registration == GridReg.GRIDLINE
     npt.assert_allclose(data.lat, np.arange(-90, 91, 1))
     npt.assert_allclose(data.lon, np.arange(-180, 181, 1))
     npt.assert_allclose(data.min(), -188.85, atol=0.025)
@@ -31,7 +32,7 @@ def test_earth_faa_01d_with_region():
     """
     data = load_earth_free_air_anomaly(resolution="01d", region=[-10, 10, -5, 5])
     assert data.shape == (11, 21)
-    assert data.gmt.registration == 0
+    assert data.gmt.registration == GridReg.GRIDLINE
     npt.assert_allclose(data.lat, np.arange(-5, 6, 1))
     npt.assert_allclose(data.lon, np.arange(-10, 11, 1))
     npt.assert_allclose(data.min(), -36.125, atol=0.025)
@@ -45,7 +46,7 @@ def test_earth_faa_01m_default_registration():
     """
     data = load_earth_free_air_anomaly(resolution="01m", region=[-10, -9, 3, 5])
     assert data.shape == (120, 60)
-    assert data.gmt.registration == 1
+    assert data.gmt.registration == GridReg.PIXEL
     npt.assert_allclose(data.coords["lat"].data.min(), 3.008333333)
     npt.assert_allclose(data.coords["lat"].data.max(), 4.991666666)
     npt.assert_allclose(data.coords["lon"].data.min(), -9.99166666)

pygmt/tests/test_datasets_earth_geoid.py

@@ -5,6 +5,7 @@
 import numpy as np
 import numpy.testing as npt
 from pygmt.datasets import load_earth_geoid
+from pygmt.enums import GridReg
 
 
 def test_earth_geoid_01d():
@@ -18,7 +19,7 @@ def test_earth_geoid_01d():
     assert data.attrs["units"] == "m"
     assert data.attrs["horizontal_datum"] == "WGS84"
     assert data.shape == (181, 361)
-    assert data.gmt.registration == 0
+    assert data.gmt.registration == GridReg.GRIDLINE
     npt.assert_allclose(data.lat, np.arange(-90, 91, 1))
     npt.assert_allclose(data.lon, np.arange(-180, 181, 1))
     npt.assert_allclose(data.min(), -106.06, atol=0.01)
@@ -31,7 +32,7 @@ def test_earth_geoid_01d_with_region():
     """
     data = load_earth_geoid(resolution="01d", region=[-10, 10, -5, 5])
     assert data.shape == (11, 21)
-    assert data.gmt.registration == 0
+    assert data.gmt.registration == GridReg.GRIDLINE
     npt.assert_allclose(data.lat, np.arange(-5, 6, 1))
     npt.assert_allclose(data.lon, np.arange(-10, 11, 1))
     npt.assert_allclose(data.min(), 5.57, atol=0.01)
@@ -45,7 +46,7 @@ def test_earth_geoid_01m_default_registration():
     """
     data = load_earth_geoid(resolution="01m", region=[-10, -9, 3, 5])
     assert data.shape == (121, 61)
-    assert data.gmt.registration == 0
+    assert data.gmt.registration == GridReg.GRIDLINE
     assert data.coords["lat"].data.min() == 3.0
     assert data.coords["lat"].data.max() == 5.0
     assert data.coords["lon"].data.min() == -10.0

pygmt/tests/test_datasets_earth_magnetic_anomaly.py

@@ -6,6 +6,7 @@
 import numpy.testing as npt
 import pytest
 from pygmt.datasets import load_earth_magnetic_anomaly
+from pygmt.enums import GridReg
 from pygmt.exceptions import GMTInvalidInput
 
 
@@ -20,7 +21,7 @@ def test_earth_mag_01d():
     assert data.attrs["units"] == "nT"
     assert data.attrs["horizontal_datum"] == "WGS84"
     assert data.shape == (181, 361)
-    assert data.gmt.registration == 0
+    assert data.gmt.registration == GridReg.GRIDLINE
     npt.assert_allclose(data.lat, np.arange(-90, 91, 1))
     npt.assert_allclose(data.lon, np.arange(-180, 181, 1))
     npt.assert_allclose(data.min(), -336.2, atol=0.2)
@@ -33,7 +34,7 @@ def test_earth_mag_01d_with_region():
     """
     data = load_earth_magnetic_anomaly(resolution="01d", region=[-10, 10, -5, 5])
     assert data.shape == (11, 21)
-    assert data.gmt.registration == 0
+    assert data.gmt.registration == GridReg.GRIDLINE
     npt.assert_allclose(data.lat, np.arange(-5, 6, 1))
     npt.assert_allclose(data.lon, np.arange(-10, 11, 1))
     npt.assert_allclose(data.min(), -54.4, atol=0.2)
@@ -47,7 +48,7 @@ def test_earth_mag_02m_default_registration():
     """
     data = load_earth_magnetic_anomaly(resolution="02m", region=[-10, -9, 3, 5])
     assert data.shape == (60, 30)
-    assert data.gmt.registration == 1
+    assert data.gmt.registration == GridReg.PIXEL
     npt.assert_allclose(data.coords["lat"].data.min(), 3.016666667)
     npt.assert_allclose(data.coords["lat"].data.max(), 4.983333333)
     npt.assert_allclose(data.coords["lon"].data.min(), -9.98333333)
@@ -67,7 +68,7 @@ def test_earth_mag4km_01d():
     assert data.attrs["units"] == "nT"
     assert data.attrs["horizontal_datum"] == "WGS84"
     assert data.shape == (181, 361)
-    assert data.gmt.registration == 0
+    assert data.gmt.registration == GridReg.GRIDLINE
     npt.assert_allclose(data.lat, np.arange(-90, 91, 1))
     npt.assert_allclose(data.lon, np.arange(-180, 181, 1))
     npt.assert_allclose(data.min(), -436.8, atol=0.2)
@@ -102,7 +103,7 @@ def test_earth_mag4km_02m_default_registration():
         data_source="emag2_4km",
     )
     assert data.shape == (60, 90)
-    assert data.gmt.registration == 1
+    assert data.gmt.registration == GridReg.PIXEL
     npt.assert_allclose(data.coords["lat"].data.min(), 4.01666667)
     npt.assert_allclose(data.coords["lat"].data.max(), 5.98333333)
     npt.assert_allclose(data.coords["lon"].data.min(), -114.98333333)
@@ -154,7 +155,7 @@ def test_earth_mag_03m_wdmam_with_region():
     data = load_earth_magnetic_anomaly(
         resolution="03m", region=[10, 13, -60, -58], data_source="wdmam"
     )
-    assert data.gmt.registration == 0
+    assert data.gmt.registration == GridReg.GRIDLINE
     assert data.shape == (41, 61)
     assert data.lat.min() == -60
     assert data.lat.max() == -58

pygmt/tests/test_datasets_earth_mask.py

@@ -5,6 +5,7 @@
 import numpy as np
 import numpy.testing as npt
 from pygmt.datasets import load_earth_mask
+from pygmt.enums import GridReg, GridType
 
 
 def test_earth_mask_01d():
@@ -16,8 +17,8 @@ def test_earth_mask_01d():
     assert data.attrs["description"] == "GSHHG Earth mask"
     assert data.attrs["horizontal_datum"] == "WGS84"
     assert data.shape == (181, 361)
-    assert data.gmt.registration == 0
-    assert data.gmt.gtype == 1
+    assert data.gmt.registration == GridReg.GRIDLINE
+    assert data.gmt.gtype == GridType.GEOGRAPHIC
     assert data.dtype == "int8"
     npt.assert_allclose(data.lat, np.arange(-90, 91, 1))
     npt.assert_allclose(data.lon, np.arange(-180, 181, 1))
@@ -32,8 +33,8 @@ def test_earth_mask_01d_with_region():
     """
     data = load_earth_mask(resolution="01d", region=[-7, 4, 13, 19])
     assert data.shape == (7, 12)
-    assert data.gmt.registration == 0
-    assert data.gmt.gtype == 1
+    assert data.gmt.registration == GridReg.GRIDLINE
+    assert data.gmt.gtype == GridType.GEOGRAPHIC
     assert data.dtype == "int8"
     npt.assert_allclose(data.lat, np.arange(13, 20, 1))
     npt.assert_allclose(data.lon, np.arange(-7, 5, 1))

pygmt/tests/test_datasets_earth_night.py

@@ -5,6 +5,7 @@
 import numpy as np
 import numpy.testing as npt
 from pygmt.datasets import load_black_marble
+from pygmt.enums import GridReg, GridType
 
 
 def test_black_marble_01d():
@@ -18,8 +19,8 @@ def test_black_marble_01d():
     assert data.attrs["description"] == "NASA Night Images"
     assert data.shape == (3, 180, 360)
     assert data.dtype == "uint8"
-    assert data.gmt.registration == 1
-    assert data.gmt.gtype == 1
+    assert data.gmt.registration == GridReg.PIXEL
+    assert data.gmt.gtype == GridType.GEOGRAPHIC
     npt.assert_allclose(data.y, np.arange(89.5, -90.5, -1))
     npt.assert_allclose(data.x, np.arange(-179.5, 180.5, 1))
     npt.assert_allclose(data.min(), 3, atol=1)
@@ -33,8 +34,8 @@ def test_black_marble_01d_with_region():
     data = load_black_marble(resolution="01d", region=[-10, 10, -5, 5])
     assert data.shape == (3, 10, 20)
     assert data.dtype == "uint8"
-    assert data.gmt.registration == 1
-    assert data.gmt.gtype == 1
+    assert data.gmt.registration == GridReg.PIXEL
+    assert data.gmt.gtype == GridType.GEOGRAPHIC
     npt.assert_allclose(data.y, np.arange(4.5, -5.5, -1))
     npt.assert_allclose(data.x, np.arange(-9.5, 10.5, 1))
     npt.assert_allclose(data.min(), 3, atol=1)

pygmt/tests/test_datasets_earth_relief.py

@@ -8,6 +8,7 @@
 from packaging.version import Version
 from pygmt.clib import __gmt_version__
 from pygmt.datasets import load_earth_relief
+from pygmt.enums import GridReg
 from pygmt.exceptions import GMTInvalidInput
 
 
@@ -25,7 +26,7 @@ def test_earth_relief_01d_igpp_synbath(data_source):
     assert data.attrs["vertical_datum"] == "EGM96"
     assert data.attrs["horizontal_datum"] == "WGS84"
     assert data.shape == (181, 361)
-    assert data.gmt.registration == 0
+    assert data.gmt.registration == GridReg.GRIDLINE
     npt.assert_allclose(data.lat, np.arange(-90, 91, 1))
     npt.assert_allclose(data.lon, np.arange(-180, 181, 1))
     npt.assert_allclose(data.min(), -7174.0, atol=0.5)
@@ -45,7 +46,7 @@ def test_earth_relief_01d_gebco(data_source):
     assert data.attrs["vertical_datum"] == "EGM96"
     assert data.attrs["horizontal_datum"] == "WGS84"
     assert data.shape == (181, 361)
-    assert data.gmt.registration == 0
+    assert data.gmt.registration == GridReg.GRIDLINE
     npt.assert_allclose(data.lat, np.arange(-90, 91, 1))
     npt.assert_allclose(data.lon, np.arange(-180, 181, 1))
     npt.assert_allclose(data.min(), -7169.0, atol=1.0)
@@ -62,7 +63,7 @@ def test_earth_relief_01d_with_region_srtm():
         data_source="igpp",
     )
     assert data.shape == (11, 21)
-    assert data.gmt.registration == 0
+    assert data.gmt.registration == GridReg.GRIDLINE
     npt.assert_allclose(data.lat, np.arange(-5, 6, 1))
     npt.assert_allclose(data.lon, np.arange(-10, 11, 1))
     npt.assert_allclose(data.min(), -5118.0, atol=0.5)
@@ -79,7 +80,7 @@ def test_earth_relief_01d_with_region_gebco():
         data_source="gebco",
     )
     assert data.shape == (11, 21)
-    assert data.gmt.registration == 0
+    assert data.gmt.registration == GridReg.GRIDLINE
     npt.assert_allclose(data.lat, np.arange(-5, 6, 1))
     npt.assert_allclose(data.lon, np.arange(-10, 11, 1))
     npt.assert_allclose(data.min(), -5118.0, atol=1.0)
@@ -92,7 +93,7 @@ def test_earth_relief_30m():
     """
     data = load_earth_relief(resolution="30m")
     assert data.shape == (361, 721)
-    assert data.gmt.registration == 0
+    assert data.gmt.registration == GridReg.GRIDLINE
     npt.assert_allclose(data.lat, np.arange(-90, 90.5, 0.5))
     npt.assert_allclose(data.lon, np.arange(-180, 180.5, 0.5))
     npt.assert_allclose(data.min(), -8279.5, atol=0.5)
@@ -110,7 +111,7 @@ def test_earth_gebcosi_15m_with_region():
         data_source="gebcosi",
     )
     assert data.shape == (16, 8)
-    assert data.gmt.registration == 1
+    assert data.gmt.registration == GridReg.PIXEL
     npt.assert_allclose(data.lat, np.arange(-87.875, -84, 0.25))
     npt.assert_allclose(data.lon, np.arange(85.125, 87, 0.25))
     npt.assert_allclose(data.min(), -492, atol=1.0)
@@ -183,7 +184,7 @@ def test_earth_relief_15s_default_registration():
     """
     data = load_earth_relief(resolution="15s", region=[-10, -9.5, 4, 5])
     assert data.shape == (240, 120)
-    assert data.gmt.registration == 1
+    assert data.gmt.registration == GridReg.PIXEL
     npt.assert_allclose(data.coords["lat"].data.min(), 4.002083)
     npt.assert_allclose(data.coords["lat"].data.max(), 4.997917)
     npt.assert_allclose(data.coords["lon"].data.min(), -9.997917)
@@ -203,7 +204,7 @@ def test_earth_relief_03s_default_registration():
     """
     data = load_earth_relief(resolution="03s", region=[-10, -9.8, 4.9, 5])
     assert data.shape == (121, 241)
-    assert data.gmt.registration == 0
+    assert data.gmt.registration == GridReg.GRIDLINE
     npt.assert_allclose(data.coords["lat"].data.min(), 4.9)
     npt.assert_allclose(data.coords["lat"].data.max(), 5)
     npt.assert_allclose(data.coords["lon"].data.min(), -10)