WrightTools.artists.quick2D

WrightTools.artists.quick2D(data, xaxis=0, yaxis=1, at={}, channel=0, *, cmap=None, contours=0, pixelated=True, dynamic_range=False, local=False, contours_local=True, autosave=False, save_directory=None, fname=None, verbose=True)[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 autosave. Default is False when the number of plots is 10 or less. When the number of plots is greater than 10, saving is forced.

  • 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)) – Toggle talkback. Default is True.

Returns:

List of saved image files (if any).

Return type:

list of strings