Skip to content

Make colorbar compatible accepting a list of axes created via gridspec #8755

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 27 commits into from
Closed

Make colorbar compatible accepting a list of axes created via gridspec #8755

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
1b0ac37
Clarify how a FancyArrowPatch behaves
dstansby Jun 2, 2017
070a578
Clarify in display units
dstansby Jun 7, 2017
089818b
Allow divmod to be overridden by numpy
dstansby Jun 9, 2017
b87778e
Various cleanups to backends code.
anntzer Jun 3, 2017
40fa293
Update FreeType version in test_tightlayout4.
QuLogic Jun 2, 2017
c0ecc7d
Add a unique number to any renderer hash keys.
QuLogic Jun 3, 2017
df672df
Update tests that are marked flaky.
QuLogic Jun 3, 2017
9bf168f
Use itertools.count for renderer unique ID.
QuLogic Jun 4, 2017
454e9d6
Simplify cla sharex/sharey code; alternative to #8710
efiring Jun 4, 2017
edfdc53
MNT: colorbar accept numpy array input (#8739)
jklymak Jun 12, 2017
2284e98
Changed normalization in _spectral_helper() to obtain conistent scali…
DietBru May 6, 2017
234089d
Added note to api_changes
DietBru Jun 11, 2017
a62d3e3
Fix contour colour level determination
dstansby Jun 9, 2017
03c00d7
Correct contour level test
dstansby Jun 9, 2017
65f3906
sort input files
bmwiedemann Jun 12, 2017
62aa006
First pass; seems to work. More testing needed
jklymak Jun 13, 2017
fb3f419
First pass; seems to work. More testing needed
jklymak Jun 13, 2017
89857c7
First pass; seems to work. More testing needed
jklymak Jun 13, 2017
c68a411
First pass; seems to work. More testing needed
jklymak Jun 13, 2017
031d356
First change
jklymak Jun 13, 2017
1c5a14e
Aded comments and cleaned up
jklymak Jun 13, 2017
12737f5
Aded comments and cleaned up
jklymak Jun 13, 2017
600253e
Colormap that handles gridspec
jklymak Jun 13, 2017
fd388aa
Colormap that handles gridspec
jklymak Jun 13, 2017
262fa33
Colormap that handles gridspec
jklymak Jun 13, 2017
37998b4
Fixed subplotspec geometry having None
jklymak Jun 13, 2017
d9b49b5
Fixed subplotspec geometry having None, PEP8 errors
jklymak Jun 13, 2017
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
Prev Previous commit
Next Next commit
First change
  • Loading branch information
@jklymak
jklymak committed Jun 13, 2017
commit 031d3565f29d81c54e9ab7e174e33fce4dacf093
117 changes: 98 additions & 19 deletions lib/matplotlib/colorbar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
import matplotlib.patches as mpatches
import matplotlib.path as mpath
import matplotlib.ticker as ticker
import matplotlib.transforms as mtrans
import matplotlib.transforms as mtransforms

from matplotlib import docstring

Expand Down Expand Up @@ -317,7 +317,7 @@ def __init__(self, ax, cmap=None,
linthresh=self.norm.linthresh)
else:
self.formatter = ticker.ScalarFormatter()
elif cbook.is_string_like(format):
elif isinstance(format, six.string_types):
self.formatter = ticker.FormatStrFormatter(format)
else:
self.formatter = format # Assume it is a Formatter
Expand All @@ -344,6 +344,7 @@ def draw_all(self):
Calculate any free parameters based on the current cmap and norm,
and do all the drawing.
'''

self._process_values()
self._find_range()
X, Y = self._mesh()
Expand Down Expand Up @@ -399,6 +400,10 @@ def set_ticks(self, ticks, update_ticks=True):
self.update_ticks()
self.stale = True

def get_ticks(self, minor=False):
"""Return the x ticks as a list of locations"""
return self._tick_data_values

def set_ticklabels(self, ticklabels, update_ticks=True):
"""
set tick labels. Tick labels are updated immediately unless
Expand Down Expand Up @@ -611,6 +616,7 @@ def _ticker(self):
else:
eps = (intv[1] - intv[0]) * 1e-10
b = b[(b <= intv[1] + eps) & (b >= intv[0] - eps)]
self._tick_data_values = b
ticks = self._locate(b)
formatter.set_locs(b)
ticklabels = [formatter(t, i) for i, t in enumerate(b)]
Expand Down Expand Up @@ -681,9 +687,10 @@ def _process_values(self, b=None):
self.norm.vmin = 0
self.norm.vmax = 1

self.norm.vmin, self.norm.vmax = mtrans.nonsingular(self.norm.vmin,
self.norm.vmax,
expander=0.1)
self.norm.vmin, self.norm.vmax = mtransforms.nonsingular(
self.norm.vmin,
self.norm.vmax,
expander=0.1)

b = self.norm.inverse(self._uniform_y(self.cmap.N + 1))

Expand Down Expand Up @@ -1110,17 +1117,19 @@ def make_axes(parents, location=None, orientation=None, fraction=0.15,
parent_anchor = kw.pop('panchor', loc_settings['panchor'])
pad = kw.pop('pad', loc_settings['pad'])

# turn parents into a list if it is not already
parents = np.atleast_1d(parents).ravel().tolist()
# turn parents into a list if it is not already. We do this w/ np
# because `plt.subplots` can return an ndarray and is natural to
# pass to `colorbar`.
parents = np.atleast_1d(parents).ravel()

fig = parents[0].get_figure()
if not all(fig is ax.get_figure() for ax in parents):
raise ValueError('Unable to create a colorbar axes as not all '
'parents share the same figure.')

# take a bounding box around all of the given axes
parents_bbox = mtrans.Bbox.union([ax.get_position(original=True).frozen()
for ax in parents])
parents_bbox = mtransforms.Bbox.union(
[ax.get_position(original=True).frozen() for ax in parents])

pb = parents_bbox
if location in ('left', 'right'):
Expand All @@ -1141,12 +1150,12 @@ def make_axes(parents, location=None, orientation=None, fraction=0.15,

# define a transform which takes us from old axes coordinates to
# new axes coordinates
shrinking_trans = mtrans.BboxTransform(parents_bbox, pb1)
shrinking_trans = mtransforms.BboxTransform(parents_bbox, pb1)

# transform each of the axes in parents using the new transform
for ax in parents:
new_posn = shrinking_trans.transform(ax.get_position())
new_posn = mtrans.Bbox(new_posn)
new_posn = mtransforms.Bbox(new_posn)
ax.set_position(new_posn)
if parent_anchor is not False:
ax.set_anchor(parent_anchor)
Expand All @@ -1155,9 +1164,18 @@ def make_axes(parents, location=None, orientation=None, fraction=0.15,
cax.set_aspect(aspect, anchor=anchor, adjustable='box')
return cax, kw

# helper functions for row,col to index.
def index2rowcolunm(index,ncols):
col = index%ncols + 1
row = int(np.floor(index/ncols)+1)
return row,col
def rowcolunm2index(row,col,ncols):
index = col-1+(row-1)*ncols
return index


@docstring.Substitution(make_axes_kw_doc)
def make_axes_gridspec(parent, **kw):
def make_axes_gridspec(parents, **kw):
Copy link
Member

Choose a reason for hiding this comment

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

Changing the argument name is an API change (as make_akes_gridspec(parent=obj) will be broken).

'''
Resize and reposition a parent axes, and return a child axes
suitable for a colorbar. This function is similar to
Expand Down Expand Up @@ -1204,13 +1222,52 @@ def make_axes_gridspec(parent, **kw):
pad_s = (1. - shrink) * 0.5
wh_ratios = [pad_s, shrink, pad_s]

# make parents a 1-d ndarray if its not already...
parents = np.atleast_1d(parents).ravel()
# get the appropriate subplot spec. Loop through the parents.
gsp0 = parents[0].get_subplotspec().get_gridspec()
minind = 10000
Copy link
Member

Choose a reason for hiding this comment

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

Probably better to use np.inf and -np.inf or use the values from the first parent.

maxind = -10000
for parent in parents:
gsp = parent.get_subplotspec().get_gridspec()
if gsp == gsp0:
ss = parent.get_subplotspec().get_geometry()
print(ss)
if ss[2]<minind:
minind = ss[2]
if ss[3]>maxind:
maxind = ss[3]
else:
pass
# get from maxind and minind to nrows and ncols..
ncols0 = gsp0.get_geometry()[1]
print(ncols0)
print(maxind)

minrow,mincol=index2rowcolunm(minind,ncols0)
maxrow,maxcol=index2rowcolunm(maxind,ncols0)
print('mnind %d maxind %d'%(minind,maxind))
print('mncol %d maxcol %d'%(mincol,maxcol))
print('mnrow %d maxrow %d'%(minrow,maxrow))
nrows = maxrow-minrow+1
ncols = maxcol-mincol+1

print('nrows %d ncols %d'%(nrows,ncols))
print(minind)
print(maxind)
subspec = gridspec.SubplotSpec(gsp0,minind,maxind)
print('GSP0')
print(gsp0.get_geometry())
print(subspec)
print(subspec.get_geometry())

gs_from_subplotspec = gridspec.GridSpecFromSubplotSpec
if orientation == 'vertical':
pad = kw.pop('pad', 0.05)
wh_space = 2 * pad / (1 - pad)

gs = gs_from_subplotspec(1, 2,
subplot_spec=parent.get_subplotspec(),
subplot_spec=subspec,
wspace=wh_space,
width_ratios=[x1 - pad, fraction]
)
Expand All @@ -1220,6 +1277,8 @@ def make_axes_gridspec(parent, **kw):
hspace=0.,
height_ratios=wh_ratios,
)
print(gs)
print(gs2)

anchor = (0.0, 0.5)
panchor = (1.0, 0.5)
Expand All @@ -1228,7 +1287,7 @@ def make_axes_gridspec(parent, **kw):
wh_space = 2 * pad / (1 - pad)

gs = gs_from_subplotspec(2, 1,
subplot_spec=parent.get_subplotspec(),
subplot_spec=subspec,
hspace=wh_space,
height_ratios=[x1 - pad, fraction]
)
Expand All @@ -1243,12 +1302,32 @@ def make_axes_gridspec(parent, **kw):
anchor = (0.5, 1.0)
panchor = (0.5, 0.0)

parent.set_subplotspec(gs[0])
parent.update_params()
parent.set_position(parent.figbox)
parent.set_anchor(panchor)
# we need to repackage the parent axes into gs.
# We need to know where they are in the new gs.
# the new gs has nrows by ncols.
gsnew = gs_from_subplotspec(nrows, ncols, subplot_spec=gs[0])

for parent in parents:
geo=parent.get_subplotspec().get_geometry()
ncol0 = geo[1]
print("Parent Geo:")
print(geo)
oldrow,oldcol = index2rowcolunm(geo[2],ncol0)
newrow = oldrow-minrow+1
newcol = oldcol-mincol+1
newminind = rowcolunm2index(newrow,newcol,ncols)
oldrow,oldcol = index2rowcolunm(geo[3],ncol0)
newrow = oldrow-minrow+1
newcol = oldcol-mincol+1
newmaxind = rowcolunm2index(newrow,newcol,ncols)
print('newminind %d newmaxind %d'%(newminind,newmaxind))

parent.set_subplotspec(gridspec.SubplotSpec(gsnew,newminind,newmaxind))
parent.update_params()
parent.set_position(parent.figbox)
parent.set_anchor(panchor)

fig = parent.get_figure()
fig = parents[0].get_figure()
cax = fig.add_subplot(gs2[1])
cax.set_aspect(aspect, anchor=anchor, adjustable='box')
return cax, kw
Expand Down
Loading