python_codes.plot_functions.north_arrow#

north_arrow(ax, center, length, length_small=None, width=None, radius=None, theta=0, textcolor='k', transform=None, **kwargs)[source]#

Plot a arrow indicating the North on a figure.

Parameters
  • ax (matplotlib axe) – Axe on which to plot the arrow

  • center (list, tuple, np.array) – Position of the arrow

  • length (float) – arrow max length

  • length_small (float) – length of the center par tof the arrow (the default is 0.8*length).

  • width (float) – arrow width (the default is (3/7)*length).

  • radius (float) – distance between the text and the arrow (the default is (45/70)*length).

  • theta (float) – rotation of the arrow indicating the north (the default is 0 for an arrow pointing upward).

  • textcolor (str) – color of the text (the default is ‘k’).

  • transform (matplotlib transform) – transform for the coordinate systen of the input length and positions (the default is ax.transData).

  • **kwargs – Optional parameters passed to Polygon, used to customize the arrow.

Returns

return nothing

Return type

None

Examples using python_codes.plot_functions.north_arrow#