|
""" This module provides the routine to adjust subplot layouts so that there are no overlapping axes or axes decorations. All axes decorations are dealt with (labels, ticks, titles, ticklabels) and some dependent artists are also dealt with (colorbar, suptitle, legend).
Layout is done via :meth:`~matplotlib.gridspec`, with one constraint per gridspec, so it is possible to have overlapping axes if the gridspecs overlap (i.e. using :meth:`~matplotlib.gridspec.GridSpecFromSubplotSpec`). Axes placed using ``figure.subplots()`` or ``figure.add_subplots()`` will participate in the layout. Axes manually placed via ``figure.add_axes()`` will not.
See Tutorial: :doc:`/tutorials/intermediate/constrainedlayout_guide`
"""
# Development Notes:
# What gets a layoutbox: # - figure # - gridspec # - subplotspec # EITHER: # - axes + pos for the axes (i.e. the total area taken by axis and # the actual "position" argument that needs to be sent to # ax.set_position.) # - The axes layout box will also encomapss the legend, and that is # how legends get included (axes legeneds, not figure legends) # - colorbars are sibblings of the axes if they are single-axes # colorbars # OR: # - a gridspec can be inside a subplotspec. # - subplotspec # EITHER: # - axes... # OR: # - gridspec... with arbitrary nesting... # - colorbars are siblings of the subplotspecs if they are multi-axes # colorbars. # - suptitle: # - right now suptitles are just stacked atop everything else in figure. # Could imagine suptitles being gridspec suptitles, but not implimented # # Todo: AnchoredOffsetbox connected to gridspecs or axes. This would # be more general way to add extra-axes annotations.
return (colnumCmin <= colnum0min <= colnumCmax or colnumCmin <= colnum0max <= colnumCmax)
return (rownumCmin <= rownum0min <= rownumCmax or rownumCmin <= rownum0max <= rownumCmax)
""" helper function to make sure all axes in the figure have a finite width and height. If not, return False """ for ax in fig.axes: if ax._layoutbox is not None: newpos = ax._poslayoutbox.get_rect() if newpos[2] <= 0 or newpos[3] <= 0: return False return True
###################################################### hspace=None, wspace=None):
""" Do the constrained_layout. Called at draw time in ``figure.constrained_layout()``
Parameters ----------
fig: Figure is the ``figure`` instance to do the layout in.
renderer: Renderer the renderer to use.
h_pad, w_pad : float are in figure-normalized units, and are a padding around the axes elements.
hspace, wspace : float are in fractions of the subplot sizes.
"""
''' Steps:
1. get a list of unique gridspecs in this figure. Each gridspec will be constrained separately. 2. Check for gaps in the gridspecs. i.e. if not every axes slot in the gridspec has been filled. If empty, add a ghost axis that is made so that it cannot be seen (though visible=True). This is needed to make a blank spot in the layout. 3. Compare the tight_bbox of each axes to its `position`, and assume that the difference is the space needed by the elements around the edge of the axes (decorations) like the title, ticklabels, x-labels, etc. This can include legends who overspill the axes boundaries. 4. Constrain gridspec elements to line up: a) if colnum0 neq colnumC, the two subplotspecs are stacked next to each other, with the appropriate order. b) if colnum0 == columnC line up the left or right side of the _poslayoutbox (depending if it is the min or max num that is equal). c) do the same for rows... 5. The above doesn't constrain relative sizes of the _poslayoutboxes at all, and indeed zero-size is a solution that the solver often finds more convenient than expanding the sizes. Right now the solution is to compare subplotspec sizes (i.e. drowsC and drows0) and constrain the larger _poslayoutbox to be larger than the ratio of the sizes. i.e. if drows0 > drowsC, then ax._poslayoutbox > axc._poslayoutbox * drowsC / drows0. This works fine *if* the decorations are similar between the axes. If the larger subplotspec has much larger axes decorations, then the constraint above is incorrect.
We need the greater than in the above, in general, rather than an equals sign. Consider the case of the left column having 2 rows, and the right column having 1 row. We want the top and bottom of the _poslayoutboxes to line up. So that means if there are decorations on the left column axes they will be smaller than half as large as the right hand axis.
This can break down if the decoration size for the right hand axis (the margins) is very large. There must be a math way to check for this case.
'''
invTransFig = fig.transFigure.inverted().transform_bbox
# list of unique gridspecs that contain child axes: gss = set() for ax in fig.axes: if hasattr(ax, 'get_subplotspec'): gs = ax.get_subplotspec().get_gridspec() if gs._layoutbox is not None: gss.add(gs) if len(gss) == 0: warnings.warn('There are no gridspecs with layoutboxes. ' 'Possibly did not call parent GridSpec with the figure= ' 'keyword')
if fig._layoutbox.constrained_layout_called < 1: for gs in gss: # fill in any empty gridspec slots w/ ghost axes... _make_ghost_gridspec_slots(fig, gs)
for nnn in range(2): # do the algrithm twice. This has to be done because decorators # change size after the first re-position (i.e. x/yticklabels get # larger/smaller). This second reposition tends to be much milder, # so doing twice makes things work OK. for ax in fig.axes: _log.debug(ax._layoutbox) if ax._layoutbox is not None: # make margins for each layout box based on the size of # the decorators. _make_layout_margins(ax, renderer, h_pad, w_pad)
# do layout for suptitle. if fig._suptitle is not None and fig._suptitle._layoutbox is not None: sup = fig._suptitle bbox = invTransFig(sup.get_window_extent(renderer=renderer)) height = bbox.y1 - bbox.y0 sup._layoutbox.edit_height(height+h_pad)
# OK, the above lines up ax._poslayoutbox with ax._layoutbox # now we need to # 1) arrange the subplotspecs. We do it at this level because # the subplotspecs are meant to contain other dependent axes # like colorbars or legends. # 2) line up the right and left side of the ax._poslayoutbox # that have the same subplotspec maxes.
if fig._layoutbox.constrained_layout_called < 1: # arrange the subplotspecs... This is all done relative to each # other. Some subplotspecs conatain axes, and others contain # gridspecs the ones that contain gridspecs are a set proportion # of their parent gridspec. The ones that contain axes are # not so constrained. figlb = fig._layoutbox for child in figlb.children: if child._is_gridspec_layoutbox(): # This routine makes all the subplot spec containers # have the correct arrangement. It just stacks the # subplot layoutboxes in the correct order... _arrange_subplotspecs(child, hspace=hspace, wspace=wspace)
for gs in gss: _align_spines(fig, gs)
fig._layoutbox.constrained_layout_called += 1 fig._layoutbox.update_variables()
# check if any axes collapsed to zero. If not, don't change positions: if _axes_all_finite_sized(fig): # Now set the position of the axes... for ax in fig.axes: if ax._layoutbox is not None: newpos = ax._poslayoutbox.get_rect() # Now set the new position. # ax.set_position will zero out the layout for # this axis, allowing users to hard-code the position, # so this does the same w/o zeroing layout. ax._set_position(newpos, which='original') else: warnings.warn('constrained_layout not applied. At least ' 'one axes collapsed to zero width or height.')
""" Check for unoccupied gridspec slots and make ghost axes for these slots... Do for each gs separately. This is a pretty big kludge but shoudn't have too much ill effect. The worst is that someone querrying the figure will wonder why there are more axes than they thought. """ nrows, ncols = gs.get_geometry() hassubplotspec = np.zeros(nrows * ncols, dtype=bool) axs = [] for ax in fig.axes: if (hasattr(ax, 'get_subplotspec') and ax._layoutbox is not None and ax.get_subplotspec().get_gridspec() == gs): axs += [ax] for ax in axs: ss0 = ax.get_subplotspec() if ss0.num2 is None: ss0.num2 = ss0.num1 hassubplotspec[ss0.num1:(ss0.num2 + 1)] = True for nn, hss in enumerate(hassubplotspec): if not hss: # this gridspec slot doesn't have an axis so we # make a "ghost". ax = fig.add_subplot(gs[nn]) ax.set_frame_on(False) ax.set_xticks([]) ax.set_yticks([]) ax.set_facecolor((1, 0, 0, 0))
""" For each axes, make a margin between the *pos* layoutbox and the *axes* layoutbox be a minimum size that can accommodate the decorations on the axis. """ fig = ax.figure invTransFig = fig.transFigure.inverted().transform_bbox
pos = ax.get_position(original=True) tightbbox = ax.get_tightbbox(renderer=renderer) bbox = invTransFig(tightbbox) # use stored h_pad if it exists h_padt = ax._poslayoutbox.h_pad if h_padt is None: h_padt = h_pad w_padt = ax._poslayoutbox.w_pad if w_padt is None: w_padt = w_pad ax._poslayoutbox.edit_left_margin_min(-bbox.x0 + pos.x0 + w_padt) ax._poslayoutbox.edit_right_margin_min(bbox.x1 - pos.x1 + w_padt) ax._poslayoutbox.edit_bottom_margin_min( -bbox.y0 + pos.y0 + h_padt) ax._poslayoutbox.edit_top_margin_min(bbox.y1-pos.y1+h_padt) _log.debug('left %f', (-bbox.x0 + pos.x0 + w_pad)) _log.debug('right %f', (bbox.x1 - pos.x1 + w_pad)) _log.debug('bottom %f', (-bbox.y0 + pos.y0 + h_padt)) # Sometimes its possible for the solver to collapse # rather than expand axes, so they all have zero height # or width. This stops that... It *should* have been # taken into account w/ pref_width... if fig._layoutbox.constrained_layout_called < 1: ax._poslayoutbox.constrain_height_min(20, strength='weak') ax._poslayoutbox.constrain_width_min(20, strength='weak') ax._layoutbox.constrain_height_min(20, strength='weak') ax._layoutbox.constrain_width_min(20, strength='weak') ax._poslayoutbox.constrain_top_margin(0, strength='weak') ax._poslayoutbox.constrain_bottom_margin(0, strength='weak') ax._poslayoutbox.constrain_right_margin(0, strength='weak') ax._poslayoutbox.constrain_left_margin(0, strength='weak')
""" - Align right/left and bottom/top spines of appropriate subplots. - Compare size of subplotspec including height and width ratios and make sure that the axes spines are at least as large as they should be. """ # for each gridspec... nrows, ncols = gs.get_geometry() width_ratios = gs.get_width_ratios() height_ratios = gs.get_height_ratios() if width_ratios is None: width_ratios = np.ones(ncols) if height_ratios is None: height_ratios = np.ones(nrows)
# get axes in this gridspec.... axs = [] for ax in fig.axes: if (hasattr(ax, 'get_subplotspec') and ax._layoutbox is not None): if ax.get_subplotspec().get_gridspec() == gs: axs += [ax] rownummin = np.zeros(len(axs), dtype=np.int8) rownummax = np.zeros(len(axs), dtype=np.int8) colnummin = np.zeros(len(axs), dtype=np.int8) colnummax = np.zeros(len(axs), dtype=np.int8) width = np.zeros(len(axs)) height = np.zeros(len(axs))
for n, ax in enumerate(axs): ss0 = ax.get_subplotspec() if ss0.num2 is None: ss0.num2 = ss0.num1 rownummin[n], colnummin[n] = divmod(ss0.num1, ncols) rownummax[n], colnummax[n] = divmod(ss0.num2, ncols) width[n] = np.sum( width_ratios[colnummin[n]:(colnummax[n] + 1)]) height[n] = np.sum( height_ratios[rownummin[n]:(rownummax[n] + 1)])
for nn, ax in enumerate(axs[:-1]): ss0 = ax.get_subplotspec()
# now compare ax to all the axs: # # If the subplotspecs have the same colnumXmax, then line # up their right sides. If they have the same min, then # line up their left sides (and vertical equivalents). rownum0min, colnum0min = rownummin[nn], colnummin[nn] rownum0max, colnum0max = rownummax[nn], colnummax[nn] width0, height0 = width[nn], height[nn] alignleft = False alignright = False alignbot = False aligntop = False alignheight = False alignwidth = False for mm in range(nn+1, len(axs)): axc = axs[mm] rownumCmin, colnumCmin = rownummin[mm], colnummin[mm] rownumCmax, colnumCmax = rownummax[mm], colnummax[mm] widthC, heightC = width[mm], height[mm] # Horizontally align axes spines if they have the # same min or max: if not alignleft and colnum0min == colnumCmin: # we want the _poslayoutboxes to line up on left # side of the axes spines... layoutbox.align([ax._poslayoutbox, axc._poslayoutbox], 'left') alignleft = True
if not alignright and colnum0max == colnumCmax: # line up right sides of _poslayoutbox layoutbox.align([ax._poslayoutbox, axc._poslayoutbox], 'right') alignright = True # Vertically align axes spines if they have the # same min or max: if not aligntop and rownum0min == rownumCmin: # line up top of _poslayoutbox _log.debug('rownum0min == rownumCmin') layoutbox.align([ax._poslayoutbox, axc._poslayoutbox], 'top') aligntop = True
if not alignbot and rownum0max == rownumCmax: # line up bottom of _poslayoutbox _log.debug('rownum0max == rownumCmax') layoutbox.align([ax._poslayoutbox, axc._poslayoutbox], 'bottom') alignbot = True ########### # Now we make the widths and heights of position boxes # similar. (i.e the spine locations) # This allows vertically stacked subplots to have # different sizes if they occupy different amounts # of the gridspec: i.e. # gs = gridspec.GridSpec(3,1) # ax1 = gs[0,:] # ax2 = gs[1:,:] # then drows0 = 1, and drowsC = 2, and ax2 # should be at least twice as large as ax1. # But it can be more than twice as large because # it needs less room for the labeling. # # For height, this only needs to be done if the # subplots share a column. For width if they # share a row.
drowsC = (rownumCmax - rownumCmin + 1) drows0 = (rownum0max - rownum0min + 1) dcolsC = (colnumCmax - colnumCmin + 1) dcols0 = (colnum0max - colnum0min + 1)
if not alignheight and drows0 == drowsC: ax._poslayoutbox.constrain_height( axc._poslayoutbox.height * height0 / heightC) alignheight = True elif _in_same_column(colnum0min, colnum0max, colnumCmin, colnumCmax): if height0 > heightC: ax._poslayoutbox.constrain_height_min( axc._poslayoutbox.height * height0 / heightC) # these constraints stop the smaller axes from # being allowed to go to zero height... axc._poslayoutbox.constrain_height_min( ax._poslayoutbox.height * heightC / (height0*1.8)) elif height0 < heightC: axc._poslayoutbox.constrain_height_min( ax._poslayoutbox.height * heightC / height0) ax._poslayoutbox.constrain_height_min( ax._poslayoutbox.height * height0 / (heightC*1.8)) # widths... if not alignwidth and dcols0 == dcolsC: ax._poslayoutbox.constrain_width( axc._poslayoutbox.width * width0 / widthC) alignwidth = True elif _in_same_row(rownum0min, rownum0max, rownumCmin, rownumCmax): if width0 > widthC: ax._poslayoutbox.constrain_width_min( axc._poslayoutbox.width * width0 / widthC) axc._poslayoutbox.constrain_width_min( ax._poslayoutbox.width * widthC / (width0*1.8)) elif width0 < widthC: axc._poslayoutbox.constrain_width_min( ax._poslayoutbox.width * widthC / width0) ax._poslayoutbox.constrain_width_min( axc._poslayoutbox.width * width0 / (widthC*1.8))
""" arrange the subplotspec children of this gridspec, and then recursively do the same of any gridspec children of those gridspecs... """ sschildren = [] for child in gs.children: if child._is_subplotspec_layoutbox(): for child2 in child.children: # check for gridspec children... if child2._is_gridspec_layoutbox(): _arrange_subplotspecs(child2, hspace=hspace, wspace=wspace) sschildren += [child] # now arrange the subplots... for child0 in sschildren: ss0 = child0.artist nrows, ncols = ss0.get_gridspec().get_geometry() if ss0.num2 is None: ss0.num2 = ss0.num1 rowNum0min, colNum0min = divmod(ss0.num1, ncols) rowNum0max, colNum0max = divmod(ss0.num2, ncols) sschildren = sschildren[1:] for childc in sschildren: ssc = childc.artist rowNumCmin, colNumCmin = divmod(ssc.num1, ncols) if ssc.num2 is None: ssc.num2 = ssc.num1 rowNumCmax, colNumCmax = divmod(ssc.num2, ncols) # OK, this tells us the relative layout of ax # with axc thepad = wspace / ncols if colNum0max < colNumCmin: layoutbox.hstack([ss0._layoutbox, ssc._layoutbox], padding=thepad) if colNumCmax < colNum0min: layoutbox.hstack([ssc._layoutbox, ss0._layoutbox], padding=thepad)
#### # vertical alignment thepad = hspace / nrows if rowNum0max < rowNumCmin: layoutbox.vstack([ss0._layoutbox, ssc._layoutbox], padding=thepad) if rowNumCmax < rowNum0min: layoutbox.vstack([ssc._layoutbox, ss0._layoutbox], padding=thepad)
""" Do the layout for a colorbar, to not oeverly pollute colorbar.py
`pad` is in fraction of the original axis size. """ axlb = ax._layoutbox axpos = ax._poslayoutbox axsslb = ax.get_subplotspec()._layoutbox lb = layoutbox.LayoutBox( parent=axsslb, name=axsslb.name + '.cbar', artist=cax)
if location in ('left', 'right'): lbpos = layoutbox.LayoutBox( parent=lb, name=lb.name + '.pos', tightwidth=False, pos=True, subplot=False, artist=cax)
if location == 'right': # arrange to right of parent axis layoutbox.hstack([axlb, lb], padding=pad * axlb.width, strength='strong') else: layoutbox.hstack([lb, axlb], padding=pad * axlb.width) # constrain the height and center... layoutbox.match_heights([axpos, lbpos], [1, shrink]) layoutbox.align([axpos, lbpos], 'v_center') # set the width of the pos box lbpos.constrain_width(shrink * axpos.height * (1/aspect), strength='strong') elif location in ('bottom', 'top'): lbpos = layoutbox.LayoutBox( parent=lb, name=lb.name + '.pos', tightheight=True, pos=True, subplot=False, artist=cax)
if location == 'bottom': layoutbox.vstack([axlb, lb], padding=pad * axlb.height) else: layoutbox.vstack([lb, axlb], padding=pad * axlb.height) # constrain the height and center... layoutbox.match_widths([axpos, lbpos], [1, shrink], strength='strong') layoutbox.align([axpos, lbpos], 'h_center') # set the height of the pos box lbpos.constrain_height(axpos.width * aspect * shrink, strength='medium')
return lb, lbpos
# helper to get the min/max rows and columns of a list of axes. maxrow = -100000 minrow = 1000000 maxax = None minax = None maxcol = -100000 mincol = 1000000 maxax_col = None minax_col = None
for ax in axs: subspec = ax.get_subplotspec() nrows, ncols, row_start, row_stop, col_start, col_stop = \ subspec.get_rows_columns() if row_stop > maxrow: maxrow = row_stop maxax = ax if row_start < minrow: minrow = row_start minax = ax if col_stop > maxcol: maxcol = col_stop maxax_col = ax if col_start < mincol: mincol = col_start minax_col = ax return (minrow, maxrow, minax, maxax, mincol, maxcol, minax_col, maxax_col)
""" Do the layout for a colorbar, to not oeverly pollute colorbar.py
`pad` is in fraction of the original axis size. """
gs = parents[0].get_subplotspec().get_gridspec() # parent layout box.... gslb = gs._layoutbox
lb = layoutbox.LayoutBox(parent=gslb.parent, name=gslb.parent.name + '.cbar', artist=cax) # figure out the row and column extent of the parents. (minrow, maxrow, minax_row, maxax_row, mincol, maxcol, minax_col, maxax_col) = _getmaxminrowcolumn(parents)
if location in ('left', 'right'): lbpos = layoutbox.LayoutBox( parent=lb, name=lb.name + '.pos', tightwidth=False, pos=True, subplot=False, artist=cax) for ax in parents: if location == 'right': order = [ax._layoutbox, lb] else: order = [lb, ax._layoutbox] layoutbox.hstack(order, padding=pad * gslb.width, strength='strong') # constrain the height and center... # This isn't quite right. We'd like the colorbar # pos to line up w/ the axes poss, not the size of the # gs.
# Horizontal Layout: need to check all the axes in this gridspec for ch in gslb.children: subspec = ch.artist nrows, ncols, row_start, row_stop, col_start, col_stop = \ subspec.get_rows_columns() if location == 'right': if col_stop <= maxcol: order = [subspec._layoutbox, lb] # arrange to right of the parents if col_start > maxcol: order = [lb, subspec._layoutbox] elif location == 'left': if col_start >= mincol: order = [lb, subspec._layoutbox] if col_stop < mincol: order = [subspec._layoutbox, lb] layoutbox.hstack(order, padding=pad * gslb.width, strength='strong')
# Vertical layout: maxposlb = minax_row._poslayoutbox minposlb = maxax_row._poslayoutbox # now we want the height of the colorbar pos to be # set by the top and bottom of the min/max axes... # bottom top # b t # h = (top-bottom)*shrink # b = bottom + (top-bottom - h) / 2. lbpos.constrain_height( (maxposlb.top - minposlb.bottom) * shrink, strength='strong') lbpos.constrain_bottom( (maxposlb.top - minposlb.bottom) * (1 - shrink)/2 + minposlb.bottom, strength='strong')
# set the width of the pos box lbpos.constrain_width(lbpos.height * (shrink / aspect), strength='strong') elif location in ('bottom', 'top'): lbpos = layoutbox.LayoutBox( parent=lb, name=lb.name + '.pos', tightheight=True, pos=True, subplot=False, artist=cax)
for ax in parents: if location == 'bottom': order = [ax._layoutbox, lb] else: order = [lb, ax._layoutbox] layoutbox.vstack(order, padding=pad * gslb.width, strength='strong')
# Vertical Layout: need to check all the axes in this gridspec for ch in gslb.children: subspec = ch.artist nrows, ncols, row_start, row_stop, col_start, col_stop = \ subspec.get_rows_columns() if location == 'bottom': if row_stop <= minrow: order = [subspec._layoutbox, lb] if row_start > maxrow: order = [lb, subspec._layoutbox] elif location == 'top': if row_stop < minrow: order = [subspec._layoutbox, lb] if row_start >= maxrow: order = [lb, subspec._layoutbox] layoutbox.vstack(order, padding=pad * gslb.width, strength='strong')
# Do horizontal layout... maxposlb = maxax_col._poslayoutbox minposlb = minax_col._poslayoutbox lbpos.constrain_width((maxposlb.right - minposlb.left) * shrink) lbpos.constrain_left( (maxposlb.right - minposlb.left) * (1-shrink)/2 + minposlb.left) # set the height of the pos box lbpos.constrain_height(lbpos.width * shrink * aspect, strength='medium')
return lb, lbpos |