get_rcs_data#

Hfss.get_rcs_data(frequencies: float | List[float | str] | None = None, setup: str | None = None, expression: str = 'ComplexMonostaticRCSTheta', variations: dict | None = None, overwrite: bool = True, link_to_hfss: bool = True, variation_name: str | None = None) → MonostaticRCSExporter | Path | bool#

Export monostatic radar cross-section (RCS) data from HFSS.

This method exports RCS simulation data into a standardized metadata format and returns a MonostaticRCSExporter object for further processing.

Note

For advanced RCS analysis and visualization, install the radar explorer toolkit:

pip install ansys-aedt-toolkits-radar-explorer

Then use MonostaticRCSData and MonostaticRCSPlotter from the toolkit.

Parameters:
frequenciesfloat or list of float or str, optional

Frequency value or list of frequencies to export. Frequencies can be specified as floats (in Hz) or strings with units. For example, "77GHz". The default is None, in which case all available frequencies from the setup are used.

setupstr, optional

Name of the setup and sweep to use in the format "SetupName : SweepName". The default is None, in which case nominal_adaptive is used.

expressionstr, optional

Monostatic RCS expression name to export. Available options include "ComplexMonostaticRCSTheta", "ComplexMonostaticRCSPhi", etc. The default is "ComplexMonostaticRCSTheta".

variationsdict, optional

Dictionary of variation variables and their values. The default is None, in which case the nominal variation is used.

overwritebool, optional

Whether to overwrite existing metadata files if they already exist. The default is True.

link_to_hfssbool, optional

Whether to return a MonostaticRCSExporter object (True) or just the metadata file path (False). When True, the returned object maintains a connection to the HFSS instance. When False, returns the path to the metadata file, allowing offline analysis. The default is True.

variation_namestr, optional

Name to assign to this RCS solution variation. If provided, overrides the default solution name. The default is None.

Returns:
ansys.aedt.core.visualization.post.rcs_exporter.MonostaticRCSExporter or pathlib.Path or bool

  • If link_to_hfss=True: Returns a MonostaticRCSExporter object.

  • If link_to_hfss=False: Returns a Path object pointing to the metadata file.

  • Returns False if frequencies cannot be obtained.

Examples

Export RCS data with default settings:

>>> from ansys.aedt.core import Hfss
>>> hfss = Hfss(project="MyRCSProject", design="MyRCSDesign")
>>> rcs_exporter = hfss.get_rcs_data()
>>> metadata_file = rcs_exporter.metadata_file

Export RCS data for specific frequencies:

>>> frequencies = [9e9, 10e9, 11e9]  # Frequencies in Hz
>>> rcs_exporter = hfss.get_rcs_data(
...     frequencies=frequencies, setup="Setup1 : Sweep1", expression="ComplexMonostaticRCSTheta"
... )

Export with frequency strings and custom variation:

>>> frequencies = ["9GHz", "10GHz", "11GHz"]
>>> variations = {"angle": "0deg", "distance": "100mm"}
>>> rcs_exporter = hfss.get_rcs_data(
...     frequencies=frequencies, variations=variations, variation_name="angle_0deg"
... )

Export only metadata file (no link to HFSS):

>>> metadata_path = hfss.get_rcs_data(frequencies=[77e9], link_to_hfss=False)
>>> print(f"RCS data exported to: {metadata_path}")

Use with radar explorer toolkit for advanced analysis:

>>> # Export RCS data from HFSS
>>> rcs_exporter = hfss.get_rcs_data(frequencies=[77e9])
>>> metadata_file = rcs_exporter.metadata_file
>>>
>>> # Close HFSS and use toolkit for offline analysis
>>> hfss.close_project()
>>>
>>> # Advanced analysis with radar explorer toolkit
>>> # pip install ansys-aedt-toolkits-radar-explorer
>>> from ansys.aedt.toolkits.radar_explorer.rcs_visualization import MonostaticRCSData
>>> rcs_data = MonostaticRCSData(str(metadata_file))
>>> rcs_data.plot_3d()