Matplotlib savefig with a legend outside the plot
Question:
Reading the following article, I managed to put a legend outside plot.
code:
import matplotlib.pyplot as pyplot
x = [0, 1, 2, 3, 4]
y = [xx*xx for xx in x]
fig = pyplot.figure()
ax = fig.add_subplot(111)
box = ax.get_position()
ax.set_position([box.x0, box.y0, box.width*0.8, box.height])
ax.plot(x, y)
leg = ax.legend(['abc'], loc = 'center left', bbox_to_anchor = (1.0, 0.5))
#pyplot.show()
fig.savefig('aaa.png', bbox_inches='tight')
pyplot.show() displays the correct plot with a legend outside it. But when I save it as a file with fig.savefig(), the legend is truncated.
Some googling shows me workarounds such as adding bbox_extra_artists=[leg.legendPatch] or bbox_extra_artists=[leg] to savefig(), but neither worked.
What is the correct way to do it? Matplotlib version is 0.99.3.
Thanks.
Answers:
The problem is that when you plot dynamically, matplotlib determines the borders automatically to fit all your objects.
When you save a file, things are not being done automatically, so you need to specify
the size of your figure, and then the bounding box of your axes object.
Here is how to correct your code:
import matplotlib.pyplot as pyplot
x = [0, 1, 2, 3, 4]
y = [xx*xx for xx in x]
fig = pyplot.figure(figsize=(3,3))
ax = fig.add_subplot(111)
#box = ax.get_position()
#ax.set_position([0.3, 0.4, box.width*0.3, box.height])
# you can set the position manually, with setting left,buttom, witdh, hight of the axis
# object
ax.set_position([0.1,0.1,0.5,0.8])
ax.plot(x, y)
leg = ax.legend(['abc'], loc = 'center left', bbox_to_anchor = (1.0, 0.5))
fig.savefig('aaa.png')
Although this method works with legend, it seems not to be working well with figlegend when there are multiple subplots and we want a single overall legend. figlegend still get cropped when savefig. I just pasted my temporary solution below in case someone faces such a case.
import matplotlib.pyplot as plt
para = {
## this parameter will indicate the position of
## subplot within figure, but will not be shown
## if using bbox_inches='tight' when saving
'figure.subplot.top': 0.5
}
#plt.rcParams.update(para)
fig = plt.figure()
ax=fig.add_subplot(221)
## only needed when what to manually control
## subplot ration
#ax.set_position([0.1,0.6,0.5, 0.4])
ax.plot([1,1,1])
ax=fig.add_subplot(222)
#ax.set_position([0.7,0.6,0.5, 0.4])
ax.plot([2,2,2])
ax=fig.add_subplot(223)
#ax.set_position([0.1,0.1,0.5, 0.4])
ax.plot([3,3,3])
ax=fig.add_subplot(224)
#ax.set_position([0.7,0.1,0.5, 0.4])
p1, = ax.plot([4,4,4])
p2, = ax.plot([2,3,2])
## figlegend does not work fine with tight bbox
## the legend always get cropped by this option
## even add bbox extra will not help
## had to use legend, and manually adjust it to
## arbitary position such as (0.3, 2.5)
## http://matplotlib.org/users/tight_layout_guide.html
## according to this link, tight layout is only
## an experimental feature, might not support figlegend
#lgd = plt.figlend(
lgd = plt.legend(
[p1,p2],
['a', 'b'],
## by default, legend anchor to axis, but can
## also be anchored to arbitary position
## positions within [1,1] would be within the figure
## all numbers are ratio by default
bbox_to_anchor=(-0.1, 2.5),
## loc indicates the position within the figure
## it is defined consistent to the same Matlab function
loc='center',
ncol=2
#mode="expand",
#borderaxespad=0.
)
#plt.show()
plt.savefig('temp.png', bbox_inches='tight')#, bbox_extra_artist=[lgd])
If all else fails, I use Inkscape’s bounding-box features to deal with what I would call persistent bugs in matplotlib’s output. If you’re running GNU/Linux, just save whatever Matplotlib gives you as a pdf, and then send it to the following
def tightBoundingBoxInkscape(pdffile,use_xvfb=True):
"""Makes POSIX-specific OS calls. Preferably, have xvfb installed, to avoid any GUI popping up in the background. If it fails anyway, could always resort to use_xvfb=False, which will allow some GUIs to show as they carry out the task
pdffile: the path for a PDF file, without its extension
"""
usexvfb='xvfb-run '*use_xvfb
import os
assert not pdffile.endswith('.pdf')
os.system("""
inkscape -f %(FN)s.pdf -l %(FN)s_tmp.svg
inkscape -f %(FN)s_tmp.svg --verb=FitCanvasToDrawing
--verb=FileSave
--verb=FileQuit
inkscape -f %(FN)s_tmp.svg -A %(FN)s-tightbb.pdf
"""%{'FN':pdffile}
For most cases, a simple fix cases is to amend the plt.savefig() command:
plt.savefig('your_figure.png', bbox_inches='tight')
This solution has already been suggested in the comments below the question, but I overlooked those and found it in the matplotlib issues on GitHub. Keeping this answer for others who didn’t read the comments on top.
Reading the following article, I managed to put a legend outside plot.
code:
import matplotlib.pyplot as pyplot
x = [0, 1, 2, 3, 4]
y = [xx*xx for xx in x]
fig = pyplot.figure()
ax = fig.add_subplot(111)
box = ax.get_position()
ax.set_position([box.x0, box.y0, box.width*0.8, box.height])
ax.plot(x, y)
leg = ax.legend(['abc'], loc = 'center left', bbox_to_anchor = (1.0, 0.5))
#pyplot.show()
fig.savefig('aaa.png', bbox_inches='tight')
pyplot.show() displays the correct plot with a legend outside it. But when I save it as a file with fig.savefig(), the legend is truncated.
Some googling shows me workarounds such as adding bbox_extra_artists=[leg.legendPatch] or bbox_extra_artists=[leg] to savefig(), but neither worked.
What is the correct way to do it? Matplotlib version is 0.99.3.
Thanks.
The problem is that when you plot dynamically, matplotlib determines the borders automatically to fit all your objects.
When you save a file, things are not being done automatically, so you need to specify
the size of your figure, and then the bounding box of your axes object.
Here is how to correct your code:
import matplotlib.pyplot as pyplot
x = [0, 1, 2, 3, 4]
y = [xx*xx for xx in x]
fig = pyplot.figure(figsize=(3,3))
ax = fig.add_subplot(111)
#box = ax.get_position()
#ax.set_position([0.3, 0.4, box.width*0.3, box.height])
# you can set the position manually, with setting left,buttom, witdh, hight of the axis
# object
ax.set_position([0.1,0.1,0.5,0.8])
ax.plot(x, y)
leg = ax.legend(['abc'], loc = 'center left', bbox_to_anchor = (1.0, 0.5))
fig.savefig('aaa.png')
Although this method works with legend, it seems not to be working well with figlegend when there are multiple subplots and we want a single overall legend. figlegend still get cropped when savefig. I just pasted my temporary solution below in case someone faces such a case.
import matplotlib.pyplot as plt
para = {
## this parameter will indicate the position of
## subplot within figure, but will not be shown
## if using bbox_inches='tight' when saving
'figure.subplot.top': 0.5
}
#plt.rcParams.update(para)
fig = plt.figure()
ax=fig.add_subplot(221)
## only needed when what to manually control
## subplot ration
#ax.set_position([0.1,0.6,0.5, 0.4])
ax.plot([1,1,1])
ax=fig.add_subplot(222)
#ax.set_position([0.7,0.6,0.5, 0.4])
ax.plot([2,2,2])
ax=fig.add_subplot(223)
#ax.set_position([0.1,0.1,0.5, 0.4])
ax.plot([3,3,3])
ax=fig.add_subplot(224)
#ax.set_position([0.7,0.1,0.5, 0.4])
p1, = ax.plot([4,4,4])
p2, = ax.plot([2,3,2])
## figlegend does not work fine with tight bbox
## the legend always get cropped by this option
## even add bbox extra will not help
## had to use legend, and manually adjust it to
## arbitary position such as (0.3, 2.5)
## http://matplotlib.org/users/tight_layout_guide.html
## according to this link, tight layout is only
## an experimental feature, might not support figlegend
#lgd = plt.figlend(
lgd = plt.legend(
[p1,p2],
['a', 'b'],
## by default, legend anchor to axis, but can
## also be anchored to arbitary position
## positions within [1,1] would be within the figure
## all numbers are ratio by default
bbox_to_anchor=(-0.1, 2.5),
## loc indicates the position within the figure
## it is defined consistent to the same Matlab function
loc='center',
ncol=2
#mode="expand",
#borderaxespad=0.
)
#plt.show()
plt.savefig('temp.png', bbox_inches='tight')#, bbox_extra_artist=[lgd])
If all else fails, I use Inkscape’s bounding-box features to deal with what I would call persistent bugs in matplotlib’s output. If you’re running GNU/Linux, just save whatever Matplotlib gives you as a pdf, and then send it to the following
def tightBoundingBoxInkscape(pdffile,use_xvfb=True):
"""Makes POSIX-specific OS calls. Preferably, have xvfb installed, to avoid any GUI popping up in the background. If it fails anyway, could always resort to use_xvfb=False, which will allow some GUIs to show as they carry out the task
pdffile: the path for a PDF file, without its extension
"""
usexvfb='xvfb-run '*use_xvfb
import os
assert not pdffile.endswith('.pdf')
os.system("""
inkscape -f %(FN)s.pdf -l %(FN)s_tmp.svg
inkscape -f %(FN)s_tmp.svg --verb=FitCanvasToDrawing
--verb=FileSave
--verb=FileQuit
inkscape -f %(FN)s_tmp.svg -A %(FN)s-tightbb.pdf
"""%{'FN':pdffile}
For most cases, a simple fix cases is to amend the plt.savefig() command:
plt.savefig('your_figure.png', bbox_inches='tight')
This solution has already been suggested in the comments below the question, but I overlooked those and found it in the matplotlib issues on GitHub. Keeping this answer for others who didn’t read the comments on top.