Uh oh!
There was an error while loading. Please reload this page.
GMTDataArrayAccessor: Support applying grid operations on the current xarray.DataArray object - #3854
Conversation
| def clip(self, **kwargs) -> xr.DataArray: | ||
| """ | ||
| Clip the range of grid values. | ||
| See the :func:`pygmt.grdclip` function for available parameters. | ||
| """ | ||
| return grdclip(grid=self._obj, **kwargs) |
There was a problem hiding this comment.
Probably best to keep the method name as .gmt.grdclip instead of .gmt.clip, because there is also https://docs.generic-mapping-tools.org/6.5/clip.html (same with the other grd* methods below), and who knows if we might use pandas accessors at some point.
There was a problem hiding this comment.
Even if we decide to implement the pandas accessors in the future (actually, I feel it's a good idea), there are still no conflicts since the two accessors are in different namespaces. E.g.,
da.gmt.clip: Clip operation on a xr.DataArray grid/imagedf.gmt.clip: Clip operation on a pd.DataFrame object
seisman
commented
May 8, 2025
I think this PR is ready for review. I guess I still need to add tests to increase code coverage? |
| def dimfilter(self, **kwargs) -> xr.DataArray: | ||
| """ | ||
| Directional filtering of a grid in the space domain. | ||
| See the :func:`pygmt.dimfilter` function for available parameters. | ||
| """ | ||
| return dimfilter(grid=self._obj, **kwargs) |
There was a problem hiding this comment.
Shorter way to declare new methods is to put this in the __init__ method:
importfunctoolsdef__init__(self, xarray_obj: xr.DataArray):
...
self.dimfilter=functools.partial(dimfilter, grid=self._obj)
self.dimfilter.__doc__=dimfilter.__doc__This would preserve the full docs too, e.g. output from help(grid.gmt.dimfilter)
Help on partial in module functools:
functools.partial(<function dimfilter at 0x7fd07...e: [190. 981.]
long_name: elevation (m))
Directional filtering of grids in the space domain.
Filter a grid in the space (or time) domain by
dividing the given filter circle into the given number of sectors,
applying one of the selected primary convolution or non-convolution
filters to each sector, and choosing the final outcome according to the
selected secondary filter. It computes distances using Cartesian or
Spherical geometries. The output grid can optionally be generated as a
subregion of the input and/or with a new increment using ``spacing``,
which may add an "extra space" in the input data to prevent edge
effects for the output grid. If the filter is low-pass, then the output
may be less frequently sampled than the input. :func:`pygmt.dimfilter`
will not produce a smooth output as other spatial filters
do because it returns a minimum median out of *N* medians of *N*
sectors. The output can be rough unless the input data are noise-free.
Thus, an additional filtering (e.g., Gaussian via :func:`pygmt.grdfilter`)
of the DiM-filtered data is generally recommended.
Full option list at :gmt-docs:`dimfilter.html`
**Aliases:**
.. hlist::
:columns: 3
- D = distance
- F = filter
- I = spacing
- N = sectors
- R = region
- V = verbose
There might be a nicer way to wrap things (maybe using https://docs.python.org/3/library/functools.html#functools.update_wrapper?), but haven't played around with it too much.
There was a problem hiding this comment.
Tried your solution above and found two issues:
self.dimfilteris an attribute of the accessor, so it's not shown on the documentation (https://pygmt-dev--3854.org.readthedocs.build/en/3854/api/generated/pygmt.GMTDataArrayAccessor.html)- The
helpdocs still showgridas its first parameter, which may be more confusing?
There was a problem hiding this comment.
I've re-implemented this feature using functools.wraps (commit 397504b) and I think it works well.
- The methods are shown on the documentation: https://pygmt-dev--3854.org.readthedocs.build/en/3854/api/generated/pygmt.GMTDataArrayAccessor.html
- The
help(grid.gmt.clip)docs is not perfect but is better:
Help on method grdfill in module pygmt.src.grdfill:
grdfill(outgrid: str | os.PathLike | None = None, constantfill: float | None = None, gridfill: str | os.PathLike | xarray.core.dataarray.DataArray | None = None, neighborfill: float | bool | None = None, splinefill: float | bool | None = None, inquire: bool = False, mode: str | None = None, *, hole=None, region=None, verbose=None, coltypes=None, **kwargs) -> xarray.core.dataarray.DataArray | numpy.ndarray | None method of pygmt.xarray.accessor.GMTDataArrayAccessor instance
Interpolate across holes in a grid.
Read a grid that presumably has unfilled holes that the user wants to fill in some
fashion. Holes are identified by NaN values but this criteria can be changed via the
``hole`` parameter. There are several different algorithms that can be used to
replace the hole values. If no holes are found the original unchanged grid is
returned.
Full GMT docs at :gmt-docs:`grdfill.html`.
**Aliases:**
.. hlist::
:columns: 3
- A = constantfill/gridfill/neighborfill/splinefill/mode
- L = inquire
- N = hole
- R = region
- V = verbose
- f = coltypes
Parameters
----------
grid
Name of the input grid file or the grid loaded as a
:class:`xarray.DataArray` object.
For reading a specific grid file format or applying basic data operations,
see :gmt-docs:`gmt.html#grd-inout-full` for the available modifiers.
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new xarray accessor for grid operations on DataArray objects, simplifying the application of GMT’s grid-processing functionality directly on grids.
- Adds a set of accessor methods that wrap GMT grid-operation functions using a common _make_method utility.
- Adds test cases to validate the new grid operation methods (clip and equalize_hist) exposed via the accessor.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| pygmt/xarray/accessor.py | Introduces a helper method to wrap GMT grid functions and exposes grid operations as DataArray methods. |
| pygmt/tests/test_xarray_accessor.py | Adds tests to verify the new accessor methods work as expected. |
Comments suppressed due to low confidence (2)
pygmt/xarray/accessor.py:259
- [nitpick] Although the 'filter' method is appropriately scoped to the accessor, its name coincides with the built-in Python function 'filter'. Consider renaming it (e.g., 'apply_filter') to avoid any potential confusion.
filter = _make_method(grdfilter)
pygmt/tests/test_xarray_accessor.py:218
- The comment references 'test_grdtest_grdclip_no_outgrid', which appears to be a typo. Please update the reference to clearly indicate the correct test name or remove the ambiguous reference for clarity.
This test is adapted from the `test_grdtest_grdclip_no_outgrid` test.
Uh oh!
There was an error while loading. Please reload this page.
| clip = _make_method(grdclip) | ||
| cut = _make_method(grdcut) | ||
| dimfilter = _make_method(dimfilter) | ||
| equalize_hist = _make_method(grdhisteq.equalize_grid) |
There was a problem hiding this comment.
For consistency, I would prefer matching the original GMT grdhisteq name. But no strong opinion on this.
| equalize_hist=_make_method(grdhisteq.equalize_grid) | |
| histeq=_make_method(grdhisteq.equalize_grid) |
There was a problem hiding this comment.
Consistency vs. readability. That's a question.
The name equalize_hist comes from https://scikit-image.org/docs/stable/api/skimage.exposure.html#skimage.exposure.equalize_hist.
What do @GenericMappingTools/pygmt-maintainers think about the name? If we prefer readability, perhaps we also need to change dimfilter to directional_filter?
There was a problem hiding this comment.
I've changed the function name to histeq for consistency. Will merge in one or two days if no further comments.
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
This PR enables GMTDataArrayAccessor to access GMT's grid-operation modules, i.e.,
grid.gmt.fill(**kwargs)instead ofpygmt.grdfill(grid, **kwargs):Address #499 (comment).
Preview: https://pygmt-dev--3854.org.readthedocs.build/en/3854/api/generated/pygmt.GMTDataArrayAccessor.html
Grid-related modules
Processing (grid in, grid out)
equalize_hist. The name comes from https://scikit-image.org/docs/stable/api/skimage.exposure.html#skimage.exposure.equalize_hist.Plotting
Misc