polar_plot_3d_pyvista#
- FfdSolutionData.polar_plot_3d_pyvista(farfield_quantity='RealizedGain', quantity_format='dB10', rotation=None, export_image_path=None, show=True, show_as_standalone=False, pyvista_object=None, background=None, scale_farfield=None, show_beam_slider=True, show_geometry=True, **kwargs)[source]#
Create a 3D polar plot of the geometry with a radiation pattern in PyVista.
- Parameters:
- farfield_quantity
str
,optional
Quantity to plot. The default is
"RealizedGain"
. Available quantities are:"RealizedGain"
,"RealizedGain_Theta"
,"RealizedGain_Phi"
,"rETotal"
,"rETheta"
, and"rEPhi"
.- quantity_format
str
,optional
Conversion data function. Available functions are:
"abs"
,"ang"
,"dB10"
,"dB20"
,"deg"
,"imag"
,"norm"
, and"real"
.- export_image_path
str
,optional
Full path for the image file. The default is
None
, in which case a file is not exported.- rotation
list
,optional
Far field rotation matrix. The matrix contains three vectors, around x, y, and z axes. The default is
[[1., 0., 0.], [0., 1., 0.], [0., 0., 1.]]
.- showbool,
optional
Whether to show the plot. The default is
True
.- show_as_standalonebool,
optional
Whether to show a plot as standalone. The default is
True
.- pyvista_object
Pyvista.Plotter
,optional
PyVista instance defined externally. The default is
None
.- background
list
orstr
,optional
Background color if a list is passed or background picture if a string is passed. The default is
None
.- scale_farfield
list
,optional
List with minimum and maximum values of the scale slider. The default is
None
.- show_beam_sliderbool,
optional
Whether the Theta and Phi scan slider is active. The default is
True
.- show_geometry
Whether to show the geometry. The default is
True
.
- farfield_quantity
- Returns:
- bool or
Pyvista.Plotter
True
when successful. ThePyvista.Plotter
is returned whenshow
andexport_image_path
areFalse
.
- bool or
Examples
>>> import pyaedt >>> app = pyaedt.Hfss(specified_version="2023.2", designname="Antenna") >>> setup_name = "Setup1 : LastAdaptive" >>> frequencies = [77e9] >>> sphere = "3D" >>> data = app.get_antenna_ffd_solution_data(frequencies, setup_name, sphere) >>> data.polar_plot_3d_pyvista(qty_str="RealizedGain", quantity_format="dB10")