Skip to content

Commit 2e4961c

Browse files
murrayrmmurrayrm
committed
change suptitle_frame to title_frame
1 parent 4fe5f53 commit 2e4961c

3 files changed

Lines changed: 20 additions & 20 deletions

File tree

‎control/freqplot.py‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
'freqplot.share_magnitude': 'row',
5151
'freqplot.share_phase': 'row',
5252
'freqplot.share_frequency': 'col',
53-
'freqplot.suptitle_frame': 'axes',
53+
'freqplot.title_frame': 'axes',
5454
}
5555

5656
#
@@ -253,8 +253,8 @@ def bode_plot(
253253
'freqplot', 'initial_phase', kwargs, None, pop=True)
254254
rcParams = config._get_param(
255255
'freqplot', 'rcParams', kwargs, _freqplot_defaults, pop=True)
256-
suptitle_frame = config._get_param(
257-
'freqplot', 'suptitle_frame', kwargs, _freqplot_defaults, pop=True)
256+
title_frame = config._get_param(
257+
'freqplot', 'title_frame', kwargs, _freqplot_defaults, pop=True)
258258

259259
# Set the default labels
260260
freq_label = config._get_param(
@@ -977,10 +977,10 @@ def gen_zero_centered_series(val_min, val_max, period):
977977
else:
978978
# Allow data to set the title (used by gangof4)
979979
title = data[0].title
980-
_update_plot_title(title, fig, rcParams=rcParams, frame=suptitle_frame)
980+
_update_plot_title(title, fig, rcParams=rcParams, frame=title_frame)
981981
elif ax is None:
982982
_update_plot_title(
983-
title, fig=fig, rcParams=rcParams, frame=suptitle_frame,
983+
title, fig=fig, rcParams=rcParams, frame=title_frame,
984984
use_existing=False)
985985

986986
#
@@ -1712,8 +1712,8 @@ def nyquist_plot(
17121712
'nyquist', 'start_marker', kwargs, _nyquist_defaults, pop=True)
17131713
start_marker_size = config._get_param(
17141714
'nyquist', 'start_marker_size', kwargs, _nyquist_defaults, pop=True)
1715-
suptitle_frame = config._get_param(
1716-
'freqplot', 'suptitle_frame', kwargs, _freqplot_defaults, pop=True)
1715+
title_frame = config._get_param(
1716+
'freqplot', 'title_frame', kwargs, _freqplot_defaults, pop=True)
17171717

17181718
# Set line styles for the curves
17191719
def _parse_linestyle(style_name, allow_false=False):
@@ -1985,7 +1985,7 @@ def _parse_linestyle(style_name, allow_false=False):
19851985
if title is None:
19861986
title = "Nyquist plot for " + ", ".join(labels)
19871987
_update_plot_title(
1988-
title, fig=fig, rcParams=rcParams, frame=suptitle_frame,
1988+
title, fig=fig, rcParams=rcParams, frame=title_frame,
19891989
use_existing=False)
19901990

19911991
# Legacy return pocessing
@@ -2321,8 +2321,8 @@ def singular_values_plot(
23212321
'freqplot', 'grid', kwargs, _freqplot_defaults, pop=True)
23222322
rcParams = config._get_param(
23232323
'freqplot', 'rcParams', kwargs, _freqplot_defaults, pop=True)
2324-
suptitle_frame = config._get_param(
2325-
'freqplot', 'suptitle_frame', kwargs, _freqplot_defaults, pop=True)
2324+
title_frame = config._get_param(
2325+
'freqplot', 'title_frame', kwargs, _freqplot_defaults, pop=True)
23262326

23272327
# If argument was a singleton, turn it into a tuple
23282328
data = data if isinstance(data, (list, tuple)) else (data,)
@@ -2458,7 +2458,7 @@ def singular_values_plot(
24582458
if title is None:
24592459
title = "Singular values for " + ", ".join(labels)
24602460
_update_plot_title(
2461-
title, fig=fig, rcParams=rcParams, frame=suptitle_frame,
2461+
title, fig=fig, rcParams=rcParams, frame=title_frame,
24622462
use_existing=False)
24632463

24642464
# Legacy return processing

‎control/tests/freqplot_test.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ def test_response_plots(
6262
ovlout, ovlinp, clear=True):
6363

6464
# Use figure frame for suptitle to speed things up
65-
ct.set_defaults('freqplot', suptitle_frame='figure')
65+
ct.set_defaults('freqplot', title_frame='figure')
6666

6767
# Save up the keyword arguments
6868
kwargs = dict(
@@ -158,7 +158,7 @@ def test_manual_response_limits():
158158
@pytest.mark.usefixtures("editsdefaults")
159159
def test_line_styles(plt_fcn):
160160
# Use figure frame for suptitle to speed things up
161-
ct.set_defaults('freqplot', suptitle_frame='figure')
161+
ct.set_defaults('freqplot', title_frame='figure')
162162

163163
# Define a couple of systems for testing
164164
sys1 = ct.tf([1], [1, 2, 1], name='sys1')
@@ -266,7 +266,7 @@ def test_gangof4_plots(savefigs=False):
266266
@pytest.mark.usefixtures("editsdefaults")
267267
def test_first_arg_listable(response_cmd, return_type):
268268
# Use figure frame for suptitle to speed things up
269-
ct.set_defaults('freqplot', suptitle_frame='figure')
269+
ct.set_defaults('freqplot', title_frame='figure')
270270

271271
sys = ct.rss(2, 1, 1)
272272

@@ -302,7 +302,7 @@ def test_first_arg_listable(response_cmd, return_type):
302302
@pytest.mark.usefixtures("editsdefaults")
303303
def test_bode_share_options():
304304
# Use figure frame for suptitle to speed things up
305-
ct.set_defaults('freqplot', suptitle_frame='figure')
305+
ct.set_defaults('freqplot', title_frame='figure')
306306

307307
# Default sharing should share along rows and cols for mag and phase
308308
lines = ct.bode_plot(manual_response)
@@ -365,7 +365,7 @@ def test_freqplot_plot_type(plot_type):
365365
@pytest.mark.usefixtures("editsdefaults")
366366
def test_freqplot_omega_limits(plt_fcn):
367367
# Use figure frame for suptitle to speed things up
368-
ct.set_defaults('freqplot', suptitle_frame='figure')
368+
ct.set_defaults('freqplot', title_frame='figure')
369369

370370
# Utility function to check visible limits
371371
def _get_visible_limits(ax):
@@ -442,7 +442,7 @@ def test_freqplot_line_labels(plt_fcn):
442442
sys2 = ct.rss(3, 1, 1, name='sys2')
443443

444444
# Use figure frame for suptitle to speed things up
445-
ct.set_defaults('freqplot', suptitle_frame='figure')
445+
ct.set_defaults('freqplot', title_frame='figure')
446446

447447
# Make sure default labels are as expected
448448
cplt = plt_fcn([sys1, sys2])
@@ -515,7 +515,7 @@ def test_freqplot_ax_keyword(plt_fcn, ninputs, noutputs):
515515
pytest.skip("MIMO not implemented for Nyquist/Nichols")
516516

517517
# Use figure frame for suptitle to speed things up
518-
ct.set_defaults('freqplot', suptitle_frame='figure')
518+
ct.set_defaults('freqplot', title_frame='figure')
519519

520520
# System to use
521521
sys = ct.rss(4, ninputs, noutputs)
@@ -666,7 +666,7 @@ def test_freqresplist_unknown_kw():
666666
for args in test_cases:
667667
test_response_plots(*args, ovlinp=False, ovlout=False, clear=False)
668668

669-
# Reset suptitle_frame to the default value
669+
# Reset title_frame to the default value
670670
ct.reset_defaults()
671671

672672
# Define and run a selected set of interesting tests

‎control/tests/timeplot_test.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,7 @@ def test_timeplot_trace_labels(resp_fcn):
429429
kwargs = {'T': T, 'U': U}
430430

431431
# Use figure frame for suptitle to speed things up
432-
ct.set_defaults('freqplot', suptitle_frame='figure')
432+
ct.set_defaults('freqplot', title_frame='figure')
433433

434434
# Make sure default labels are as expected
435435
cplt = resp_fcn([sys1, sys2], **kwargs).plot()

0 commit comments

Comments
 (0)