control.root_locus_map

control.root_locus_map(sysdata, gains=None, xlim=None, ylim=None)[source]

Compute the root locus map for an LTI system.

Calculate the root locus by finding the roots of 1 + k * G(s) where G is a linear system and k varies over a range of gains.

Parameters:

sysdataLTI system or list of LTI systems: Linear input/output systems (SISO only, for now).
gainsarray_like, optional: Gains to use in computing plot of closed-loop poles. If not given, gains are chosen to include the main features of the root locus map.
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).

Returns:

rldataPoleZeroData or list of PoleZeroData: Root locus data object(s). The loci of the root locus diagram are available in the array rldata.loci, indexed by the gain index and the locus index, and the gains are in the array rldata.gains.

Notes

For backward compatibility, the rldata return object can be assigned to the tuple (roots, gains).