Skip to content

Instantly share code, notes, and snippets.

@matejak

matejak/scalebars.py

Forked from dmeliza/scalebars.py
Created November 17, 2012 22:38
Show Gist options
  • Save matejak/4100881 to your computer and use it in GitHub Desktop.
Save matejak/4100881 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. matejak revised this gist Nov 17, 2012. 1 changed file with 20 additions and 15 deletions.
    35 changes: 20 additions & 15 deletions scalebars.py
    View file
    Original file line number Diff line number Diff line change
    @@ -5,34 +5,39 @@

    from matplotlib.offsetbox import AnchoredOffsetbox
    class AnchoredScaleBar(AnchoredOffsetbox):
    def __init__(self, transform, sizex=0, sizey=0, labelx=None, labely=None, loc=4,
    def __init__(self, transform, size=0, label=None, horizontal = True, style = 'dark', loc=4,
    pad=0.1, borderpad=0.1, sep=2, prop=None, **kwargs):
    """
    Draw a horizontal and/or vertical bar with the size in data coordinate
    of the give axes. A label will be drawn underneath (center-aligned).
    - transform : the coordinate frame (typically axes.transData)
    - sizex,sizey : width of x,y bar, in data units. 0 to omit
    - labelx,labely : labels for x,y bars; None to omit
    - sizex,sizey : width / height of the bar, in data units.
    - label: label for bars; None to omit
    - horizontal: Whether the bar is horizontal (True) or vertical (False)
    - style: Whether the bar is dark ('dark') or bright (anything else)
    - loc : position in containing axes
    - pad, borderpad : padding, in fraction of the legend font size (or prop)
    - sep : separation between labels and bars in points.
    - **kwargs : additional arguments passed to base class constructor
    """
    from matplotlib.patches import Rectangle
    from matplotlib.offsetbox import AuxTransformBox, VPacker, HPacker, TextArea, DrawingArea
    from matplotlib.offsetbox import AuxTransformBox, VPacker, HPacker, TextArea
    import matplotlib.patches as mpatches
    if style == 'dark':
    textcol = 'k'
    else:
    textcol = 'w'
    bars = AuxTransformBox(transform)
    if sizex:
    bars.add_artist(Rectangle((0,0), sizex, 0, fc="none"))
    if sizey:
    bars.add_artist(Rectangle((0,0), 0, sizey, fc="none"))
    endpt = (size, 0) if horizontal else (0, size)
    art = mpatches.FancyArrowPatch((0, 0), endpt, color = textcol,
    arrowstyle = "|-|")
    # This doesn't work; why?
    # arrowstyle = mpatches.ArrowStyle.BarAB(1, 60, 1))
    bars.add_artist(art)

    if sizex and labelx:
    bars = VPacker(children=[bars, TextArea(labelx, minimumdescent=False)],
    align="center", pad=0, sep=sep)
    if sizey and labely:
    bars = HPacker(children=[TextArea(labely), bars],
    align="center", pad=0, sep=sep)
    packer = VPacker if horizontal else HPacker
    bars = packer(children=[bars, TextArea(label, dict(color = textcol), minimumdescent=False)],
    align="center", pad=0, sep=sep)

    AnchoredOffsetbox.__init__(self, loc, pad=pad, borderpad=borderpad,
    child=bars, prop=prop, frameon=False, **kwargs)
  2. @dmeliza dmeliza created this gist Aug 3, 2012.
    71 changes: 71 additions & 0 deletions scalebars.py
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,71 @@
    # -*- coding: utf-8 -*-
    # -*- mode: python -*-
    # Adapted from mpl_toolkits.axes_grid2
    # LICENSE: Python Software Foundation (http://docs.python.org/license.html)

    from matplotlib.offsetbox import AnchoredOffsetbox
    class AnchoredScaleBar(AnchoredOffsetbox):
    def __init__(self, transform, sizex=0, sizey=0, labelx=None, labely=None, loc=4,
    pad=0.1, borderpad=0.1, sep=2, prop=None, **kwargs):
    """
    Draw a horizontal and/or vertical bar with the size in data coordinate
    of the give axes. A label will be drawn underneath (center-aligned).
    - transform : the coordinate frame (typically axes.transData)
    - sizex,sizey : width of x,y bar, in data units. 0 to omit
    - labelx,labely : labels for x,y bars; None to omit
    - loc : position in containing axes
    - pad, borderpad : padding, in fraction of the legend font size (or prop)
    - sep : separation between labels and bars in points.
    - **kwargs : additional arguments passed to base class constructor
    """
    from matplotlib.patches import Rectangle
    from matplotlib.offsetbox import AuxTransformBox, VPacker, HPacker, TextArea, DrawingArea
    bars = AuxTransformBox(transform)
    if sizex:
    bars.add_artist(Rectangle((0,0), sizex, 0, fc="none"))
    if sizey:
    bars.add_artist(Rectangle((0,0), 0, sizey, fc="none"))

    if sizex and labelx:
    bars = VPacker(children=[bars, TextArea(labelx, minimumdescent=False)],
    align="center", pad=0, sep=sep)
    if sizey and labely:
    bars = HPacker(children=[TextArea(labely), bars],
    align="center", pad=0, sep=sep)

    AnchoredOffsetbox.__init__(self, loc, pad=pad, borderpad=borderpad,
    child=bars, prop=prop, frameon=False, **kwargs)

    def add_scalebar(ax, matchx=True, matchy=True, hidex=True, hidey=True, **kwargs):
    """ Add scalebars to axes
    Adds a set of scale bars to *ax*, matching the size to the ticks of the plot
    and optionally hiding the x and y axes
    - ax : the axis to attach ticks to
    - matchx,matchy : if True, set size of scale bars to spacing between ticks
    if False, size should be set using sizex and sizey params
    - hidex,hidey : if True, hide x-axis and y-axis of parent
    - **kwargs : additional arguments passed to AnchoredScaleBars
    Returns created scalebar object
    """
    def f(axis):
    l = axis.get_majorticklocs()
    return len(l)>1 and (l[1] - l[0])

    if matchx:
    kwargs['sizex'] = f(ax.xaxis)
    kwargs['labelx'] = str(kwargs['sizex'])
    if matchy:
    kwargs['sizey'] = f(ax.yaxis)
    kwargs['labely'] = str(kwargs['sizey'])

    sb = AnchoredScaleBar(ax.transData, **kwargs)
    ax.add_artist(sb)

    if hidex : ax.xaxis.set_visible(False)
    if hidey : ax.yaxis.set_visible(False)

    return sb