Figure.histogram: Calculate and plot histograms #4251

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: data
• -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: annot, annot_position, annot_font, annot_offset, annot_orientation Figure.histogram: Add parameters to annote bars and deprecate parameter 'annotate' #4895
• -E: bar_width, bar_offset Figure.histogram: Split parameter bar_width into bar_width and bar_offset #4316
• -F: center Figure.histogram: Migrate the parameter 'center' to the new alias system #4896
• -G: fill
• -I: Inquiry mode. This can be done by np.histogram. So who need it in PyGMT?
• -Jx|X: projection
• -L: out_range Figure.histogram: Add parameter 'out_range' to handle extreme values and deprecate parameter 'extreme' #4882
• -N: distribution, distribution_pen Figure.histogram: Improve parameters 'distribution' and 'distribution_pen' to draw distribution curves #4894
• -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: series POC + WIP: Figure.histogram: Let the parameter 'series' accept a sequence #4899
• -U: Use Figure.timestamp instead.
• -V: verbose
• -W: pen
• -X/-Y: Use Figure.shift_origin instead.
• -Z:
  • histtype Figure.histogram: Support Pythonic arguments for the 'histtype' parameter #4912
  • weights Figure.histogram: Add the parameter 'weights' for weighting data #4890
• -bi
• -c: panel
• -di
• -e
• -f
• -h
• -i: incols
• -l: label
• -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.