get_antenna_data

Hfss.get_antenna_data(frequencies=None, setup=None, sphere=None, variations=None, overwrite=True, link_to_hfss=True, export_touchstone=True, set_phase_center_per_port=True)

Export the antenna parameters to Far Field Data (FFD) files and return an instance of the FfdSolutionDataExporter object.

For phased array cases, only one phased array is calculated.

Parameters:

frequenciesfloat, list, optional

Frequency value or list of frequencies to compute far field data. The default is None, in which case all available frequencies are computed.

setupstr, optional

Name of the setup to use. The default is None, in which case nominal_adaptive is used.

spherestr, optional

Infinite sphere to use. The default is None, in which case an existing sphere is used or a new one is created.

variationsdict, optional

Variation dictionary. The default is None, in which case the nominal variation is exported.

overwritebool, optional

Whether to overwrite FFD files. The default is True.

link_to_hfssbool, optional

Whether to return an instance of the ansys.aedt.core.visualization.advanced.farfield_exporter.FfdSolutionDataExporter class, which requires a connection to an instance of the Hfss class. The default is `` True``. If False, returns an instance of ansys.aedt.core.visualization.advanced.farfield_visualization.FfdSolutionData class, which is independent of the running HFSS instance.

export_touchstonebool, optional

Whether to export touchstone file. The default is False.

set_phase_center_per_portbool, optional

Set phase center per port location. The default is True.

Returns:

ansys.aedt.core.visualization.advanced.farfield_visualization.FfdSolutionDataExporter

SolutionData object.

Examples

The method get_antenna_data() is used to export the farfield of each element of the design.

Open a design and create the objects.

>>> from ansys.aedt.core import Hfss
>>> hfss = Hfss()
>>> ffdata = hfss.get_antenna_data()
>>> ffdata.farfield_data.plot_cut(primary_sweep="theta", theta=0, is_polar=False)