polar_plot_3d#

FfdSolutionData.polar_plot_3d(quantity='RealizedGain', phi=0, theta=0, title='3D Plot', quantity_format='dB10', image_path=None, show=True, **kwargs)[source]#

Create a 3D plot of a specified quantity.

Parameters:
quantitystr, optional

Far field quantity to plot. The default is "RealizedGain". Available quantities are: "RealizedGain", "RealizedGain_Phi", "RealizedGain_Theta", "rEPhi", "rETheta", and "rETotal".

phifloat, int, optional

Phi scan angle in degree. The default is 0.

thetafloat, int, optional

Theta scan angle in degree. The default is 0.

titlestr, optional

Plot title. The default is "3D Plot".

quantity_formatstr, optional

Conversion data function. Available functions are: "abs", "ang", "dB10", "dB20", "deg", "imag", "norm", and "real".

image_pathstr, optional

Full path for the image file. The default is None, in which case a file is not exported.

showbool, optional

Whether to show the plot. The default is True. If False, the Matplotlib instance of the plot is shown.

Returns:
matplotlib.plt

Whether to show the plotted curve. If show=True, a Matplotlib figure instance of the plot is returned. If show=False, the plotted curve is returned.

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(theta=10)