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
• 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: May not make sense here
• -B: frame Add Figure.fill_between to fill between two curves #4679
• -C
• -D
• -E
• -F
• -H
• -I
• -J: projection Add Figure.fill_between to fill between two curves #4679
• -L
• -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
  • +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
  • +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
• -R: region Add Figure.fill_between to fill between two curves #4679
• -S
• -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
• -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.