Figure.directional_rose: Plot a directional rose on a map

[seisman]

This issue serves as the central place for discussing and tracking the implementation of the Figure.directional_rose method in PyGMT. The issue will be closed when the initial implementation is complete. Progress is tracked at PyGMT: Wrapping GMT modules.

Figure.directional_rose is a thin wrapper for the -Td option of the basemap module.

Documentation

• GMT: https://docs.generic-mapping-tools.org/dev/basemap.html
• GMT.jl: https://www.generic-mapping-tools.org/GMTjl_doc/documentation/modules/basemap
• PyGMT: https://www.pygmt.org/dev/api/generated/pygmt.Figure.directional_rose.html

GMT Option Flags and Modifiers

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

Below are the option flags and modifiers of the basemap module.

• -R: region
• -J: projection
• -Jz/-JZ: zscale/zsize
• -A: Dumping polygons of bounding box. Make no sense here.
• -B: frame
• -F: box Add Figure.directional_rose to plot a directional rose on map #4025
• -L: Add a map scale bar
• -Td: Add a directional rose
  • g|j|J|n|x]refpoint[+jjustify][+odx[/dy]]: position Add Figure.directional_rose to plot a directional rose on map #4025
  • +wwidth: width Add Figure.directional_rose to plot a directional rose on map #4025
  • +f: fancy Add Figure.directional_rose to plot a directional rose on map #4025
  • +F: "Use +F to force the labels to be readable from the south if the projection has extensive rotation of the directions." [What does it mean?]
  • -l: labels Add Figure.directional_rose to plot a directional rose on map #4025
• -Tm: Add a magnatic rose
• -U: Use Figure.timestamp instead.
• -V: verbose Add Figure.directional_rose to plot a directional rose on map #4025
• -X/-Y: Use Figure.shift_origin instead.
• -c: panel Add Figure.directional_rose to plot a directional rose on map #4025
• -f: Makes no sense in Figure.scalebar
• -p: perspective Add Figure.directional_rose to plot a directional rose on map #4025
• -t: transparency Add Figure.directional_rose to plot a directional rose on map #4025
• --PAR=value: Use pygmt.config instead.

Related GMT Parameters

Linked Pull Requests

• Initial feature implementation Add Figure.scalebar to plot a scale bar on maps #4015 @seisman
• Add a tutorial or gallery example DOC: Add gallery example to show usage of map roses #4010
• Deprecate rose in Figure.coast/Figure.basemap

Related Issues and Discussions

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