Skip to content

Improve symlog axis ticks #27310

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

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
+357 −177
Open

Improve symlog axis ticks #27310

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
5717116
Rewrite SymmetricalLogLocator
schtandard Nov 10, 2023
f9b3ad4
Remove spurious blank lines
schtandard Nov 10, 2023
af9c0de
Remove spurious comment
schtandard Nov 10, 2023
fbb1a50
Fix small oversights
schtandard Nov 10, 2023
55b45cc
Use minor ticks for symlog scale by default
schtandard Nov 10, 2023
ed204cd
Move symlog helper functions to utility class
schtandard Nov 10, 2023
fa94cc3
Preserve sign (for symlog)
schtandard Nov 10, 2023
5d48e42
Adapt LogFormatter for minor symlog ticks
schtandard Nov 10, 2023
471e668
Fix docstrings
schtandard Nov 10, 2023
7ab92de
Prevent error when using dummy axis
schtandard Nov 11, 2023
f6b395a
Adapt tests to new behavior
schtandard Nov 11, 2023
49151ed
Update type hints
schtandard Nov 12, 2023
3486c5d
Conform to styleguide
schtandard Nov 12, 2023
a11919e
Don't omit the minor ticks around 0
schtandard Nov 12, 2023
d21e6f0
Use dec for calculating numdec, not pos
schtandard Nov 12, 2023
97b9b82
Avoid lonely 0 label
schtandard Nov 12, 2023
92eec64
Add missing argument type hint
schtandard Nov 12, 2023
9cc5db9
Update symlog baseline images
schtandard Nov 12, 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
6 changes: 4 additions & 2 deletions lib/matplotlib/scale.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,7 +440,7 @@ class SymmetricalLogScale(ScaleBase):
"""
name = 'symlog'

def __init__(self, axis, *, base=10, linthresh=2, subs=None, linscale=1):
def __init__(self, axis, *, base=10, linthresh=2, subs='auto', linscale=1):
self._transform = SymmetricalLogTransform(base, linthresh, linscale)
self.subs = subs

Expand All @@ -454,7 +454,9 @@ def set_default_locators_and_formatters(self, axis):
axis.set_major_formatter(LogFormatterSciNotation(self.base))
axis.set_minor_locator(SymmetricalLogLocator(self.get_transform(),
self.subs))
axis.set_minor_formatter(NullFormatter())
axis.set_minor_formatter(
LogFormatterSciNotation(self.base,
labelOnlyBase=(self.subs != 'auto')))

def get_transform(self):
"""Return the `.SymmetricalLogTransform` associated with this scale."""
Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/scale.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ class SymmetricalLogScale(ScaleBase):
*,
base: float = ...,
linthresh: float = ...,
subs: Iterable[int] | None = ...,
subs: Iterable[int] | Literal["auto", "all"] | None = ...,
linscale: float = ...
) -> None: ...
@property
Expand Down
Binary file modified lib/matplotlib/tests/baseline_images/test_axes/symlog.pdf
View file
Open in desktop
Binary file not shown.
Binary file modified lib/matplotlib/tests/baseline_images/test_axes/symlog2.pdf
View file
Open in desktop
Binary file not shown.
28 changes: 15 additions & 13 deletions lib/matplotlib/tests/test_ticker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -601,45 +601,47 @@ def test_set_params(self):
class TestSymmetricalLogLocator:
def test_set_params(self):
"""
Create symmetrical log locator with default subs =[1.0] numticks = 15,
Create symmetrical log locator with default subs=[1.0] numticks='auto',
and change it to something else.
See if change was successful.
Should not exception.
"""
sym = mticker.SymmetricalLogLocator(base=10, linthresh=1)
sym = mticker.SymmetricalLogLocator(base=10, linthresh=1, linscale=1)
sym.set_params(subs=[2.0], numticks=8)
assert sym._subs == [2.0]
assert sym.numticks == 8

@pytest.mark.parametrize(
'vmin, vmax, expected',
[
(0, 1, [0, 1]),
(-1, 1, [-1, 0, 1]),
(0, 1, [-1, 0, 1, 10]),
(-1, 1, [-10, -1, 0, 1, 10]),
],
)
def test_values(self, vmin, vmax, expected):
# https://github.com/matplotlib/matplotlib/issues/25945
sym = mticker.SymmetricalLogLocator(base=10, linthresh=1)
sym = mticker.SymmetricalLogLocator(base=10, linthresh=1, linscale=1)
ticks = sym.tick_values(vmin=vmin, vmax=vmax)
assert_array_equal(ticks, expected)

def test_subs(self):
sym = mticker.SymmetricalLogLocator(base=10, linthresh=1, subs=[2.0, 4.0])
sym = mticker.SymmetricalLogLocator(base=10, linthresh=1, linscale=1,
subs=[2.0, 4.0])
sym.create_dummy_axis()
sym.axis.set_view_interval(-10, 10)
assert (sym() == [-20., -40., -2., -4., 0., 2., 4., 20., 40.]).all()
assert (sym() == [-400., -200., -40., -20., -4., -2., -0.4, -0.2, -0.1, 0.,
0.1, 0.2, 0.4, 2., 4., 20., 40., 200., 400.]).all()

def test_extending(self):
sym = mticker.SymmetricalLogLocator(base=10, linthresh=1)
sym = mticker.SymmetricalLogLocator(base=10, linthresh=1, linscale=1)
sym.create_dummy_axis()
sym.axis.set_view_interval(8, 9)
assert (sym() == [1.0]).all()
sym.axis.set_view_interval(8, 12)
assert (sym() == [1.0, 10.0]).all()
assert sym.view_limits(10, 10) == (1, 100)
assert sym.view_limits(-10, -10) == (-100, -1)
assert sym.view_limits(0, 0) == (-0.001, 0.001)
sym.axis.set_view_interval(8, 12)
assert (sym() == [1.0, 10.0, 100.0]).all()
assert sym.view_limits(10, 10) == (1.0, 100.0)
assert sym.view_limits(-10, -10) == (-100.0, -1.0)
assert sym.view_limits(0, 0) == (-1.0, 1.0)


class TestAsinhLocator:
Expand Down
Loading