Skip to content

Commit df7b7cd

Browse files
seismanmichaelgrundyvonnefroehlichweiji14
authored
Revise the notes about registration and gtype of remote datasets (#2384)
Co-authored-by: Michael Grund <[email protected]> Co-authored-by: Yvonne Fröhlich <[email protected]> Co-authored-by: Wei Ji <[email protected]>
1 parent 91bdaf8 commit df7b7cd

File tree

7 files changed

+59
-18
lines changed

7 files changed

+59
-18
lines changed

‎pygmt/datasets/earth_age.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,14 @@ def load_earth_age(resolution="01d", region=None, registration=None):
5454
5555
Note
5656
----
57-
The :class:`xarray.DataArray` grid doesn't support slice operation, for
58-
Earth seafloor crustal age with resolutions of 5 arc-minutes or higher,
59-
which are stored as smaller tiles.
57+
The registration and coordinate system type of the returned
58+
:class:`xarray.DataArray` grid can be accessed via the GMT accessors
59+
(i.e., ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively).
60+
However, these properties may be lost after specific grid operations (such
61+
as slicing) and will need to be manually set before passing the grid to any
62+
PyGMT data processing or plotting functions. Refer to
63+
:class:`pygmt.GMTDataArrayAccessor` for detailed explanations and
64+
workarounds.
6065
6166
Examples
6267
--------

‎pygmt/datasets/earth_free_air_anomaly.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,14 @@ def load_earth_free_air_anomaly(resolution="01d", region=None, registration=None
5555
5656
Note
5757
----
58-
The :class:`xarray.DataArray` grid doesn't support slice operation, for
59-
Earth free-air anomaly with resolutions of 5 arc-minutes or higher,
60-
which are stored as smaller tiles.
58+
The registration and coordinate system type of the returned
59+
:class:`xarray.DataArray` grid can be accessed via the GMT accessors
60+
(i.e., ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively).
61+
However, these properties may be lost after specific grid operations (such
62+
as slicing) and will need to be manually set before passing the grid to any
63+
PyGMT data processing or plotting functions. Refer to
64+
:class:`pygmt.GMTDataArrayAccessor` for detailed explanations and
65+
workarounds.
6166
6267
Examples
6368
--------

‎pygmt/datasets/earth_geoid.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,14 @@ def load_earth_geoid(resolution="01d", region=None, registration=None):
5454
5555
Note
5656
----
57-
The :class:`xarray.DataArray` grid doesn't support slice operation, for
58-
Earth geoid grids with resolutions of 5 arc-minutes or higher,
59-
which are stored as smaller tiles.
57+
The registration and coordinate system type of the returned
58+
:class:`xarray.DataArray` grid can be accessed via the GMT accessors
59+
(i.e., ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively).
60+
However, these properties may be lost after specific grid operations (such
61+
as slicing) and will need to be manually set before passing the grid to any
62+
PyGMT data processing or plotting functions. Refer to
63+
:class:`pygmt.GMTDataArrayAccessor` for detailed explanations and
64+
workarounds.
6065
6166
Examples
6267
--------

‎pygmt/datasets/earth_magnetic_anomaly.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,14 @@ def load_earth_magnetic_anomaly(
7979
8080
Note
8181
----
82-
The :class:`xarray.DataArray` grid doesn't support slice operation, for
83-
Earth magnetic anomaly with resolutions of 5 arc-minutes or higher,
84-
which are stored as smaller tiles.
82+
The registration and coordinate system type of the returned
83+
:class:`xarray.DataArray` grid can be accessed via the GMT accessors
84+
(i.e., ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively).
85+
However, these properties may be lost after specific grid operations (such
86+
as slicing) and will need to be manually set before passing the grid to any
87+
PyGMT data processing or plotting functions. Refer to
88+
:class:`pygmt.GMTDataArrayAccessor` for detailed explanations and
89+
workarounds.
8590
8691
Examples
8792
--------

‎pygmt/datasets/earth_mask.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,17 @@ def load_earth_mask(resolution="01d", region=None, registration=None):
5858
- 4: Smaller lakes in islands that are found within lakes
5959
inside the land area
6060
61+
Note
62+
----
63+
The registration and coordinate system type of the returned
64+
:class:`xarray.DataArray` grid can be accessed via the GMT accessors
65+
(i.e., ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively).
66+
However, these properties may be lost after specific grid operations (such
67+
as slicing) and will need to be manually set before passing the grid to any
68+
PyGMT data processing or plotting functions. Refer to
69+
:class:`pygmt.GMTDataArrayAccessor` for detailed explanations and
70+
workarounds.
71+
6172
Examples
6273
--------
6374

‎pygmt/datasets/earth_relief.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,14 @@ def load_earth_relief(
9292
9393
Note
9494
----
95-
The :class:`xarray.DataArray` grid doesn't support slice operation, for
96-
Earth relief data with resolutions of 5 arc-minutes or higher, which are
97-
stored as smaller tiles.
95+
The registration and coordinate system type of the returned
96+
:class:`xarray.DataArray` grid can be accessed via the GMT accessors
97+
(i.e., ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively).
98+
However, these properties may be lost after specific grid operations (such
99+
as slicing) and will need to be manually set before passing the grid to any
100+
PyGMT data processing or plotting functions. Refer to
101+
:class:`pygmt.GMTDataArrayAccessor` for detailed explanations and
102+
workarounds.
98103
99104
Examples
100105
--------

‎pygmt/datasets/earth_vertical_gravity_gradient.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,14 @@ def load_earth_vertical_gravity_gradient(
5858
5959
Note
6060
----
61-
The :class:`xarray.DataArray` grid doesn't support slice operation, for
62-
Earth vertical gravity gradient grids with resolutions of 5 arc-minutes or
63-
higher, which are stored as smaller tiles.
61+
The registration and coordinate system type of the returned
62+
:class:`xarray.DataArray` grid can be accessed via the GMT accessors
63+
(i.e., ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively).
64+
However, these properties may be lost after specific grid operations (such
65+
as slicing) and will need to be manually set before passing the grid to any
66+
PyGMT data processing or plotting functions. Refer to
67+
:class:`pygmt.GMTDataArrayAccessor` for detailed explanations and
68+
workarounds.
6469
6570
Examples
6671
--------

0 commit comments

Comments
 (0)