pyleecan.Methods.Output.XOutput.plot_multi module

exception PlotError[source]

Bases: Exception

plot_multi(self, x_symbol, y_symbol, c_symbol=None, cmap=None, plot_type='point', idx=None, fig=None, ax=None, title=None, is_show_fig=True, save_path=None, win_title=None)[source]

2D Plot from a DataKeeper / OptiObjective / ParamExplorer as a function of another DataKeeper / OptiObjective / ParamExplorer

Parameters:

  • self (XOutput) – XOutput object

  • x_symbol (str) – ParamExplorer or DataKeeper symbol

  • y_symbol (str) – ParamExplorer or DataKeeper symbol

  • c_symbol (str) – optional symbol to set the plot colors

  • cmap (colormap) – optional colormap

  • plot_type (str) – scatter or plot to chose plot type

  • idx (slice) – To plot only some data

  • fig (Matplotlib.figure.Figure) – existing figure to use if None create a new one

  • ax (Matplotlib.axes.Axes object) – ax on which to plot the data

  • title (str) – Figure or subfigure title according to ax

  • is_show_fig (bool) – True to show figure after plot

  • save_path (str) – full path of the png file where the figure is saved if save_path is not None

  • win_title (str) – Title of the plot window

Returns:

  • fig (Matplotlib.figure.Figure) – Figure containing the plot

  • ax (Matplotlib.axes.Axes object) – Axis containing the plot

Raises:

PlotError –