control.matlab.rlocus

control.matlab.rlocus(sys[, gains, xlim, ylim, ...])[source]

Root locus diagram.

Calculate the root locus by finding the roots of 1 + k * G(s) where G is a linear system with transfer function num(s)/den(s) and each k is an element of gains.

Parameters:
sysLTI object

Linear input/output systems (SISO only, for now).

gainsarray_like, optional

Gains to use in computing plot of closed-loop poles.

xlimtuple or list, optional

Set limits of x axis (see matplotlib.axes.Axes.set_xlim).

ylimtuple or list, optional

Set limits of y axis (see matplotlib.axes.Axes.set_ylim).

plotbool

If False, do not generate a plot.

Returns:
rootsndarray

Closed-loop root locations, arranged in which each row corresponds to a gain in gains.

gainsndarray

Gains used. Same as gains keyword argument if provided.

Notes

This function is a wrapper for root_locus_plot, with legacy return arguments.