GenericMappingTools / GenericMappingTools/pygmt

Figure.histogram: Calculate and plot histograms

Open
#4,251 0 comments 0 reactions 0 assignees View on GitHub
feature request
Dominant language
Python
Stars
874
Forks
255
Avg merge
1d 21h
Merged PRs (30d)
40

Description

*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 https://github.com/orgs/GenericMappingTools/projects/3.*

## 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`:
- [x] `-A`: `horizontal` #4880
- [x] `-B`: `frame`
- [ ] `-C`: `cmap`, `fill` #4886
- [ ] `-D`: `annot`, `annot_position`, `annot_font`, `annot_offset`, `annot_orientation` #4895
- [x] `-E`: `bar_width`, `bar_offset` #4316
- [ ] `-F`: `center` #4896
- [x] `-G`: `fill`
- [ ] `-I`
- [x] `-Jx|X`: `projection`
- [x] `-L`: `out_range` #4882
- [ ] `-N`: `distribution`, `distribution_pen` #4894
- [x] `-Q`: `cumulative` #4881
- [x] `-R`: `region`
- [x] `-S`: `stairs` #4884
- [ ] `-T`
- [ ] ~~`-U`~~: Use `Figure.timestamp` instead.
- [x] `-V`: `verbose`
- [x] `-W`: `pen`
- [ ] ~~`-X`/`-Y`~~: Use `Figure.shift_origin` instead.
- [ ] `-Z`:
- [ ] `histtype`
- [ ] `weights` #4890
- [ ] `-bi`
- [x] `-c`: `panel`
- [ ] `-di`
- [ ] `-e`
- [ ] `-f`
- [ ] `-h`
- [x] `-i`: `incols`
- [ ] `-l`: `label`
- [ ] `-o`
- [x] `-p`: `perspective`
- [ ] `-qi`
- [ ] `-s`
- [x] `-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

- [x] Initial feature implementation
- [x] Add a tutorial or gallery example

## Related Issues and Discussions

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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.