pygmt.grdmask: Create mask grid from polygons or point coverage

[Chuan1937]

This issue serves as the central place for discussing and tracking the implementation of the grdmask 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/grdmask.html
• GMT.jl: https://www.generic-mapping-tools.org/GMTjl_doc/documentation/modules/grdmask
• PyGMT: https://www.pygmt.org/dev/api/generated/pygmt.grdmask.html

GMT Option Flags and Modifiers

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

• -A: steps - Steps for polygon path construction
• -C: clobber - Clobber mode for selecting polygons (f|l|o|u)
• -G: outgrid Wrap grdmask for creating mask grid from polygons or point coverage #4463
• -I: spacing Wrap grdmask for creating mask grid from polygons or point coverage #4463
• -N: outside/edge/inside/id_start Wrap grdmask for creating mask grid from polygons or point coverage #4463
• -R: region Wrap grdmask for creating mask grid from polygons or point coverage #4463
• -S: search_radius - Search radius for point coverage mode
• -V: verbose Wrap grdmask for creating mask grid from polygons or point coverage #4463
• -r: registration - Grid registration (gridline or pixel)
• -x: cores - Number of cores for multi-threading
• -a: aspatial - Aspatial column associations
• -bi: binary_in - Binary input format
• -di: nodata_in - Replace nodata values with NaN
• -e: pattern - Data record pattern matching
• -f: coltypes - Data types of input/output columns
• -g: gaps - Data gaps and line breaks
• -h: header - Header record handling
• -i: incols - Input column selection and transformations
• -j: distcalc - Distance calculation method
• -n: interpolation - Interpolation settings
• -q: inrows - Input row selection
• -w: wrap - Cyclic coordinate conversion
• --PAR=value: Use pygmt.config instead

Related GMT configurations

• PROJ_ELLIPSOID: Affects distance calculations for geographic coordinates
• PROJ_GEODESIC: Method used for geodesic calculations
• PROJ_MEAN_RADIUS: Used for spherical distance calculations

Linked Pull Requests

• Initial feature implementation(Wrap grdmask for creating mask grid from polygons or point coverage #4463)
• Add unit tests(Wrap grdmask for creating mask grid from polygons or point coverage #4463)
• Add documentation examples(Wrap grdmask for creating mask grid from polygons or point coverage #4463)

Related Issues and Discussions