Skip to content

FIX: Support passing one alpha per event sequence to eventplot() #24431

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
merged 1 commit into from
Nov 23, 2022
Merged

FIX: Support passing one alpha per event sequence to eventplot() #24431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 22 additions & 7 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1184,7 +1184,7 @@ def vlines(self, x, ymin, ymax, colors=None, linestyles='solid',
"colors", "linestyles"])
@_docstring.dedent_interpd
def eventplot(self, positions, orientation='horizontal', lineoffsets=1,
linelengths=1, linewidths=None, colors=None,
linelengths=1, linewidths=None, colors=None, alpha=None,
linestyles='solid', **kwargs):
"""
Plot identical parallel lines at the given positions.
Expand Down Expand Up @@ -1246,6 +1246,13 @@ def eventplot(self, positions, orientation='horizontal', lineoffsets=1,
If *positions* is 2D, this can be a sequence with length matching
the length of *positions*.

alpha : float or array-like, default: 1
The alpha blending value(s), between 0 (transparent) and 1
(opaque).

If *positions* is 2D, this can be a sequence with length matching
the length of *positions*.

linestyles : str or tuple or list of such values, default: 'solid'
Default is 'solid'. Valid strings are ['solid', 'dashed',
'dashdot', 'dotted', '-', '--', '-.', ':']. Dash tuples
Expand Down Expand Up @@ -1273,8 +1280,8 @@ def eventplot(self, positions, orientation='horizontal', lineoffsets=1,

Notes
-----
For *linelengths*, *linewidths*, *colors*, and *linestyles*, if only
a single value is given, that value is applied to all lines. If an
For *linelengths*, *linewidths*, *colors*, *alpha* and *linestyles*, if
only a single value is given, that value is applied to all lines. If an
array-like is given, it must have the same length as *positions*, and
each value will be applied to the corresponding row of the array.

Expand Down Expand Up @@ -1316,6 +1323,8 @@ def eventplot(self, positions, orientation='horizontal', lineoffsets=1,
linewidths = [linewidths]
if not np.iterable(colors):
colors = [colors]
if not np.iterable(alpha):
alpha = [alpha]
if hasattr(linestyles, 'lower') or not np.iterable(linestyles):
linestyles = [linestyles]

Expand Down Expand Up @@ -1352,8 +1361,9 @@ def eventplot(self, positions, orientation='horizontal', lineoffsets=1,
if len(linewidths) == 1:
linewidths = np.tile(linewidths, len(positions))
if len(colors) == 1:
colors = list(colors)
colors = colors * len(positions)
colors = list(colors) * len(positions)
if len(alpha) == 1:
alpha = list(alpha) * len(positions)
if len(linestyles) == 1:
linestyles = [linestyles] * len(positions)

Expand All @@ -1369,20 +1379,25 @@ def eventplot(self, positions, orientation='horizontal', lineoffsets=1,
if len(colors) != len(positions):
raise ValueError('colors and positions are unequal sized '
'sequences')
if len(alpha) != len(positions):
raise ValueError('alpha and positions are unequal sized '
'sequences')
if len(linestyles) != len(positions):
raise ValueError('linestyles and positions are unequal sized '
'sequences')

colls = []
for position, lineoffset, linelength, linewidth, color, linestyle in \
for position, lineoffset, linelength, linewidth, color, alpha_, \
linestyle in \
zip(positions, lineoffsets, linelengths, linewidths,
colors, linestyles):
colors, alpha, linestyles):
coll = mcoll.EventCollection(position,
orientation=orientation,
lineoffset=lineoffset,
linelength=linelength,
linewidth=linewidth,
color=color,
alpha=alpha_,
linestyle=linestyle)
self.add_collection(coll, autolim=False)
coll._internal_update(kwargs)
Expand Down
4 changes: 2 additions & 2 deletions lib/matplotlib/pyplot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2519,12 +2519,12 @@ def errorbar(
@_copy_docstring_and_deprecators(Axes.eventplot)
def eventplot(
positions, orientation='horizontal', lineoffsets=1,
linelengths=1, linewidths=None, colors=None,
linelengths=1, linewidths=None, colors=None, alpha=None,
linestyles='solid', *, data=None, **kwargs):
return gca().eventplot(
positions, orientation=orientation, lineoffsets=lineoffsets,
linelengths=linelengths, linewidths=linewidths, colors=colors,
linestyles=linestyles,
alpha=alpha, linestyles=linestyles,
**({"data": data} if data is not None else {}), **kwargs)


Expand Down
20 changes: 20 additions & 0 deletions lib/matplotlib/tests/test_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4559,6 +4559,26 @@ def test_eventplot_colors(colors):
assert_allclose(coll.get_color(), color)


def test_eventplot_alpha():
fig, ax = plt.subplots()

# one alpha for all
collections = ax.eventplot([[0, 2, 4], [1, 3, 5, 7]], alpha=0.7)
assert collections[0].get_alpha() == 0.7
assert collections[1].get_alpha() == 0.7

# one alpha per collection
collections = ax.eventplot([[0, 2, 4], [1, 3, 5, 7]], alpha=[0.5, 0.7])
assert collections[0].get_alpha() == 0.5
assert collections[1].get_alpha() == 0.7

with pytest.raises(ValueError, match="alpha and positions are unequal"):
ax.eventplot([[0, 2, 4], [1, 3, 5, 7]], alpha=[0.5, 0.7, 0.9])

with pytest.raises(ValueError, match="alpha and positions are unequal"):
ax.eventplot([0, 2, 4], alpha=[0.5, 0.7])


@image_comparison(['test_eventplot_problem_kwargs.png'], remove_text=True)
def test_eventplot_problem_kwargs(recwarn):
"""
Expand Down