Skip to content

Revise the notes about registration and gtype of remote datasets #2384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
seisman merged 12 commits into from
Mar 22, 2023
Merged

Revise the notes about registration and gtype of remote datasets #2384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
12e4362
Revise the notes about registration and gtype of remote datasets
seisman Feb 26, 2023
4afaa73
fix
seisman Feb 26, 2023
1086c65
Update pygmt/datasets/earth_age.py
seisman Feb 27, 2023
d875ed4
Update pygmt/datasets/earth_age.py
seisman Feb 28, 2023
819c05b
Update pygmt/datasets/earth_age.py
seisman Feb 28, 2023
41aa2d5
Update pygmt/datasets/earth_age.py
seisman Mar 17, 2023
410886b
Update pygmt/datasets/earth_age.py
seisman Mar 17, 2023
a8dc8af
Update pygmt/datasets/earth_age.py
seisman Mar 18, 2023
3372d8c
Merge branch 'main' into datasets-notes
seisman Mar 19, 2023
f16b500
Apply the same notes to all datasets
seisman Mar 19, 2023
e7ac318
Merge branch 'main' into datasets-notes
seisman Mar 21, 2023
cb0605b
Merge branch 'main' into datasets-notes
yvonnefroehlich Mar 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions pygmt/datasets/earth_age.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------
Expand Down
11 changes: 8 additions & 3 deletions pygmt/datasets/earth_free_air_anomaly.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------
Expand Down
11 changes: 8 additions & 3 deletions pygmt/datasets/earth_geoid.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------
Expand Down
11 changes: 8 additions & 3 deletions pygmt/datasets/earth_magnetic_anomaly.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------
Expand Down
11 changes: 11 additions & 0 deletions pygmt/datasets/earth_mask.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------

Expand Down
11 changes: 8 additions & 3 deletions pygmt/datasets/earth_relief.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------
Expand Down
11 changes: 8 additions & 3 deletions pygmt/datasets/earth_vertical_gravity_gradient.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------
Expand Down