Figure.histogram: Calculate and plot histograms

[seisman]

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

GMT Option Flags and Modifiers

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

• table:
• -A: horizontal Figure.histogram: Migrate the parameter horizontal to the new alias system #4880
• -B: frame
• -C: cmap, fill Figure.histogram: Improved syntax for filling bars by position/value #4886
• -D
• -E: bar_width, bar_offset Figure.histogram: Split parameter bar_width into bar_width and bar_offset #4316
• -F
• -G: fill
• -I
• -Jx|X
• -L: extreme Figure.histogram: Let parameter 'extreme' support Pythonic arguments #4882
• -N
• -Q: cumulative Figure.histogram: Let parameter 'cumulative' support Pythonic arguments #4881
• -R: region
• -S: stairs Figure.histogram: Migrate parameter 'stairs' to the new alias system #4884
• -T
• -U: Use Figure.timestamp instead.
• -V: verbose
• -W: pen
• -X/-Y: Use Figure.shift_origin instead.
• -Z
• -c: panel
• -bi
• -di
• -e
• -f
• -h
• -i: incols
• -o
• -p: perspective
• -qi
• -s
• -t: transparency
• -w
• --PAR=value: Use pygmt.config instead.

Notes on Input Formats

Add any notes on the input formats, especially the meaning of columns.

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.