plot_2D_Data (method)

plot_2D_Data(self, Data_str, *arg_list, is_norm=False, unit='SI', data_list=[], component_list=None, legend_list=[], color_list=[], save_path=None, x_min=None, x_max=None, y_min=None, y_max=None, is_logscale_x=False, is_logscale_y=False, is_disp_title=True, is_grid=True, is_auto_ticks=True, fig=None, ax=None, barwidth=100, type_plot=None, fund_harm_dict=None, is_show_fig=None)[source]

Plots a field as a function of time

Parameters

  • self (Output) – an Output object

  • Data_str (str) – name of the Data Object to plot (e.g. “mag.Br”)

  • *arg_list (list of str) – arguments to specify which axes to plot

  • is_norm (bool) – boolean indicating if the field must be normalized

  • unit (str) – unit in which to plot the field

  • data_list (list) – list of Data objects to compare

  • component_list (list) – list of component names to plot in separate figures

  • legend_list (list) – list of legends to use for each Data object (including reference one) instead of data.name

  • color_list (list) – list of colors to use for each Data object

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

  • x_min (float) – minimum value for the x-axis

  • x_max (float) – maximum value for the x-axis

  • y_min (float) – minimum value for the y-axis

  • y_max (float) – maximum value for the y-axis

  • is_logscale_x (bool) – boolean indicating if the x-axis must be set in logarithmic scale

  • is_logscale_y (bool) – boolean indicating if the y-axis must be set in logarithmic scale

  • is_disp_title (bool) – boolean indicating if the title must be displayed

  • is_grid (bool) – boolean indicating if the grid must be displayed

  • is_auto_ticks (bool) – in fft, adjust ticks to freqs (deactivate if too close)

  • 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

  • barwidth (float) – barwidth scaling factor, only if type_plot = “bargraph”

  • type_plot (str) – type of 2D graph : “curve”, “bargraph”, “barchart” or “quiver”

  • fund_harm_dict (dict) – Dict containing axis name as key and frequency/order/wavenumber of fundamental harmonic as value to display fundamental harmonic in red in the fft

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