control.PoleZeroData

class control.PoleZeroData(poles, zeros, gains=None, loci=None, dt=None, sysname=None, sys=None, sort_loci=True)

Bases: object

Pole/zero data object.

This class is used as the return type for computing pole/zero responses and root locus diagrams. It contains information on the location of system poles and zeros, as well as the gains and loci for root locus diagrams.

Parameters:

polesndarray

1D array of system poles.

zerosndarray

1D array of system zeros.

gainsndarray, optional

1D array of gains for root locus plots.

locindarray, optional

2D array of poles, with each row corresponding to a gain.

sysnamestr, optional

System name.

sysStateSpace or TransferFunction, optional

System corresponding to the data.

dtNone, True or float, optional

System timebase (used for showing stability boundary).

sort_locibool, optional

Set to False to turn off sorting of loci into unique branches.

Methods

plot	Plot the pole/zero data.

plot(*args, **kwargs)

Plot the pole/zero data.

See pole_zero_plot for description of arguments and keywords.