plot_animated_field#
- PostProcessor3D.plot_animated_field(quantity, assignment, plot_type='Surface', setup=None, intrinsics=None, variation_variable='Phi', variations=None, view='isometric', show=True, scale_min=None, scale_max=None, plot_cad_objs=True, log_scale=True, zoom=None, export_gif=False, export_path='', force_opacity_value=0.1, dark_mode=False, show_grid=False, show_bounding=False, show_legend=True, filter_objects=None)#
Create an animated field plot using Python PyVista and export to a gif file.
Note
The PyVista module rebuilds the mesh and the overlap fields on the mesh.
- Parameters:
- quantity
str
Quantity to plot (for example,
"Mag_E"
).- assignment
list
,str
One or more objects or faces to apply the field plot to.
- plot_type
str
,optional
Plot type. The default is
Surface
. Options are"CutPlane"
,"Surface"
, and"Volume"
.- setup
str
,optional
Setup and sweep name on which create the field plot. Default is None for nominal setup usage.
- intrinsics
dict
,str
,optional
Intrinsic variables required to compute the field before the export. These are typically: frequency, time and phase. It can be provided either as a dictionary or as a string. If it is a dictionary, keys depend on the solution type and can be expressed as: -
"Freq"
or"Frequency"
-"Time"
-"Phase"
If it is a string, it can either be
"Freq"
or"Time"
depending on the solution type. The default isNone
in which case the intrinsics value is automatically computed based on the setup.- variation_variable
str
,optional
Variable to vary. The default is
"Phi"
.- variations
list
,optional
List of variation values with units. The default is
["0deg"]
.- view
str
,optional
View to export. Options are
"isometric"
,"xy"
,"xz"
,"yz"
.- showbool,
optional
Export Image without plotting on UI.
- scale_min
float
,optional
Fix the Scale Minimum value.
- scale_max
float
,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
.- zoom
float
,optional
Zoom factor.
- export_gifbool,
optional
Whether to export an animated gif or not. The default is
False
.- export_path
str
,optional
Image export path. Default is
None
to notworking_directory
will be used to save the image.- force_opacity_value
float
,optional
Opacity value between 0 and 1 to be applied to all model. If None aedt opacity will be applied to each object.
- 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 or not. The default is
True
.- filter_objects
list
,optional
Objects list for filtering the
CutPlane
plots. The default isNone
in which case an empty list is passed.
- quantity
- Returns:
ansys.aedt.core.generic.plot.ModelPlotter
Model Object.