cherab.phix.tools.visualize.show_phix_profile#

cherab.phix.tools.visualize.show_phix_profile(axes, profile, cmap='inferno', rtc=None, vmax=None, vmin=None, toggle_contour=True, levels=None, plot_mode='scalar')Source#

Show in-phix-limiter 2D profile with pcolormesh and plot their contours.

Parameters:

  • axes (Axes) – matplotlib Axes object

  • profile (NDArray) – 2D-array-like (nr, nz) profile inner PHiX limiter

  • cmap (str) – color map, by default "inferno"

  • rtc (RayTransferCylinder | None) – cherab’s raytransfer objects, by default the instance loaded by import_phix_rtc.

  • vmax (float | None) – to set the upper color limitation, by default maximum value of the profile.

  • vmin (float | None) – to set the lower color limitation, by default minimal value of the profile.

  • toggle_contour (bool) – whether or not to show contours as well as pcolormesh, by default True

  • levels (1D array-like, optional) – contour’s level array, by default 1D array having 10 numbers in range of 0 to the maximum value

  • plot_mode (str) – change the way of normalize the data scale. Must select one in {"scalar", "log", "centered"}, by default "scalar"

Returns:

list of contour line array \((R, Z)\) if toggle_contour is True.

Return type:

list[NDArray] | None