plt_set_aspect

PlasmaCalcs.plotting.plot_tools.lims.plt_set_aspect(aspect, *, ax=None)

sets the aspect of the plot to the specified aspect.

aspect: UNSET, None, str, or number (default: UNSET)

aspect ratio for each Axes, by default.

UNSET –> use DEFAULTS.PLOT.ASPECT (default: equal_or_auto).

None –> use matplotlib defaults; do not otherwise adjust aspect.

str –> ‘equal’, ‘auto’, or ‘equal_or_auto’.

‘equal’ and ‘auto’ get passed directly to matplotlib; ‘equal’ is equivalent to aspect=1.

‘equal_or_auto’ tries to pick ‘equal’, but uses ‘auto’ if aspect is too far from 1,

i.e. if max(data_aspect, 1/data_aspect) < aspect_ratio_max

(default: DEFAULTS.PLOT.ASPECT_RATIO_MAX=20)

number –> height scaling / width scaling.

E.g. aspect=2 –> 1 data unit of height is twice long as 1 data unit of width.

ax: None or matplotlib axis object

the Axes to set the aspect on. None –> ax=plt.gca().