Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Stem performance boost #9565

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

Closed
wants to merge 1 commit into from
Closed

Stem performance boost #9565

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
10 changes: 10 additions & 0 deletions doc/api/api_changes/2017-10-24-DS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
`StemContainer` now stores `LineCollection`
-------------------------------------------

`StemContainer` objects now store a `LineCollection` object instead of a list
of `Line2D` objects for stem lines plotted using `ax.stem`. This gives a very
large performance boost to displaying and moving `ax.stem` plots.

Line segments can be extracted from the `LineCollection` using
`LineCollection.get_segements()`. See the `LineCollection` documentation for
Copy link
Contributor

Choose a reason for hiding this comment

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

typo segments

other methods to retrieve the collection properties.
13 changes: 8 additions & 5 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2370,6 +2370,9 @@ def stem(self, *args, linefmt=None, markerfmt=None, basefmt=None,
x = y
y = np.asarray(args[0], dtype=float)
args = args[1:]
self._process_unit_info(xdata=x, ydata=y)
x = self.convert_xunits(x)
y = self.convert_yunits(y)

# defaults for formats
if linefmt is None:
Expand Down Expand Up @@ -2421,12 +2424,12 @@ def stem(self, *args, linefmt=None, markerfmt=None, basefmt=None,
markerline, = self.plot(x, y, color=markercolor, linestyle=markerstyle,
marker=markermarker, label="_nolegend_")

stemlines = []
lines = []
for thisx, thisy in zip(x, y):
l, = self.plot([thisx, thisx], [bottom, thisy],
color=linecolor, linestyle=linestyle,
marker=linemarker, label="_nolegend_")
Copy link
Member

Choose a reason for hiding this comment

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

What happened to marker?

stemlines.append(l)
lines.append(((thisx, bottom), (thisx, thisy)))
stemlines = mcoll.LineCollection(lines, linestyles=linestyle,
colors=linecolor, label='_nolegend_')
self.add_collection(stemlines)

baseline, = self.plot([np.min(x), np.max(x)], [bottom, bottom],
color=basecolor, linestyle=basestyle,
Expand Down
11 changes: 9 additions & 2 deletions lib/matplotlib/container.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,10 +174,17 @@ class StemContainer(Container):

baseline : :class:`~matplotlib.lines.Line2D`
The artist of the horizontal baseline.

"""

Copy link
Member

Choose a reason for hiding this comment

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

Don't need to remove this line.

def __init__(self, markerline_stemlines_baseline, **kwargs):
'''
Parameters
----------
markerline_stemlines_baseline : tuple
Tuple of ``(markerline, stemlines, baseline)``.
``markerline`` contains the `LineCollection` of the markers,
``stemlines`` is a `LineCollection` of the main lines,
``baseline`` is the `Line2D` of the baseline.
'''
markerline, stemlines, baseline = markerline_stemlines_baseline
self.markerline = markerline
self.stemlines = stemlines
Expand Down
34 changes: 23 additions & 11 deletions lib/matplotlib/legend_handler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -589,7 +589,6 @@ def get_ydata(self, legend, xdescent, ydescent, width, height, fontsize):
def create_artists(self, legend, orig_handle,
xdescent, ydescent, width, height, fontsize,
trans):

markerline, stemlines, baseline = orig_handle

xdata, xdata_marker = self.get_xdata(legend, xdescent, ydescent,
Expand All @@ -603,31 +602,44 @@ def create_artists(self, legend, orig_handle,
else:
bottom = self._bottom

leg_markerline = Line2D(xdata_marker, ydata[:len(xdata_marker)])
self.update_prop(leg_markerline, markerline, legend)

leg_stemlines = []
for thisx, thisy in zip(xdata_marker, ydata):
l = Line2D([thisx, thisx], [bottom, thisy])
leg_stemlines.append(l)

for lm, m in zip(leg_stemlines, stemlines):
self.update_prop(lm, m, legend)
# update_prop() usually takes two Line2D collections;
# override temporarily to copy properties from a LineCollection
orig_update_func = self._update_prop_func
self._update_prop_func = self._copy_collection_props

for thisx, thisy in zip(xdata_marker, ydata):
thisline = Line2D([thisx, thisx], [bottom, thisy])
leg_stemlines.append(thisline)
self.update_prop(thisline, stemlines, legend)
# Reset update_prop_func
self._update_prop_func = orig_update_func

leg_baseline = Line2D([np.min(xdata), np.max(xdata)],
[bottom, bottom])

self.update_prop(leg_baseline, baseline, legend)

artists = [leg_markerline]
artists.extend(leg_stemlines)
leg_markerline = Line2D(xdata_marker, ydata[:len(xdata_marker)])
self.update_prop(leg_markerline, markerline, legend)

artists = leg_stemlines
Copy link
Member

@QuLogic QuLogic Jul 13, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

I think @anntzer would say that you can use Python 3 syntax now:
artists = [*leg_stemlines, leg_baseline, leg_markerline]

artists.append(leg_baseline)
artists.append(leg_markerline)

for artist in artists:
artist.set_transform(trans)

return artists

def _copy_collection_props(self, legend_handle, orig_handle):
Copy link
Member Author

Choose a reason for hiding this comment

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

I managed to fix the legend properties by adding this function, which kind of works.

'''
Method to copy properties from a LineCollection (orig_handle) to a
Line2D (legend_handle).
'''
legend_handle._color = orig_handle.get_color()[0]


class HandlerTuple(HandlerBase):
"""
Expand Down
Binary file added lib/matplotlib/tests/baseline_images/test_axes/stem.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 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 @@ -2876,6 +2876,17 @@ def test_hist_stacked_weighted():
ax.hist((d1, d2), weights=(w1, w2), histtype="stepfilled", stacked=True)


@image_comparison(baseline_images=['stem'], extensions=['png'], style='mpl20',
remove_text=True)
def test_stem():
x = np.linspace(0.1, 2 * np.pi, 100)

fig, ax = plt.subplots()
ax.stem(x, np.cos(x), linefmt='C2-', markerfmt='k+', basefmt='C1-.',
label='Stem')
ax.legend()


def test_stem_args():
fig = plt.figure()
ax = fig.add_subplot(1, 1, 1)
Expand Down