turn off encirclement warnings for describing function plot

murrayrm · murrayrm · commit f3dfe04de482 · 2022-04-15T11:08:47.000-07:00
diff --git a/control/descfcn.py b/control/descfcn.py
@@ -199,7 +199,8 @@ def describing_function(
 
 
 def describing_function_plot(
-        H, F, A, omega=None, refine=True, label="%5.2g @ %-5.2g", **kwargs):
+        H, F, A, omega=None, refine=True, label="%5.2g @ %-5.2g",
+        warn=None, **kwargs):
     """Plot a Nyquist plot with a describing function for a nonlinear system.
 
     This function generates a Nyquist plot for a closed loop system consisting
@@ -220,6 +221,10 @@ def describing_function_plot(
     label : str, optional
         Formatting string used to label intersection points on the Nyquist
         plot.  Defaults to "%5.2g @ %-5.2g".  Set to `None` to omit labels.
+    warn : bool, optional
+        Set to True to turn on warnings generated by `nyquist_plot` or False
+        to turn off warnings.  If not set (or set to None), warnings are
+        turned off if omega is specified, otherwise they are turned on.
 
     Returns
     -------
@@ -240,9 +245,15 @@ def describing_function_plot(
     [(3.344008947853124, 1.414213099755523)]
 
     """
+    # Decide whether to turn on warnings or not
+    if warn is None:
+        # Turn warnings on unless omega was specified
+        warn = omega is None
+
     # Start by drawing a Nyquist curve
     count, contour = nyquist_plot(
-        H, omega, plot=True, return_contour=True, **kwargs)
+        H, omega, plot=True, return_contour=True,
+        warn_encirclements=warn, warn_nyquist=warn, **kwargs)
     H_omega, H_vals = contour.imag, H(contour)
 
     # Compute the describing function
diff --git a/control/freqplot.py b/control/freqplot.py
@@ -534,9 +534,10 @@ def gen_zero_centered_series(val_min, val_max, period):
 }
 
 
-def nyquist_plot(syslist, omega=None, plot=True, omega_limits=None,
-                 omega_num=None, label_freq=0, color=None,
-                 return_contour=False, warn_nyquist=True, *args, **kwargs):
+def nyquist_plot(
+        syslist, omega=None, plot=True, omega_limits=None, omega_num=None,
+        label_freq=0, color=None, return_contour=False,
+        warn_encirclements=True, warn_nyquist=True, **kwargs):
     """Nyquist plot for a system
 
     Plots a Nyquist plot for the system over a (optional) frequency range.
@@ -646,11 +647,11 @@ def nyquist_plot(syslist, omega=None, plot=True, omega_limits=None,
         determined by config.defaults['nyquist.mirror_style'].
 
     primary_style : [str, str], optional
-        Linestyles for primary image of the Nyquist curve.  The first element
-        is used for unscaled portions of the Nyquist curve, the second
-        element is used for scaled portions that are scaled (using
-        max_curve_magnitude). Default linestyle (['-', ':']) is determined by
-        config.defaults['nyquist.mirror_style'].
+        Linestyles for primary image of the Nyquist curve.  The first
+        element is used for unscaled portions of the Nyquist curve,
+        the second element is used for portions that are scaled (using
+        max_curve_magnitude). Default linestyle (['-', ':']) is
+        determined by config.defaults['nyquist.mirror_style'].
 
     start_marker : str, optional
         Matplotlib marker to use to mark the starting point of the Nyquist
@@ -838,7 +839,8 @@ def _parse_linestyle(style_name, allow_false=False):
                     p_ol = splane_poles[
                         (np.abs(splane_poles - p_cl)).argmin()]
 
-                    if abs(p_ol - p_cl) <= indent_radius:
+                    if abs(p_ol - p_cl) <= indent_radius and \
+                       warn_encirclements:
                         warnings.warn(
                             "indented contour may miss closed loop pole; "
                             "consider reducing indent_radius to be less than "
@@ -919,7 +921,8 @@ def _parse_linestyle(style_name, allow_false=False):
         count = int(np.round(encirclements, 0))
 
         # Let the user know if the count might not make sense
-        if abs(encirclements - count) > encirclement_threshold:
+        if abs(encirclements - count) > encirclement_threshold and \
+           warn_encirclements:
             warnings.warn(
                 "number of encirclements was a non-integer value; this can"
                 " happen is contour is not closed, possibly based on a"
@@ -936,13 +939,13 @@ def _parse_linestyle(style_name, allow_false=False):
             P = (sys.pole().real > 0).sum() if indent_direction == 'right' \
                 else (sys.pole().real >= 0).sum()
             Z = (sys.feedback().pole().real >= 0).sum()
-            if Z != count + P:
+            if Z != count + P and warn_encirclements:
                 warnings.warn(
                     "number of encirclements does not match Nyquist criterion;"
                     " check frequency range and indent radius/direction",
                     UserWarning, stacklevel=2)
-            elif indent_direction == 'none' and \
-                 any(np.isclose(sys.pole().real, 0)):
+            elif indent_direction == 'none' and any(sys.pole().real == 0) and \
+                 warn_encirclements:
                 warnings.warn(
                     "system has pure imaginary poles but indentation is"
                     " turned off; results may be meaningless",
@@ -990,7 +993,7 @@ def _parse_linestyle(style_name, allow_false=False):
             x_reg = np.ma.masked_where(reg_mask, resp.real)
             y_reg = np.ma.masked_where(reg_mask, resp.imag)
             p = plt.plot(
-                x_reg, y_reg, primary_style[0], color=color, *args, **kwargs)
+                x_reg, y_reg, primary_style[0], color=color, **kwargs)
             c = p[0].get_color()
 
             # Figure out how much to offset the curve: the offset goes from
@@ -1004,13 +1007,13 @@ def _parse_linestyle(style_name, allow_false=False):
             y_scl = np.ma.masked_where(scale_mask, resp.imag)
             plt.plot(
                 x_scl * (1 + curve_offset), y_scl * (1 + curve_offset),
-                primary_style[1], color=c, *args, **kwargs)
+                primary_style[1], color=c, **kwargs)
 
             # Plot the primary curve (invisible) for setting arrows
             x, y = resp.real.copy(), resp.imag.copy()
             x[reg_mask] *= (1 + curve_offset[reg_mask])
             y[reg_mask] *= (1 + curve_offset[reg_mask])
-            p = plt.plot(x, y, linestyle='None', color=c, *args, **kwargs)
+            p = plt.plot(x, y, linestyle='None', color=c, **kwargs)
 
             # Add arrows
             ax = plt.gca()
@@ -1021,17 +1024,17 @@ def _parse_linestyle(style_name, allow_false=False):
             if mirror_style is not False:
                 # Plot the regular and scaled segments
                 plt.plot(
-                    x_reg, -y_reg, mirror_style[0], color=c, *args, **kwargs)
+                    x_reg, -y_reg, mirror_style[0], color=c, **kwargs)
                 plt.plot(
                     x_scl * (1 - curve_offset),
                     -y_scl * (1 - curve_offset),
-                    mirror_style[1], color=c, *args, **kwargs)
+                    mirror_style[1], color=c, **kwargs)
 
                 # Add the arrows (on top of an invisible contour)
                 x, y = resp.real.copy(), resp.imag.copy()
                 x[reg_mask] *= (1 - curve_offset[reg_mask])
                 y[reg_mask] *= (1 - curve_offset[reg_mask])
-                p = plt.plot(x, -y, linestyle='None', color=c, *args, **kwargs)
+                p = plt.plot(x, -y, linestyle='None', color=c, **kwargs)
                 _add_arrows_to_line2D(
                     ax, p[0], arrow_pos, arrowstyle=arrow_style, dir=-1)
 
diff --git a/control/tests/descfcn_test.py b/control/tests/descfcn_test.py
@@ -140,7 +140,7 @@ def test_describing_function(fcn, amin, amax):
 def test_describing_function_plot():
     # Simple linear system with at most 1 intersection
     H_simple = ct.tf([1], [1, 2, 2, 1])
-    omega = np.logspace(-2, 2, 100)
+    omega = np.logspace(-1, 2, 100)
 
     # Saturation nonlinearity
     F_saturation = ct.descfcn.saturation_nonlinearity(1)
@@ -160,7 +160,7 @@ def test_describing_function_plot():
 
     # Multiple intersections
     H_multiple = H_simple * ct.tf(*ct.pade(5, 4)) * 4
-    omega = np.logspace(-2, 3, 50)
+    omega = np.logspace(-1, 3, 50)
     F_backlash = ct.descfcn.friction_backlash_nonlinearity(1)
     amp = np.linspace(0.6, 5, 50)
     xsects = ct.describing_function_plot(H_multiple, F_backlash, amp, omega)
