FfdSolutionData#

class ansys.aedt.core.generic.farfield_visualization.FfdSolutionData(input_file, frequency=None, variation=None, model_info=None, incident_power=None, touchstone_file=None)[source]#

Provides antenna far-field data.

Read element pattern information in a JSON file generated by FfdSolutionDataExporter() and return the Python interface to plot and analyze the far-field data.

Parameters:

input_filestr: Metadata information in a JSON file.
frequencyfloat, optional: Active frequency in hertz (Hz). The default is None, in which case the first frequency is active.
variationstr, optional: Label to identify corresponding variation.
model_infodict, optional
incident_powerdict, optional: Dictionary with information of the incident power for each frequency. The default is None, in which case an empty dictionary is applied. From AEDT 2024.1, this information is available from the XML input file. For example, the dictionary format for a two element farfield data = incident_power[“1GHz”] data = [1, 0.99]
touchstone_filestr, optional: Touchstone file name. The default is None.

Examples

>>> from ansys.aedt.core
>>> from ansys.aedt.core.generic.farfield_visualization import FfdSolutionData
>>> app = ansys.aedt.core.Hfss(version="2023.2", design="Antenna")
>>> data = app.get_antenna_data()
>>> metadata_file = data.metadata_file
>>> app.release_desktop()
>>> farfield_data = FfdSolutionData(input_file=metadata_file)
>>> farfield_data.plot_3d(quantity_format="dB10")

Methods

`FfdSolutionData.combine_farfield`([phi_scan, ...])	Compute the far field pattern calculated for a specific phi and theta scan angle requested.
`FfdSolutionData.get_accepted_power`()	Compute the accepted power from active s-parameters and incident power.
`FfdSolutionData.get_far_field_mesh`([...])	Generate a PyVista `UnstructuredGrid` object that represents the far field mesh.
`FfdSolutionData.get_port_index`()	Get port indices.
`FfdSolutionData.plot_3d`([quantity, ...])	Create a 3D polar plot of the geometry with a radiation pattern in PyVista.
`FfdSolutionData.plot_3d_chart`([quantity, ...])	Create a 3D chart of a specified quantity in Matplotlib.
`FfdSolutionData.plot_contour`([quantity, ...])	Create a contour plot of a specified quantity in Matplotlib.
`FfdSolutionData.plot_cut`([quantity, ...])	Create a 2D plot of a specified quantity in Matplotlib.

Attributes

`FfdSolutionData.accepted_power`	Total accepted power in watts.
`FfdSolutionData.accepted_power_element`	Accepted power per element in watts.
`FfdSolutionData.active_s_parameters`	Active s-parameters.
`FfdSolutionData.all_element_names`	Available port names.
`FfdSolutionData.element_info`	File information.
`FfdSolutionData.farfield_data`	Farfield data.
`FfdSolutionData.frequencies`	Available frequencies.
`FfdSolutionData.frequency`	Active frequency.
`FfdSolutionData.incident_power`	Total incident power in watts.
`FfdSolutionData.incident_power_element`	Incident power per element in watts.
`FfdSolutionData.input_file`	Input file.
`FfdSolutionData.magnitude`	Magnitude weight applied on each port.
`FfdSolutionData.metadata`	Antenna metadata.
`FfdSolutionData.origin`	Far field origin in meters.
`FfdSolutionData.phase`	Phase offset in degrees on each port.
`FfdSolutionData.phi_scan`	Phi scan angle in degrees.
`FfdSolutionData.radiated_power`	Total radiated power in watts.
`FfdSolutionData.radiated_power_element`	Radiated power per element in watts.
`FfdSolutionData.s_parameters`	Passive s-parameters.
`FfdSolutionData.taper`	Taper type.
`FfdSolutionData.theta_scan`	Theta scan angle in degrees.
`FfdSolutionData.touchstone_data`	Touchstone data.
`FfdSolutionData.weight`	Weight.