create_scattering#

Hfss.create_scattering(plot_name='S Parameter Plot Nominal', sweep_name=None, port_names=None, port_excited=None, variations=None)[source]#

Create an S-parameter report.

Parameters:

plot_namestr, optional: Name of the plot. The default is "S Parameter Plot Nominal".
sweep_namestr, optional: Name of the sweep. The default is None.
port_nameslist, optional: List of port names. The first index, i, in S[i,j]. The default is None. (include only self-terms)
port_excitedlist or str, optional: List of port names. The seconds index, j in S[i,j]. The default is None. (include only self-terms)
variationsstr, optional: The default is None.

Returns:

bool: True when successful, False when failed.

References

>>> oModule.CreateReport

Examples

Create ad S-parameter plot named "S Parameter Plot Nominal" for a 3-port network. plotting S11, S21, S31. The port names are P1, P2, and P3.

>>> hfss.create_scattering(port_names=["P1", "P2", "P3"], port_excited=["P1", "P1", "P1"])
True