Skip to content

Feature print zpk #869

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
murrayrm merged 16 commits into from
Mar 25, 2023
Merged

Feature print zpk #869

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
5c85459
Add print zpk form
henklaak Feb 21, 2023
57620f1
Fix unittest
henklaak Feb 21, 2023
b36732d
Add fix for precision noise
henklaak Feb 21, 2023
45b5ae4
Cleanup unittest
henklaak Feb 21, 2023
07a859d
Merge branch 'python-control:main' into feature_print_zpk
henklaak Feb 24, 2023
93f7b46
Rework after review
henklaak Feb 24, 2023
d2807b0
Shouldn't have commited the pyproject.toml, revering
henklaak Feb 24, 2023
5652bf0
Fix variable mixup due to inconsistent naming
henklaak Feb 24, 2023
58e9d63
Fix variable mixup due to inconsistent naming
henklaak Feb 24, 2023
521a306
Typos
henklaak Feb 24, 2023
2644874
Add default for xferfcn.display_format
henklaak Feb 25, 2023
8101b31
Update after failed tests
henklaak Feb 25, 2023
8d7ac56
Add default for xferfcn.floating_point_format
henklaak Feb 25, 2023
2ca47e1
Fix improper way of setting defaults in test
henklaak Feb 25, 2023
5f506b2
Merge branch 'python-control:main' into feature_print_zpk
henklaak Mar 5, 2023
6933973
update xferfcn._float2str to be more pythonic per @ilayn
murrayrm Mar 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add default for xferfcn.floating_point_format
  • Loading branch information
@henklaak
henklaak committed Feb 25, 2023
commit 8d7ac56eb7a5bc4657de6eae9ff43bb43826f9cd
29 changes: 28 additions & 1 deletion control/tests/xferfcn_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import control as ct
from control import StateSpace, TransferFunction, rss, evalfr
from control import ss, ss2tf, tf, tf2ss, zpk
from control import isctime, isdtime, sample_system, defaults
from control import isctime, isdtime, sample_system, defaults, reset_defaults
from control.statesp import _convert_to_statespace
from control.xferfcn import _convert_to_transfer_function
from control.tests.conftest import slycotonly, matrixfilter
Expand Down Expand Up @@ -970,6 +970,33 @@ def test_printing_zpk(self, zeros, poles, gain, output):
res = str(G)
assert res == output

@pytest.mark.parametrize(
"zeros, poles, gain, format, output",
[([1], [1 + 1j, 1 - 1j], 1, ".2f",
'\n'
' 1.00\n'
'-------------------------------------\n'
'(s + (1.00-1.41j)) (s + (1.00+1.41j))\n'),
([1], [1 + 1j, 1 - 1j], 1, ".3f",
'\n'
' 1.000\n'
'-----------------------------------------\n'
'(s + (1.000-1.414j)) (s + (1.000+1.414j))\n'),
([1], [1 + 1j, 1 - 1j], 1, ".6g",
'\n'
' 1\n'
'-------------------------------------\n'
'(s + (1-1.41421j)) (s + (1+1.41421j))\n')
])
def test_printing_zpk_format(self, zeros, poles, gain, format, output):
"""Test _tf_polynomial_to_string for constant systems"""
defaults['xferfcn.floating_point_format'] = format
G = tf([1], [1,2,3], display_format='zpk')
res = str(G)
reset_defaults()

assert res == output

@pytest.mark.parametrize(
"num, den, output",
[([[[11], [21]], [[12], [22]]],
Expand Down
22 changes: 13 additions & 9 deletions control/xferfcn.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,12 @@
# Define module default parameter values
_xferfcn_defaults = {
'xferfcn.display_format': 'poly',
'xferfcn.floating_point_format': '.4g'
}

def _float2str(value):

@ilayn ilayn Feb 25, 2023

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest against doing this. It's anti-pattern for Python and also there is a simpler way to grab the default at the code level and reuse.

>>> _num_format = config.defaults.get('xferfcn.floating_point_format', ':.4g')
>>> print(f"Bla {0.232654684684654654:{_num_format}}")
Bla 0.232655

So you don't need to inject f-string machinery to the string representation.

@murrayrm murrayrm Mar 24, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@henklaak If you can fix up this final issue, I think this PR is ready to post.

formatter = "{:" + config.defaults.get('xferfcn.floating_point_format', ':.4g') + "}"
return formatter.format(value)

class TransferFunction(LTI):
"""TransferFunction(num, den[, dt])
Expand Down Expand Up @@ -1313,7 +1317,7 @@ def _tf_polynomial_to_string(coeffs, var='s'):
N = len(coeffs) - 1

for k in range(len(coeffs)):
coefstr = '%.4g' % abs(coeffs[k])
coefstr = _float2str(abs(coeffs[k]))
power = (N - k)
if power == 0:
if coefstr != '0':
Expand Down Expand Up @@ -1355,7 +1359,7 @@ def _tf_factorized_polynomial_to_string(roots, gain=1, var='s'):
"""Convert a factorized polynomial to a string"""

if roots.size == 0:
return f"{gain:.4g}"
return _float2str(gain)

factors = []
for root in sorted(roots, reverse=True):
Expand All @@ -1364,29 +1368,29 @@ def _tf_factorized_polynomial_to_string(roots, gain=1, var='s'):
factor = f"{var}"
factors.append(factor)
elif root > 0:
factor = f"{var} - {np.abs(root):.4g}"
factor = f"{var} - {_float2str(np.abs(root))}"
factors.append(factor)
else:
factor = f"{var} + {np.abs(root):.4g}"
factor = f"{var} + {_float2str(np.abs(root))}"
factors.append(factor)
elif np.isreal(root * 1j):
if root.imag > 0:
factor = f"{var} - {np.abs(root):.4g}j"
factor = f"{var} - {_float2str(np.abs(root))}j"
factors.append(factor)
else:
factor = f"{var} + {np.abs(root):.4g}j"
factor = f"{var} + {_float2str(np.abs(root))}j"
factors.append(factor)
else:
if root.real > 0:
factor = f"{var} - ({root:.4g})"
factor = f"{var} - ({_float2str(root)})"
factors.append(factor)
else:
factor = f"{var} + ({-root:.4g})"
factor = f"{var} + ({_float2str(-root)})"
factors.append(factor)

multiplier = ''
if round(gain, 4) != 1.0:
multiplier = f"{gain:.4g} "
multiplier = _float2str(gain) + " "

if len(factors) > 1 or multiplier:
factors = [f"({factor})" for factor in factors]
Expand Down