Skip to content

Commit e886408

Browse files
committed
Add note on registration/gtype
Xref #2384.
1 parent 471c6e8 commit e886408

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

pygmt/datasets/earth_daynight.py

+10
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,16 @@ def load_blue_marble(
6868
image
6969
The NASA Blue Marble image. Coordinates are latitude and longitude in degrees.
7070
71+
Note
72+
----
73+
The registration and coordinate system type of the returned
74+
:class:`xarray.DataArray` image can be accessed via the GMT accessors (i.e.,
75+
``image.gmt.registration`` and ``image.gmt.gtype`` respectively). However, these
76+
properties may be lost after specific image operations (such as slicing) and will
77+
need to be manually set before passing the image to any PyGMT data processing or
78+
plotting functions. Refer to :class:`pygmt.GMTDataArrayAccessor` for detailed
79+
explanations and workarounds.
80+
7181
Examples
7282
--------
7383

0 commit comments

Comments
 (0)