WrightTools.artists.quick2D

WrightTools.artists.quick2D(data, xaxis: int | str = 0, yaxis: int | str = 1, at: dict = {}, channel: int | str = 0, cmap=None, contours: int = 0, pixelated: bool = True, dynamic_range: bool = False, local: bool = False, contours_local: bool = True, autosave: bool = False, save_directory=None, fname=None, verbose=False, _no_call=False) → list[str | Figure][source]

Quickly plot 2D slice(s) of data.

Parameters:

data (WrightTools.Data object.) – Data to plot.
xaxis (string or integer (optional)) – Expression or index of horizontal axis. Default is 0.
yaxis (string or integer (optional)) – Expression or index of vertical axis. Default is 1.
at (dictionary (optional)) – Dictionary of parameters in non-plotted dimension(s). If not provided, plots will be made at each coordinate.
cmap (Colormap) – Colormap to use. If None, will use “default” or “signed” depending on channel values.
channel (string or integer (optional)) – Name or index of channel to plot. Default is 0.
contours (integer (optional)) – The number of black contour lines to add to the plot. Default is 0.
pixelated (boolean (optional)) – Toggle between pcolor and contourf (deulaney) plotting backends. Default is True (pcolor).
dynamic_range (boolean (optional)) – Force the colorbar to use all of its colors. Only changes behavior for signed channels. Default is False.
local (boolean (optional)) – Toggle plotting locally. Default is False.
contours_local (boolean (optional)) – Toggle plotting black contour lines locally. Default is True.
autosave (boolean (optional)) – Toggle saving plots (True) as files or diplaying interactive (False). Default is False. When autosave is False, the number of plots is truncated by ChopHandler.max_figures.
save_directory (string (optional)) – Location to save image(s). Default is None (auto-generated).
fname (string (optional)) – File name. If None, data name is used. Default is None.
verbose (boolean (optional)) – Deprecated option. Use logging config to customize code feedback.
_no_call (boolean (default False)) – For testing purposes.

Returns:

if autosave, a list of saved image files (if any). if not, a list of Figures

Return type:

list