pyleecan.Methods.Machine.Machine.plot module

plot(self, fig=None, ax=None, sym=1, alpha=0, delta=0, is_edge_only=False, edgecolor=None, is_add_arrow=False, comp_machine=None, comp_legend=None, is_show_fig=True, save_path=None, win_title=None, fig_title=None, is_max_sym=False, is_clean_plot=False, is_winding_connection=False)[source]

Plot the Machine in a matplotlib fig

Parameters:

  • self (Machine) – A Machine object

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

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

  • sym (int) – Symmetry factor (1= full machine, 2= half of the machine…)

  • alpha (float) – Angle for rotation [rad]

  • delta (complex) – Complex value for translation

  • is_edge_only (bool) – To plot transparent Patches

  • edgecolor – Color of the edges if is_edge_only=True

  • comp_machine (Machine) – A machine to plot in transparency on top of the self machine

  • comp_legend (str) – Name of the compare machine to set in the legeng (comp_machine != None)

  • is_show_fig (bool) – To call show at the end of the method

  • save_path (str) – full path including folder, name and extension of the file to save if save_path is not None

  • win_title (str) – Name of the Window (default machine name)

  • fig_title (str) – Name of the figure (default machine name)

  • is_max_sym (bool) – True: overwrite sym parameter with max periodicity of the machine

  • is_clean_plot (bool) – True to remove title, legend, axis (only machine on plot with white background)

  • is_winding_connection (bool) – True to display winding connections

Returns:

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

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