pygmt.grdfilter: Filter a grid in the space (or time) domain

[seisman]

This issue serves as the central place for discussing and tracking the implementation of the grdfilter method in PyGMT. The issue will be closed when the initial implementation is complete. Progress is tracked at PyGMT: Wrapping GMT modules.

Documentation

• GMT: https://docs.generic-mapping-tools.org/dev/grdfilter.html
• GMT.jl: https://www.generic-mapping-tools.org/GMTjl_doc/documentation/modules/grdfilter
• PyGMT: https://www.pygmt.org/dev/api/generated/pygmt.grdfilter.html

GMT Option Flags and Modifiers

☑️: Implemented; ⬜: To be implemented/discussed; Strikethrough: Won't implement.

• <ingrid>
• -D: distance pygmt.grdfilter: Support Pythonic arguments for the distance parameter #4405
• -F:
  • filter pygmt.grdfilter: Add parameters filter/width/highpass to set the filter [Part 1] #4401
  • width pygmt.grdfilter: Add parameters filter/width/highpass to set the filter [Part 1] #4401
  • highpass pygmt.grdfilter: Add parameters filter/width/highpass to set the filter [Part 1] #4401
  • ...
• -G: outgrid
• -I: spacing
• -N: nans pygmt.grdfilter: Let the parameter 'nans' support descriptive arguments #4310
• -R: region
• -T: toggle
• -V: verbose
• -f
• -r: registration
• -x: cores
• --PAR=value: Use pygmt.config instead.

Linked Pull Requests

• Initial feature implementation Wrap grdfilter #616
• Add a tutorial or gallery example

Related Issues and Discussions

Add links to related wrapper discussions, API design threads, or upstream GMT changes here.