PostPlot (class)

Method code available at https://github.com/Eomys/pyleecan/tree/master/pyleecan/Methods/Post/PostPlot

class PostPlot(method=None, name='[]', param_list=-1, param_dict=-1, save_format='png', quantity=None, init_dict=None, init_str=None)[source]

Bases: pyleecan.Classes.PostMethod.PostMethod

Post-processing to do a plot which is a method of Output or other class if attribute is not None

VERSION = 1
run(output)

Execute the plot contained in the PostPlot object and save it to save_path

Parameters
  • self (PostPlot) – A PostPlot object

  • output (Output) – an Output object

save(save_path='', is_folder=False)

Save the object to the save_path

Parameters
  • self – A pyleecan object

  • save_path (str) – path to the folder to save the object

  • is_folder (bool) – to split the object in different files: separate simulation machine and materials

copy(**kwargs)

Return a copy of the class

get_logger()

Get the object logger or its parent’s one

Parameters

obj – A pyleecan object

Returns

logger – Pyleecan object dedicated logger

Return type

logging.Logger

compare(other, name='self')[source]

Compare two objects and return list of differences

as_dict(**kwargs)[source]

Convert this object in a json serializable dict (can be use in __init__). Optional keyword input parameter is for internal use only and may prevent json serializability.

property method

Name of the plot method to call (e.g. plot_2D_Data, plot_contour, plot_multi)

Type

str

property name

Name of the plot to use when saving the figure after plotting

Type

str

property param_list

Dictionnary of parameters to pass to the plot method when executing it

Type

list

property param_dict

Dictionnary of parameters to pass to the plot method when executing it

Type

dict

property save_format

File format extension (“png”, “svg”, “eps”) in which to save the figure. The PostPlot automatically saves the figure in the results folder. The user can specify a different folder by specifying “save_path”=path_str or not save the figure by specifying “save_path”=None in param_dict, if the plot_method enables it.

Type

str

property quantity

Full path to the quantity to which apply the plot_method except Output (e.g. mag.B, elec.get_Is, mag.meshsolution)

Type

str