plotting.plot_pole_map

plotting.plot_pole_map(
    fit,
    *,
    freq_band=None,
    growth_band=None,
    show_zeros=True,
    freq_range=None,
    growth_range=None,
    freq_unit='Hz',
    title='Continuation pole / zero map',
    height=None,
    width=None,
)

Plot a continuation’s poles and zeros in the (frequency, growth) plane.

A pole at complex frequency f_p plots at (Re(f_p), -2*pi*Im(f_p)) – the same (frequency, growth) axes as the eigenvalue spectrum, so the search window can be overlaid. Poles below the growth = 0 line are in the stable (decaying) half-plane (the desirable place for a causal response); a pole inside the shaded search window means the continuation is not trustworthy there.

By default the view focuses on the data band (the frequencies the fit was built on): a delay-dominated fit scatters far-field poles decades away in frequency/growth, and showing them would squash the region of interest to a sliver. The off-view marker count is annotated; pass freq_range / growth_range to override.

Parameters

Name Type Description Default
fit RationalFit The fit whose poles (and zeros) are drawn. required
freq_band tuple of float (f_lo, f_hi) of the stability search window [Hz]; shaded if given. None
growth_band tuple of float (g_lo, g_hi) of the search window [1/s]; combined with freq_band to shade the region the eigensolver sweeps. None
show_zeros bool Also draw the zeros (default True). True
freq_range tuple of float Explicit axis ranges [Hz] / [1/s]; default focuses on the data band and the poles that fall within it (plus the search window). None
growth_range tuple of float Explicit axis ranges [Hz] / [1/s]; default focuses on the data band and the poles that fall within it (plus the search window). None
freq_unit str Frequency-axis unit label (default "Hz"). 'Hz'
title str Figure title. 'Continuation pole / zero map'
height int Figure size in pixels. None
width int Figure size in pixels. None

Returns

Name Type Description
plotly.graph_objects.Figure
Back to top