plot_field_from_fieldplot#

PostProcessor.plot_field_from_fieldplot(plot_name, project_path='', mesh_plot=False, image_format='jpg', view='isometric', plot_label='Temperature', plot_folder=None, show=True, scale_min=None, scale_max=None, plot_cad_objs=True, log_scale=True, dark_mode=False, show_grid=False, show_bounding=False, show_legend=True, plot_as_separate_objects=True, file_format='case')[source]#

Export a field plot to an image file (JPG or PNG) using Python PyVista.

Note

The PyVista module rebuilds the mesh and the overlap fields on the mesh.

Parameters:
plot_namestr

Name of the field plot to export.

project_pathstr, optional

Path for saving the image file. The default is "".

mesh_plotbool, optional

Whether to create and plot the mesh over the fields. The default is False.

image_formatstr, optional

Format of the image file. Options are "jpg", "png", "svg", and "webp". The default is "jpg".

viewstr, optional

View to export. Options are "isometric", "xy", "xz", "yz".

plot_labelstr, optional

Type of the plot. The default is "Temperature".

plot_folderstr, optional

Plot folder to update before exporting the field. The default is None, in which case all plot folders are updated.

showbool, optional

Export Image without plotting on UI.

scale_minfloat, optional

Fix the Scale Minimum value.

scale_maxfloat, optional

Fix the Scale Maximum value.

plot_cad_objsbool, optional

Whether to include objects in the plot. The default is True.

log_scalebool, optional

Whether to plot fields in log scale. The default is True.

dark_modebool, optional

Whether to display the model in dark mode or not. The default is False.

show_gridbool, optional

Whether to display the axes grid or not. The default is False.

show_boundingbool, optional

Whether to display the axes bounding box or not. The default is False.

show_legendbool, optional

Whether to display the legend. The default is True.

plot_as_separate_objectsbool, optional

Whether to plot each object separately, which can require more time to export from AEDT. The default is True.

file_formatstr, optional

File format to export the plot to. The default is "case". Options are ``"aedtplt" and "case". If the active design is a Q3D design, the file format is automatically set to "fldplt".

Returns:
pyaedt.generic.plot.ModelPlotter

Model Object.