show_profile_xy_plane

cherab.lhd.tools.visualization.show_profile_xy_plane(func: ~collections.abc.Callable[[float, float, float], ~numbers.Real], z: float = 0.0, fig: ~matplotlib.figure.Figure | None = None, mask: ~typing.Literal['wall', 'grid', '<0', '<=0'] | None = 'grid', vmax: float | None = None, vmin: float | None = 0.0, resolution: float = 0.001, xy_range: tuple[float, float, float, float] = (2.5, 4.5, 0, 1.5), clabel: str = '', 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, **kwargs) → ImageGridSource

Show EMC3-EIRENE discretized data function in X-Y plane.

Parameters:

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

Callable object.

zfloat, optional

Z-axis value, by default 0.0.

figFigure, optional

Figure object, by default None.

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

Masking profile, 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.

resolutionfloat, optional

Sampling resolution, by default 1.0e-3.

xy_rangetuple[float, float, float, float], optional

Sampling range : \((X_\text{min}, X_\text{max}, Y_\text{min}, Y_\text{max})\), by default (2.5, 4.5, 0, 1.5).

clabelstr, optional

Colorbar label, by default “”.

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.

**kwargsImageGrid properties, optional

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

Returns:

ImageGrid

ImageGrid object.