show_profiles_rz_plane

cherab.lhd.tools.visualization.show_profiles_rz_plane(list_data: list[~numpy.ndarray], index_func: ~collections.abc.Callable[[float, float, float], int], fig: ~matplotlib.figure.Figure | None = None, phi_deg: float = 0.0, nrows_ncols: tuple[int, int] | None = None, mask: ~typing.Literal['wall', 'grid', '<0', '<=0'] | None = 'grid', labels: list[str] | None = None, vmax: float | None = None, vmin: float | None = 0.0, resolution: float = 0.005, rz_range: tuple[float, float, float, float] = (2.0, 5.5, -1.6, 1.6), clabels: list[str] | str = '', cmap: str | ~matplotlib.colors.Colormap = <matplotlib.colors.ListedColormap object>, cbar_mode: ~typing.Literal['single', 'each'] = 'single', plot_mode: ~typing.Literal['scalar', 'log', 'centered', 'symlog', 'asinh'] = 'scalar', cbar_format: ~typing.Literal['scalar', 'log', 'symlog', 'asinh', 'percent', 'eng'] | ~typing.Literal['scalar', 'log', 'centered', 'symlog', 'asinh'] | None = None, linear_width: float | None = None, **kwargs) → tuple[Figure, ImageGrid]Source

Show several EMC3-EIRENE discretized data functions in one R-Z plane.

Parameters:

list_datalist[np.ndarray]

List of numpy.ndarray data.

index_funcCallable[[float, float, float], int]

Callable object to get index of EMC3 meshes.

figFigure, optional

Figure object, by default plt.figure().

phi_degfloat, optional

Toroidal angle, by default 0.0.

nrows_ncolstuple[int, int], optional

Number of rows and columns in the grid, by default None. If None, this is automatically rearranged by the length of funcs.

mask{“wall”, “grid”, “<0”, “<=0”}, optional

Masking profile by the following method: "wall" - profile is masked in the wall outline LHD. "grid" - profile is masked in the EMC3-EIRENE-defined grid if func has inside_grid attributes. If not, profile is not masked. "<0" - profile is masked less than zero values. "<=0" - profile is masked below zero values. Otherwise (including None) profile is not masked, by default "grid".

labelslist[str], optional

Profile titles written in each axis, by default None.

vmaxfloat, optional

Maximum value of colorbar limits, by default None. If None, maximum value is chosen of all sampled values.

vminfloat, optional

Minimum value of colorbar limits, by default 0.0. If None, minimum value is chosen of all sampled values.

resolutionfloat, optional

Sampling resolution, by default 5.0e-3.

rz_rangetuple[float, float, float, float], optional

Sampling range : \((R_\text{min}, R_\text{max}, Z_\text{min}, Z_\text{max})\), by default (2.0, 5.5, -1.6, 1.6).

clabelslist[str] | str, optional

List of colorbar labels, by default “”. If the length of clabels is less than the length of funcs, the last element of clabels is used for all colorbars when cbar_mode is “single”.

cmapstr | Colormap, optional

Colorbar map, by default CMAP_RED (custom Red colormap extracted from “RdBu_r”).

cbar_mode{“single”, “each”}, optional

ImgeGrid’s parameter to set colorbars in "single" axes or "each" axes, by default "single".

plot_mode{“scalar”, “log”, “centered”, “symlog”, “asinh”}, optional

Which scale to adapt to the colormap, by default "scalar". Each mode corresponds to the Normalize object.

cbar_format{“scalar”, “log”, “symlog”, “asinh”, “percent”, “eng”}, optional

Formatter to colorbar’s major y-axis locator, by default None. If None, the formatter is automatically set to the same one determined by plot_mode.

linear_widthfloat, optional

Linear width of asinh/symlog norm, by default None. If None, the linear width is automatically set to two digit below the absolute maximum or minimum value of the data.

**kwargsImageGrid properties, optional

User-specified properties, by default axes_pad=0.0, label_mode="L" and cbar_mode="single".

Returns:

figFigure

Figure object.

gridsImageGrid

ImageGrid object.