Figure.fill_between: Fill the areas between to horizontal curves

[seisman]

This issue serves as the central place for discussing and tracking the implementation of the Figure.fill_between method in PyGMT, which wraps plot's -M option. 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/plot.html#m
• GMT.jl: https://www.generic-mapping-tools.org/GMTjl_doc/documentation/modules/plot
• PyGMT: https://www.pygmt.org/dev/api/generated/pygmt.Figure.fill_between.html

GMT Option Flags and Modifiers

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

• -A: Doesn't work.
• -B: frame Add Figure.fill_between to fill between two curves #4679
• -C: For CPT. Likely doesn't work. Even it works, what's the use case?
• -D: Offsetting lines by specific offsets. What's the use case?
• -E: Drawing error bar. Should be implemented in a separate method.
• -F: Connecting lines. Makes no sense in this method.
• -H: Makes no sense
• -I: Makes no sense:
• -J: projection Add Figure.fill_between to fill between two curves #4679
• -L: Force closed polygons. I've tried it, it doesn't work.
• -M
  • c: y1 and y2 are co-registered Add Figure.fill_between to fill between two curves #4679
  • s: y1 and y2 are not co-registered Figure.fill_between: Support for non-coregistered curves #4692
  • +g: fill2 fill for y2>y1 Add Figure.fill_between to fill between two curves #4679
  • +l: label2 label for y2 curve Add Figure.fill_between to fill between two curves #4679
  • +p: pen2 pen for y2 curve Add Figure.fill_between to fill between two curves #4679
  • +r: draw legend entries as lines, rather than filled boxes. Upstream bug at plot: Fix the bug that -M+r modifier doesn't set the pen thickness gmt#9070. Figure.fill_between: Add parameter 'legend_pen' to draw legend entries as lines #4698
  • +y: y2 is a horizontal constant, i.e., y2=0 Add Figure.fill_between to fill between two curves #4679
• -W: pen pen for the y1 curve Add Figure.fill_between to fill between two curves #4679
• -G: fill fill for the y1 curve Add Figure.fill_between to fill between two curves #4679
• -l: label: label for the y1 curve Add Figure.fill_between to fill between two curves #4679
• -N: no_clip Figure.fill_between: Add parameter 'no_clip' to not clip curves outside the border #4696
• -R: region Add Figure.fill_between to fill between two curves #4679
• -S: When used, only symbols are plotted. -M is totally ignored
• -U: Use Figure.timestamp instead.
• -V: verbose Add Figure.fill_between to fill between two curves #4679
• -X/-Y: Use Figure.shift_origin instead.
• -Z: Not sure if it works, but I feel it makes little sense here.
• -a
• -b
• -c Add Figure.fill_between to fill between two curves #4679
• -d
• -e
• -f
• -g
• -h
• -i
• -p Add Figure.fill_between to fill between two curves #4679
• -q
• -t Add Figure.fill_between to fill between two curves #4679
• -w
• -:
• --PAR=value: Use pygmt.config instead.

Linked Pull Requests

• Initial feature implementation
• Add a tutorial or gallery example

Related Issues and Discussions

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