diff --git a/pygmt/datasets/earth_age.py b/pygmt/datasets/earth_age.py index 330e58947e2..523bce64aa2 100644 --- a/pygmt/datasets/earth_age.py +++ b/pygmt/datasets/earth_age.py @@ -54,9 +54,14 @@ def load_earth_age(resolution="01d", region=None, registration=None): Note ---- - The :class:`xarray.DataArray` grid doesn't support slice operation, for - Earth seafloor crustal age with resolutions of 5 arc-minutes or higher, - which are stored as smaller tiles. + The registration and coordinate system type of the returned + :class:`xarray.DataArray` grid can be accessed via the GMT accessors + (i.e., ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively). + However, these properties may be lost after specific grid operations (such + as slicing) and will need to be manually set before passing the grid to any + PyGMT data processing or plotting functions. Refer to + :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and + workarounds. Examples -------- diff --git a/pygmt/datasets/earth_free_air_anomaly.py b/pygmt/datasets/earth_free_air_anomaly.py index a81b7e77895..57d47f01b4d 100644 --- a/pygmt/datasets/earth_free_air_anomaly.py +++ b/pygmt/datasets/earth_free_air_anomaly.py @@ -55,9 +55,14 @@ def load_earth_free_air_anomaly(resolution="01d", region=None, registration=None Note ---- - The :class:`xarray.DataArray` grid doesn't support slice operation, for - Earth free-air anomaly with resolutions of 5 arc-minutes or higher, - which are stored as smaller tiles. + The registration and coordinate system type of the returned + :class:`xarray.DataArray` grid can be accessed via the GMT accessors + (i.e., ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively). + However, these properties may be lost after specific grid operations (such + as slicing) and will need to be manually set before passing the grid to any + PyGMT data processing or plotting functions. Refer to + :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and + workarounds. Examples -------- diff --git a/pygmt/datasets/earth_geoid.py b/pygmt/datasets/earth_geoid.py index fa5d1ad020d..f33608df1fc 100644 --- a/pygmt/datasets/earth_geoid.py +++ b/pygmt/datasets/earth_geoid.py @@ -54,9 +54,14 @@ def load_earth_geoid(resolution="01d", region=None, registration=None): Note ---- - The :class:`xarray.DataArray` grid doesn't support slice operation, for - Earth geoid grids with resolutions of 5 arc-minutes or higher, - which are stored as smaller tiles. + The registration and coordinate system type of the returned + :class:`xarray.DataArray` grid can be accessed via the GMT accessors + (i.e., ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively). + However, these properties may be lost after specific grid operations (such + as slicing) and will need to be manually set before passing the grid to any + PyGMT data processing or plotting functions. Refer to + :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and + workarounds. Examples -------- diff --git a/pygmt/datasets/earth_magnetic_anomaly.py b/pygmt/datasets/earth_magnetic_anomaly.py index 8af7c63e13b..d8641f26b45 100644 --- a/pygmt/datasets/earth_magnetic_anomaly.py +++ b/pygmt/datasets/earth_magnetic_anomaly.py @@ -79,9 +79,14 @@ def load_earth_magnetic_anomaly( Note ---- - The :class:`xarray.DataArray` grid doesn't support slice operation, for - Earth magnetic anomaly with resolutions of 5 arc-minutes or higher, - which are stored as smaller tiles. + The registration and coordinate system type of the returned + :class:`xarray.DataArray` grid can be accessed via the GMT accessors + (i.e., ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively). + However, these properties may be lost after specific grid operations (such + as slicing) and will need to be manually set before passing the grid to any + PyGMT data processing or plotting functions. Refer to + :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and + workarounds. Examples -------- diff --git a/pygmt/datasets/earth_mask.py b/pygmt/datasets/earth_mask.py index df8efbf527d..5b10357e5e8 100644 --- a/pygmt/datasets/earth_mask.py +++ b/pygmt/datasets/earth_mask.py @@ -58,6 +58,17 @@ def load_earth_mask(resolution="01d", region=None, registration=None): - 4: Smaller lakes in islands that are found within lakes inside the land area + Note + ---- + The registration and coordinate system type of the returned + :class:`xarray.DataArray` grid can be accessed via the GMT accessors + (i.e., ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively). + However, these properties may be lost after specific grid operations (such + as slicing) and will need to be manually set before passing the grid to any + PyGMT data processing or plotting functions. Refer to + :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and + workarounds. + Examples -------- diff --git a/pygmt/datasets/earth_relief.py b/pygmt/datasets/earth_relief.py index ee708bf3746..a927e7492d1 100644 --- a/pygmt/datasets/earth_relief.py +++ b/pygmt/datasets/earth_relief.py @@ -92,9 +92,14 @@ def load_earth_relief( Note ---- - The :class:`xarray.DataArray` grid doesn't support slice operation, for - Earth relief data with resolutions of 5 arc-minutes or higher, which are - stored as smaller tiles. + The registration and coordinate system type of the returned + :class:`xarray.DataArray` grid can be accessed via the GMT accessors + (i.e., ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively). + However, these properties may be lost after specific grid operations (such + as slicing) and will need to be manually set before passing the grid to any + PyGMT data processing or plotting functions. Refer to + :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and + workarounds. Examples -------- diff --git a/pygmt/datasets/earth_vertical_gravity_gradient.py b/pygmt/datasets/earth_vertical_gravity_gradient.py index e198d67a577..edfb79fbce7 100644 --- a/pygmt/datasets/earth_vertical_gravity_gradient.py +++ b/pygmt/datasets/earth_vertical_gravity_gradient.py @@ -58,9 +58,14 @@ def load_earth_vertical_gravity_gradient( Note ---- - The :class:`xarray.DataArray` grid doesn't support slice operation, for - Earth vertical gravity gradient grids with resolutions of 5 arc-minutes or - higher, which are stored as smaller tiles. + The registration and coordinate system type of the returned + :class:`xarray.DataArray` grid can be accessed via the GMT accessors + (i.e., ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively). + However, these properties may be lost after specific grid operations (such + as slicing) and will need to be manually set before passing the grid to any + PyGMT data processing or plotting functions. Refer to + :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and + workarounds. Examples --------