Python matplotlib AnchoredSizeBar用法及代码示例

本文简要介绍 python 语言中mpl_toolkits.axes_grid1.anchored_artists.AnchoredSizeBar的用法。

用法

class mpl_toolkits.axes_grid1.anchored_artists.AnchoredSizeBar(transform, size, label, loc, pad=0.1, borderpad=0.1, sep=2, frameon=True, size_vertical=0, color='black', label_top=False, fontproperties=None, fill_bar=None, **kwargs)

基础： AnchoredOffsetbox

绘制一个水平比例尺，其下方带有 center-aligned 标签。

参数：

transform Transform

正在使用的坐标系的变换对象，即 matplotlib.axes.Axes.transData 。

size 浮点数

尺寸条的水平长度，以 transform 的坐标给出。

label str

要显示的标签。

loc str

尺寸栏的位置。有效位置为'upper left'、'upper center'、'upper right'、'center left'、'center'、'center right'、'lower left'、'lower center'、'lower right'。为了向后兼容，也接受数值。详情请参见 Legend 的参数loc。

pad 浮点数，默认值：0.1

标签和大小栏周围的填充，以字体大小的一小部分。

borderpad 浮点数，默认值：0.1

边框填充，以字体大小的分数表示。

sep 浮点数，默认值：2

标签和尺寸栏之间的分隔，以磅为单位。

frameon 布尔值，默认值：真

如果为 True，请在水平条和标签周围绘制一个框。

size_vertical 浮点数，默认值：0

尺寸条的垂直长度，以 transform 的坐标给出。

color str，默认值：'black'

尺寸栏和标签的颜色。

label_top 布尔值，默认值：假

如果为 True，则标签将位于尺寸栏上方。

fontproperties FontProperties ，可选

标签文本的字体属性。

fill_bar 布尔型，可选

如果为 True 并且 size_vertical 非零，则尺寸栏将填充尺寸栏指定的颜色。如果 size_vertical 大于零，则默认为 True，否则默认为 False。

**kwargs

关键字参数转发到 AnchoredOffsetbox 。

注意

如果 prop 作为关键字参数传递，但 fontproperties 不是，则 prop 被假定为预期的 fontproperties 。不支持同时使用prop 和fontproperties。

例子

>>> import matplotlib.pyplot as plt
>>> import numpy as np
>>> from mpl_toolkits.axes_grid1.anchored_artists import (
...     AnchoredSizeBar)
>>> fig, ax = plt.subplots()
>>> ax.imshow(np.random.random((10, 10)))
>>> bar = AnchoredSizeBar(ax.transData, 3, '3 data units', 4)
>>> ax.add_artist(bar)
>>> fig.show()

使用所有可选参数

>>> import matplotlib.font_manager as fm
>>> fontprops = fm.FontProperties(size=14, family='monospace')
>>> bar = AnchoredSizeBar(ax.transData, 3, '3 units', 4, pad=0.5,
...                       sep=5, borderpad=0.5, frameon=False,
...                       size_vertical=0.5, color='white',
...                       fontproperties=fontprops)

属性：

size_bar AuxTransformBox

尺寸栏的容器。

txt_label TextArea

尺寸栏标签的容器。