EIG.plot_root_loci#

EIG.plot_root_loci(results, eig_indices, ax=None, dpi=None, figsize=None, draw_line=False, arrow_threshold=0.2, **kwargs)[source]#

Plot the root loci.

Markers increase in size for the first parameter through the last.

Parameters:
resultsdict

Eigenvalue results from parameter sweeping

eig_indicesIterable

A list of eigenvalue indices to plot. The indices are 0-based, whereas the indices in the eigenvalue analysis report are 1-based.

axmatplotlib.axes.Axes or None

Axes to plot on. If None, create a new figure.

dpiint or None

DPI of the figure. If None, use the default DPI.

figsizetuple or None

Figure size. If None, use the default size.

draw_linebool, optional, False by default

If True, draw lines to connect the roots. Note that due to the non-fixed ordering of eigenvalues, lines will largely connect different modesl

arrow_thresholdfloat

Threshold for plotting arrows. If the begin and end points of a locus is shorter than this threshold, no arrow is plotted.

Returns:
matplotlib.figure.Figure

Figure containing the plot.

matplotlib.axes.Axes

Axes of the plot.

Examples

To plot the root loci of the first two eigenvalues, do

fig, ax = ss.EIG.plot_root_loci(ret, [0, 1])

where ret is the return of andes.routines.eig.EIG.sweep().