compute_erl

SpiSim.compute_erl(config_file=None, port_order=None, specify_through_ports=None, bandwidth=None, tdr_duration=None, z_terminations=None, transition_time=None, fixture_delay=None, input_amplitude=None, ber=None, pdf_bin_size=None, signal_loss_factor=None, permitted_reflection=None, reflections_length=None, modulation_type=None)

Compute effective return loss (ERL) using Ansys SPISIM from S-parameter file.

Warning

Do not execute this function with untrusted function argument, environment variables or pyaedt global settings. See the security guide for details.

Parameters:

config_filestr, optional

Configuration file to use as a reference. The default is None, in which case this parameter is ignored.

port_orderstr, optional

Whether to use “EvenOdd” or “Incremental” numbering for S4P files. The default is None. This parameter is ignored if there are more than four ports.

specify_through_portslist, optional

Input and output ports to compute the ERL on. Those are ordered like [inp, inneg, outp, outneg]. The default is None. This parameter is ignored if there are more than four ports.

bandwidthfloat, str, optional

Application bandwidth in hertz (Hz), which is the inverse of one UI (unit interval). The value can be a float or a string with the unit (“m”, “g”). The default is 30e9.

tdr_durationfloat, optional

Time domain reflectometry (TDR) duration in seconds, meaning how long the TDR tailed data should be applied. The default is 5.

z_terminationsfloat, optional

Z-terminations (Z11 and Z22) when TDR is calculated. The default is 50.

transition_timefloat, str, optional

Transition time: how fast (slew rate) input pulse transit from 0 to Vcc volt. The default is “10p”.

fixture_delayfloat, optional

Fixture delay: delay when input starts transition from 0 to Vcc. The default is 500e-12.

input_amplitudefloat, optional

Input amplitude: Vcc volt of step input. The default is 1.0.

berfloat, optional

Specified BER: At what threshold ERL is calculated. The default is 1e-4.

pdf_bin_sizefloat, optional

PDF bin size: how to quantize the superimposed value. The default is 1e-5.

signal_loss_factorfloat, optional

Signal loss factor (Beta). For more information, see the SPISIM Help. The default is 1.7e9.

permitted_reflectionfloat, optional

Permitted reflection (Rho). For more information, see the SPISIM Help. The default is 0.18.

reflections_lengthfloat, optional

Length of the reflections: how many UI will be used to calculate ERL. The default is 1000.

modulation_typestr, optional

Modulations type: signal modulation type “NRZ” or “PAM4”. The default is “NRZ”.

Returns:

bool or float

Effective return loss from the spisimExe command, False when failed.