add_limit_line_from_equation#

FarField.add_limit_line_from_equation(start_x, stop_x, step, equation='x', units='GHz', y_axis=1)[source]#

Add a Cartesian limit line from point lists. This method works only in graphical mode.

Parameters:
start_xfloat

Start X value.

stop_xfloat

Stop X value.

stepfloat

X step value.

equationstr, optional

Y equation to apply. The default is Y=X.

unitsstr

Units for the X axis. The default is "GHz".

y_axisstr, int, optional

Y axis. The default is 1.

Returns:
bool

True when successful, False when failed.