control.PoleZeroData

class control.PoleZeroData(poles, zeros, gains=None, loci=None, dt=None, sysname=None, sys=None)[source]

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.

poles

1D array of system poles.

Type: ndarray

zeros

1D array of system zeros.

Type: ndarray

gains

1D array of gains for root locus plots.

Type: ndarray, optional

loci

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

Type: ndarray, optiona

sysname

System name.

Type: str, optional

sys

System corresponding to the data.

Type: StateSpace or TransferFunction

__init__(poles, zeros, gains=None, loci=None, dt=None, sysname=None, sys=None)[source]

Create a pole/zero map object.

Parameters

poles (ndarray) – 1D array of system poles.
zeros (ndarray) – 1D array of system zeros.
gains (ndarray, optional) – 1D array of gains for root locus plots.
loci (ndarray, optiona) – 2D array of poles, with each row corresponding to a gain.
sysname (str, optional) – System name.
sys (StateSpace or TransferFunction) – System corresponding to the data.

Methods

`__init__`(poles, zeros[, gains, loci, dt, ...])	Create a pole/zero map object.
`plot`(args, *kwargs)	Plot the pole/zero data.

plot(*args, **kwargs)[source]

Plot the pole/zero data.

See pole_zero_plot() for description of arguments and keywords.