show_profile_phi_degs

cherab.lhd.tools.visualization.show_profile_phi_degs(func: ~collections.abc.Callable[[float, float, float], ~numbers.Real], fig: ~matplotlib.figure.Figure | None = None, phi_degs: ~collections.abc.Collection[float] = array([ 0.   ,  3.598,  7.196, 10.794, 14.392, 17.99 ]), nrows_ncols: tuple[int, int] | None = None, rz_range: tuple[float, float, float, float] = (2.0, 5.5, -1.6, 1.6), resolution: float = 0.005, mask: ~typing.Literal['wall', 'grid', '<0', '<=0'] | None = 'grid', vmax: float | None = None, vmin: float | None = 0.0, clabel: str | None = None, cmap: str | ~matplotlib.colors.Colormap = <matplotlib.colors.ListedColormap object>, 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, show_phi: bool = True, parallel: bool = True, **kwargs) → tuple[Figure, ImageGrid]Source

Show EMC3-EIRENE discretized data function in R-Z plane with several toroidal angles.

Parameters:

funcCallable[[float, float, float], Real]

Callable object. The function must have three arguments \((X, Y, Z)\).

figFigure, optional

Figure object, by default plt.figure().

phi_degsCollection[float], optional

Toroidal angles, by default np.linspace(0, 17.99, 6).

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 phi_degs.

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).

resolutionfloat, optional

Sampling resolution, by default 5.0e-3.

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".

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.

clabelstr, optional

Colorbar label, by default None.

cmapstr | Colormap, optional

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

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.

show_phibool, optional

If True, toroidal angle is annotated in each axis, by default True.

parallelbool, optional

If True, the sampling is parallelized, by default True.

**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.