cherab.phix.machine.wall_outline.plot_wall_outline#

cherab.phix.machine.wall_outline.plot_wall_outline(ax=None, **kwargs)Source#

Plot PHiX Limiter and vessel wall polygons.

Parameters:

  • ax (Axes | None) – The axes to plot on. If None, a new figure and axes is created and returned, by default None.

  • kwargs – Keyword arguments passed to matplotlib.pyplot.plot for each polygon.

Returns:

The figure and axes used to plot the polygons. If ax is not None, only the axes is returned.

Return type:

tuple[matplotlib.figure.Figure, matplotlib.axes.Axes] | matplotlib.axes.Axes

Examples

from cherab.phix.machine import plot_wall_outline
fig, ax = plot_wall_outline(color="k")
fig.show()
../_images/plot_wall_outline.png