set_export_touchstone#

Hfss3dLayout.set_export_touchstone(file_format='TouchStone1.0', enforce_passivity=True, enforce_causality=False, use_common_ground=True, show_gamma_comments=True, renormalize=False, impedance=50.0, fitting_error=0.5, maximum_poles=1000, passivity_type='PassivityByPerturbation', column_fitting_type='Matrix', state_space_fitting='IterativeRational', relative_error_tolerance=True, ensure_accurate_fit=False, touchstone_output='MA', units='GHz', precision=11)#

Set or disable the automatic export of the touchstone file after completing frequency sweep.

Parameters:

file_formatstr, optional: Touchstone format. Available options are: "TouchStone1.0", and "TouchStone2.0". The default is "TouchStone1.0".
enforce_passivitybool, optional: Enforce passivity. The default is True.
enforce_causalitybool, optional: Enforce causality. The default is False.
use_common_groundbool, optional: Use common ground. The default is True.
show_gamma_commentsbool, optional: Show gamma comments. The default is True.
renormalizebool, optional: Renormalize. The default is False.
impedancefloat, optional: Impedance in ohms. The default is 50.0.
fitting_errorfloat, optional: Fitting error. The default is 0.5.
maximum_polesint, optional: Maximum number of poles. The default is 10000.
passivity_typestr, optional: Passivity type. Available options are: "PassivityByPerturbation", "IteratedFittingOfPV", "IteratedFittingOfPVLF", and "ConvexOptimization".
column_fitting_typestr, optional: Column fitting type. Available options are: "Matrix", “Column”`, and “Entry”`.
state_space_fittingstr, optional: State space fitting algorithm. Available options are: "IterativeRational", “TWA”`, and “FastFit”`.
relative_error_tolerancebool, optional: Relative error tolerance. The default is True.
ensure_accurate_fitbool, optional: Ensure accurate impedance fit. The default is False.
touchstone_outputstr, optional: Touchstone output format. Available options are: "MA" for magnitude and phase in deg, "RI" for real and imaginary part, and "DB" for magnitude in dB and phase in deg.
unitsstr, optional: Frequency units. The default is "GHz".
precisionint, optional: Touchstone precision. The default is 11.

Returns:

bool: True when successful, False when failed.

References

>>> oTool.SetExportTouchstoneOptions

Examples

>>> from ansys.aedt.core import Hfss3dlayout
>>> layout = Hfss3dlayout()
>>> layout.export_touchstone_on_completion()
>>> layout.export_touchstone_on_completion()