figsize

typhon.plots.figsize(w, portrait=False)[source]

Return a figure size matching the golden ratio.

This function takes a figure width and returns a tuple representing width and height in the golden ratio. Results can be returned for portrait orientation.

Parameters:
  • w (float) – Figure width.

  • portrait (bool) – Return size for portrait format.

Returns:

Figure width and size.

Return type:

tuple

Examples

>>> import typhon.plots
>>> typhon.plots.figsize(1)
(1, 0.61803398874989479)
>>> typhon.plots.figsize(1, portrait=True)
(1, 1.6180339887498949)