Skip to content

fixes issue #2556 #2558

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 8 commits into from
Jan 27, 2014
Merged

fixes issue #2556 #2558

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1b81e9f
fixes issue #2556
tacaswell Oct 29, 2013
fcaf629
pep8 fix
tacaswell Oct 31, 2013
5e69629
renamed import
tacaswell Jan 13, 2014
c312cca
added test_quiver module
tacaswell Jan 14, 2014
4cc466e
fixed memory leak in quiverkey
tacaswell Jan 14, 2014
e0972f0
pep8 + minor variable re-naming
tacaswell Jan 21, 2014
c07f674
removed un-needed weakref
tacaswell Jan 21, 2014
f92ee59
added missing self
tacaswell Jan 22, 2014
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
1 change: 1 addition & 0 deletions lib/matplotlib/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1255,6 +1255,7 @@ def tk_window_focus():
'matplotlib.tests.test_patheffects',
'matplotlib.tests.test_pickle',
'matplotlib.tests.test_png',
'matplotlib.tests.test_quiver',
'matplotlib.tests.test_rcparams',
'matplotlib.tests.test_scale',
'matplotlib.tests.test_simplification',
Expand Down
86 changes: 60 additions & 26 deletions lib/matplotlib/quiver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,12 @@
the Quiver code.
"""


from __future__ import print_function, division
import weakref

import numpy as np
from numpy import ma
import matplotlib.collections as collections
import matplotlib.collections as mcollections
import matplotlib.transforms as transforms
import matplotlib.text as mtext
import matplotlib.artist as martist
Expand Down Expand Up @@ -219,9 +220,9 @@

class QuiverKey(martist.Artist):
""" Labelled arrow for use as a quiver plot scale key."""
halign = {'N': 'center', 'S': 'center', 'E': 'left', 'W': 'right'}
valign = {'N': 'bottom', 'S': 'top', 'E': 'center', 'W': 'center'}
pivot = {'N': 'mid', 'S': 'mid', 'E': 'tip', 'W': 'tail'}
halign = {'N': 'center', 'S': 'center', 'E': 'left', 'W': 'right'}
valign = {'N': 'bottom', 'S': 'top', 'E': 'center', 'W': 'center'}
pivot = {'N': 'mid', 'S': 'mid', 'E': 'tip', 'W': 'tail'}

def __init__(self, Q, X, Y, U, label, **kw):
martist.Artist.__init__(self)
Expand All @@ -235,13 +236,19 @@ def __init__(self, Q, X, Y, U, label, **kw):
self._labelsep_inches = kw.pop('labelsep', 0.1)
self.labelsep = (self._labelsep_inches * Q.ax.figure.dpi)

# try to prevent closure over the real self
weak_self = weakref.ref(self)
Copy link
Member

Choose a reason for hiding this comment

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

This use of weak ref looks fine (and I can't think of an alternative way)


def on_dpi_change(fig):
self.labelsep = (self._labelsep_inches * fig.dpi)
self._initialized = False # simple brute force update
# works because _init is called
# at the start of draw.
self_weakref = weak_self()
if self_weakref is not None:
self_weakref.labelsep = (self_weakref._labelsep_inches*fig.dpi)
self_weakref._initialized = False # simple brute force update
# works because _init is called
# at the start of draw.

Q.ax.figure.callbacks.connect('dpi_changed', on_dpi_change)
self._cid = Q.ax.figure.callbacks.connect('dpi_changed',
on_dpi_change)

self.labelpos = kw.pop('labelpos', 'N')
self.labelcolor = kw.pop('labelcolor', None)
Expand All @@ -254,11 +261,21 @@ def on_dpi_change(fig):
horizontalalignment=self.halign[self.labelpos],
verticalalignment=self.valign[self.labelpos],
fontproperties=font_manager.FontProperties(**_fp))

if self.labelcolor is not None:
self.text.set_color(self.labelcolor)
self._initialized = False
self.zorder = Q.zorder + 0.1

def remove(self):
"""
Overload the remove method
"""
self.Q.ax.figure.callbacks.disconnect(self._cid)
self._cid = None
# pass the remove call up the stack
martist.Artist.remove(self)

__init__.__doc__ = _quiverkey_doc

def _init(self):
Expand All @@ -275,7 +292,7 @@ def _init(self):
self.Q.pivot = _pivot
kw = self.Q.polykw
kw.update(self.kw)
self.vector = collections.PolyCollection(
self.vector = mcollections.PolyCollection(
self.verts,
offsets=[(self.X, self.Y)],
transOffset=self.get_transform(),
Expand Down Expand Up @@ -364,7 +381,7 @@ def _parse_args(*args):
return X, Y, U, V, C


class Quiver(collections.PolyCollection):
class Quiver(mcollections.PolyCollection):
"""
Specialized PolyCollection for arrows.

Expand Down Expand Up @@ -411,7 +428,7 @@ def __init__(self, ax, *args, **kw):
self.transform = kw.pop('transform', ax.transData)
kw.setdefault('facecolors', self.color)
kw.setdefault('linewidths', (0,))
collections.PolyCollection.__init__(self, [], offsets=self.XY,
mcollections.PolyCollection.__init__(self, [], offsets=self.XY,
transOffset=self.transform,
closed=False,
**kw)
Expand All @@ -422,14 +439,30 @@ def __init__(self, ax, *args, **kw):
self.keyvec = None
self.keytext = None

def on_dpi_change(fig):
self._new_UV = True # vertices depend on width, span
# which in turn depend on dpi
self._initialized = False # simple brute force update
# works because _init is called
# at the start of draw.
# try to prevent closure over the real self
weak_self = weakref.ref(self)

self.ax.figure.callbacks.connect('dpi_changed', on_dpi_change)
def on_dpi_change(fig):
self_weakref = weak_self()
if self_weakref is not None:
self_weakref._new_UV = True # vertices depend on width, span
# which in turn depend on dpi
self_weakref._initialized = False # simple brute force update
# works because _init is called
# at the start of draw.

self._cid = self.ax.figure.callbacks.connect('dpi_changed',
on_dpi_change)

def remove(self):
"""
Overload the remove method
"""
# disconnect the call back
self.ax.figure.callbacks.disconnect(self._cid)
self._cid = None
# pass the remove call up the stack
mcollections.PolyCollection.remove(self)

def _init(self):
"""
Expand All @@ -456,7 +489,7 @@ def draw(self, renderer):
verts = self._make_verts(self.U, self.V)
self.set_verts(verts, closed=False)
self._new_UV = False
collections.PolyCollection.draw(self, renderer)
mcollections.PolyCollection.draw(self, renderer)

def set_UVC(self, U, V, C=None):
U = ma.masked_invalid(U, copy=False).ravel()
Expand Down Expand Up @@ -789,7 +822,7 @@ def _h_arrows(self, length):
docstring.interpd.update(barbs_doc=_barbs_doc)


class Barbs(collections.PolyCollection):
class Barbs(mcollections.PolyCollection):
'''
Specialized PolyCollection for barbs.

Expand Down Expand Up @@ -850,8 +883,9 @@ def __init__(self, ax, *args, **kw):

#Make a collection
barb_size = self._length ** 2 / 4 # Empirically determined
collections.PolyCollection.__init__(self, [], (barb_size,), offsets=xy,
transOffset=transform, **kw)
mcollections.PolyCollection.__init__(self, [], (barb_size,),
offsets=xy,
transOffset=transform, **kw)
self.set_transform(transforms.IdentityTransform())

self.set_UVC(u, v, c)
Expand Down Expand Up @@ -1074,7 +1108,7 @@ def set_offsets(self, xy):
x, y, u, v = delete_masked_points(self.x.ravel(), self.y.ravel(),
self.u, self.v)
xy = np.hstack((x[:, np.newaxis], y[:, np.newaxis]))
collections.PolyCollection.set_offsets(self, xy)
set_offsets.__doc__ = collections.PolyCollection.set_offsets.__doc__
mcollections.PolyCollection.set_offsets(self, xy)
set_offsets.__doc__ = mcollections.PolyCollection.set_offsets.__doc__

barbs_doc = _barbs_doc
54 changes: 54 additions & 0 deletions lib/matplotlib/tests/test_quiver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
from __future__ import print_function
import os
import tempfile
import numpy as np
import sys
from matplotlib import pyplot as plt
from matplotlib.testing.decorators import cleanup


WRITER_OUTPUT = dict(ffmpeg='mp4', ffmpeg_file='mp4',
mencoder='mp4', mencoder_file='mp4',
avconv='mp4', avconv_file='mp4',
imagemagick='gif', imagemagick_file='gif')


@cleanup
def test_quiver_memory_leak():
fig, ax = plt.subplots()

X, Y = np.meshgrid(np.arange(0, 2 * np.pi, .04),
np.arange(0, 2 * np.pi, .04))
U = np.cos(X)
V = np.sin(Y)

Q = ax.quiver(U, V)
ttX = Q.X
Q.remove()

del Q

assert sys.getrefcount(ttX) == 2


@cleanup
def test_quiver_key_memory_leak():
fig, ax = plt.subplots()

X, Y = np.meshgrid(np.arange(0, 2 * np.pi, .04),
np.arange(0, 2 * np.pi, .04))
U = np.cos(X)
V = np.sin(Y)

Q = ax.quiver(U, V)

qk = ax.quiverkey(Q, 0.5, 0.92, 2, r'$2 \frac{m}{s}$',
labelpos='W',
fontproperties={'weight': 'bold'})
assert sys.getrefcount(qk) == 3
qk.remove()
assert sys.getrefcount(qk) == 2

if __name__ == '__main__':
import nose
nose.runmodule()