cherab.phix.tools.visualize.show_phix_profiles#

cherab.phix.tools.visualize.show_phix_profiles(profiles, fig=None, nrow_ncols=None, clabel='', cmap='inferno', rtc=None, vmax=None, vmin=None, axes_pad=0.02, cbar_mode='single', plot_mode='scalar', linear_width=1.0)Source#

Show in-phix-limiter 2D profiles such as emission profile.

This function can show several 2D profiles with matplotlib imshow style.

Parameters:

  • profiles (list[NDArray] | NDArray) – 2D-array-like (nr, nz) profile inner PHiX limiter if you want to show several profiles, you must put one list containing 2D array-like data.

  • fig (Figure | None) – Figure object, by default plt.figure()

  • nrow_ncols (tuple[int, int] | None) – ImageGrid’s parameter to set the number of rows and columns, by default None. If None, the number of rows and columns are set to (1, len(profiles))

  • clabel (str) – colobar label

  • 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 all profiles, if cbar_mode=="single"

  • vmin (float | None) – to set the lower color limitation, by default minimal value of all profiles, if cbar_mode=="single"

  • axes_pad (float) – ImageGrid’s parameter to set the interval between axes, by default 0.02

  • cbar_mode (str) – ImgeGrid’s parameter to set colorbars in "single" axes or "each" axes, by default "single"

  • plot_mode (str) – the way of normalize the data scale. Must select one in {"scalar", "log", "centered", "symlog", "asinh"}, by default "scalar". Each mode corresponds to the Normalize object as follows.

  • linear_width (float) – linear width of asinh/symlog norm, by default 1.0

Returns:

tuple containing matplotlib figure object and instance of ImageGrid.

Return type:

tuple[Figure, ImageGrid]