Skip to content
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

Jump to bottom

Colorbar label improvements #93

Merged
merged 2 commits into from
Mar 19, 2013
Merged

Colorbar label improvements #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3aa3e67
Allow colorbar label font and rotation to be customized
astrofrog Mar 18, 2013
02699b6
Added option to modify colorbar axis label padding
astrofrog Mar 18, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
138 changes: 115 additions & 23 deletions aplpy/colorbar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,11 @@ def __init__(self, parent):
self._parameters = parent._parameters

self._base_settings = {}
self._label_fontproperties = FontProperties()
self._ticklabel_fontproperties = FontProperties()
self._axislabel_fontproperties = FontProperties()

@auto_refresh
def show(self, location='right', width=0.2, pad=0.05, ticks=None, labels=True, box=None, box_orientation='vertical', label_text=None):
def show(self, location='right', width=0.2, pad=0.05, ticks=None, labels=True, box=None, box_orientation='vertical', axis_label_text=None, axis_label_rotation=None, axis_label_pad=5):
'''
Show a colorbar on the side of the image.

Expand Down Expand Up @@ -58,7 +59,7 @@ def show(self, location='right', width=0.2, pad=0.05, ticks=None, labels=True, b
The orientation of the colorbar within the box. Can be
'horizontal' or 'vertical'

*label_text* [ str ]
*axis_label_text* [ str ]
Optional text label of the colorbar.
'''

Expand All @@ -69,7 +70,9 @@ def show(self, location='right', width=0.2, pad=0.05, ticks=None, labels=True, b
self._base_settings['labels'] = labels
self._base_settings['box'] = box
self._base_settings['box_orientation'] = box_orientation
self._base_settings['label_text'] = label_text
self._base_settings['axis_label_text'] = axis_label_text
self._base_settings['axis_label_rotation'] = axis_label_rotation
self._base_settings['axis_label_pad'] = axis_label_pad

if self._parent.image:

Expand Down Expand Up @@ -109,33 +112,44 @@ def show(self, location='right', width=0.2, pad=0.05, ticks=None, labels=True, b
orientation = box_orientation

self._colorbar = self._parent._figure.colorbar(self._parent.image, cax=self._colorbar_axes, orientation=orientation, ticks=ticks)
if label_text:
self._colorbar.set_label(label_text)
if axis_label_text:
if axis_label_rotation:
self._colorbar.set_label(axis_label_text, rotation=axis_label_rotation)
else:
self._colorbar.set_label(axis_label_text)

if location == 'right':
for tick in self._colorbar_axes.yaxis.get_major_ticks():
tick.tick1On = True
tick.tick2On = True
tick.label1On = False
tick.label2On = labels
self._colorbar_axes.yaxis.set_label_position('right')
self._colorbar_axes.yaxis.labelpad = axis_label_pad
elif location == 'top':
for tick in self._colorbar_axes.xaxis.get_major_ticks():
tick.tick1On = True
tick.tick2On = True
tick.label1On = False
tick.label2On = labels
self._colorbar_axes.xaxis.set_label_position('top')
self._colorbar_axes.xaxis.labelpad = axis_label_pad
elif location == 'left':
for tick in self._colorbar_axes.yaxis.get_major_ticks():
tick.tick1On = True
tick.tick2On = True
tick.label1On = labels
tick.label2On = False
self._colorbar_axes.yaxis.set_label_position('left')
self._colorbar_axes.yaxis.labelpad = axis_label_pad
elif location == 'bottom':
for tick in self._colorbar_axes.xaxis.get_major_ticks():
tick.tick1On = True
tick.tick2On = True
tick.label1On = labels
tick.label2On = False
self._colorbar_axes.xaxis.set_label_position('bottom')
self._colorbar_axes.xaxis.labelpad = axis_label_pad

else:

Expand Down Expand Up @@ -164,7 +178,8 @@ def set_location(self, location):
'''
self._base_settings['location'] = location
self.show(**self._base_settings)
self.set_font(fontproperties=self._label_fontproperties)
self.set_font(fontproperties=self._ticklabel_fontproperties)
self.set_axis_label_font(fontproperties=self._axislabel_fontproperties)

@auto_refresh
def set_width(self, width):
Expand All @@ -173,7 +188,8 @@ def set_width(self, width):
'''
self._base_settings['width'] = width
self.show(**self._base_settings)
self.set_font(fontproperties=self._label_fontproperties)
self.set_font(fontproperties=self._ticklabel_fontproperties)
self.set_axis_label_font(fontproperties=self._axislabel_fontproperties)

@auto_refresh
def set_pad(self, pad):
Expand All @@ -182,7 +198,8 @@ def set_pad(self, pad):
'''
self._base_settings['pad'] = pad
self.show(**self._base_settings)
self.set_font(fontproperties=self._label_fontproperties)
self.set_font(fontproperties=self._ticklabel_fontproperties)
self.set_axis_label_font(fontproperties=self._axislabel_fontproperties)

@auto_refresh
def set_ticks(self, ticks):
Expand All @@ -191,7 +208,8 @@ def set_ticks(self, ticks):
'''
self._base_settings['ticks'] = ticks
self.show(**self._base_settings)
self.set_font(fontproperties=self._label_fontproperties)
self.set_font(fontproperties=self._ticklabel_fontproperties)
self.set_axis_label_font(fontproperties=self._axislabel_fontproperties)

@auto_refresh
def set_labels(self, labels):
Expand All @@ -200,7 +218,8 @@ def set_labels(self, labels):
'''
self._base_settings['labels'] = labels
self.show(**self._base_settings)
self.set_font(fontproperties=self._label_fontproperties)
self.set_font(fontproperties=self._ticklabel_fontproperties)
self.set_axis_label_font(fontproperties=self._axislabel_fontproperties)

@auto_refresh
def set_box(self, box, box_orientation='vertical'):
Expand All @@ -213,7 +232,38 @@ def set_box(self, box, box_orientation='vertical'):
self._base_settings['box'] = box
self._base_settings['box_orientation'] = box_orientation
self.show(**self._base_settings)
self.set_font(fontproperties=self._label_fontproperties)
self.set_font(fontproperties=self._ticklabel_fontproperties)
self.set_axis_label_font(fontproperties=self._axislabel_fontproperties)

@auto_refresh
def set_axis_label_text(self, axis_label_text):
'''
Set the colorbar label text
'''
self._base_settings['axis_label_text'] = axis_label_text
self.show(**self._base_settings)
self.set_font(fontproperties=self._ticklabel_fontproperties)
self.set_axis_label_font(fontproperties=self._axislabel_fontproperties)

@auto_refresh
def set_axis_label_rotation(self, axis_label_rotation):
'''
Set the colorbar label rotation
'''
self._base_settings['axis_label_rotation'] = axis_label_rotation
self.show(**self._base_settings)
self.set_font(fontproperties=self._ticklabel_fontproperties)
self.set_axis_label_font(fontproperties=self._axislabel_fontproperties)

@auto_refresh
def set_axis_label_pad(self, axis_label_pad):
'''
Set the colorbar label displacement, in points
'''
self._base_settings['axis_label_pad'] = axis_label_pad
self.show(**self._base_settings)
self.set_font(fontproperties=self._ticklabel_fontproperties)
self.set_axis_label_font(fontproperties=self._axislabel_fontproperties)

# FONT PROPERTIES

Expand All @@ -238,37 +288,79 @@ def set_font(self, family=None, style=None, variant=None, stretch=None, weight=N
'''

if family:
self._label_fontproperties.set_family(family)
self._ticklabel_fontproperties.set_family(family)

if style:
self._label_fontproperties.set_style(style)
self._ticklabel_fontproperties.set_style(style)

if variant:
self._label_fontproperties.set_variant(variant)
self._ticklabel_fontproperties.set_variant(variant)

if stretch:
self._label_fontproperties.set_stretch(stretch)
self._ticklabel_fontproperties.set_stretch(stretch)

if weight:
self._label_fontproperties.set_weight(weight)
self._ticklabel_fontproperties.set_weight(weight)

if size:
self._label_fontproperties.set_size(size)
self._ticklabel_fontproperties.set_size(size)

if fontproperties:
self._label_fontproperties = fontproperties
self._ticklabel_fontproperties = fontproperties

# Update the tick label font properties
for label in self._colorbar_axes.get_xticklabels():
label.set_fontproperties(self._label_fontproperties)
label.set_fontproperties(self._ticklabel_fontproperties)
for label in self._colorbar_axes.get_yticklabels():
label.set_fontproperties(self._label_fontproperties)
label.set_fontproperties(self._ticklabel_fontproperties)

# Also update the offset text font properties
label = self._colorbar_axes.xaxis.get_offset_text()
label.set_fontproperties(self._label_fontproperties)
label.set_fontproperties(self._ticklabel_fontproperties)
label = self._colorbar_axes.yaxis.get_offset_text()
label.set_fontproperties(self._label_fontproperties)
label.set_fontproperties(self._ticklabel_fontproperties)

@auto_refresh
@fixdocstring
def set_axis_label_font(self, family=None, style=None, variant=None, stretch=None, weight=None, size=None, fontproperties=None):
'''
Set the font of the tick labels

Optional Keyword Arguments:

common: family, style, variant, stretch, weight, size, fontproperties

Default values are set by matplotlib or previously set values if
set_font has already been called. Global default values can be set by
editing the matplotlibrc file.
'''

if family:
self._axislabel_fontproperties.set_family(family)

if style:
self._axislabel_fontproperties.set_style(style)

if variant:
self._axislabel_fontproperties.set_variant(variant)

if stretch:
self._axislabel_fontproperties.set_stretch(stretch)

if weight:
self._axislabel_fontproperties.set_weight(weight)

if size:
self._axislabel_fontproperties.set_size(size)

if fontproperties:
self._axislabel_fontproperties = fontproperties

# Update the label font properties
label = self._colorbar_axes.xaxis.get_label()
label.set_fontproperties(self._axislabel_fontproperties)
label = self._colorbar_axes.yaxis.get_label()
label.set_fontproperties(self._axislabel_fontproperties)

# FRAME PROPERTIES

Expand Down
13 changes: 13 additions & 0 deletions aplpy/tests/test_colorbar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,16 @@ def test_colorbar_font():
f.colorbar.set_font(size='small', weight='bold', stretch='normal',
family='serif', style='normal', variant='normal')
f.close()


def test_colorbar_axis_label():
data = np.zeros((16, 16))
f = FITSFigure(data)
f.show_grayscale()
f.add_colorbar()
f.colorbar.set_axis_label_text('Flux (MJy/sr)')
f.colorbar.set_axis_label_rotation(45.)
f.colorbar.set_axis_label_font(size='small', weight='bold', stretch='normal',
family='serif', style='normal', variant='normal')
f.colorbar.set_axis_label_pad(5.)
f.close()