mpl_toolkits.axes_grid1.inset_locator.inset_axes

mpl_toolkits.axes_grid1.inset_locator.inset_axes(parent_axes, width, height, loc='upper right', bbox_to_anchor=None, bbox_transform=None, axes_class=None, axes_kwargs=None, borderpad=0.5)[源代码]

创建具有给定宽度和高度的插入轴。

两种尺寸都可以用英寸或百分比表示。例如,::

inset_axes(parent_axes, width='40%', height='30%', loc=3)

在左下角的插入轴中创建 parent_axes 其跨度超过30%的高度和40%的宽度 parent_axes . 自从使用 inset_axes 当超过这些标准情况时,可能会变得有些棘手,建议阅读 the examples .

参数:
parent_axesmatplotlib.axes.Axesmatplotlib.axes.Axes

用于放置插入轴的轴。

宽度、高度浮动或STR

要创建的插入轴的大小。如果提供了浮球,则其尺寸以英寸为单位,例如 width=1.3 . 如果提供了字符串,则它是以相对单位表示的大小,例如 width='40%' . 默认情况下,即如果两者都不存在 bbox_to_anchor 也不 bbox_transform 它们是相对于父轴指定的。否则,它们将被理解为相对于通过 bbox_to_anchor .

locint或str,默认值:1

放置插入轴的位置。有效位置为:

'upper right'  : 1,
'upper left'   : 2,
'lower left'   : 3,
'lower right'  : 4,
'right'        : 5,
'center left'  : 6,
'center right' : 7,
'lower center' : 8,
'upper center' : 9,
'center'       : 10
bbox_to_anchor 元组或 matplotlib.transforms.BboxBase 可选元组或

B插入轴将锚定到的框。如果没有,则使用(0,0,1,1)的元组,如果 bbox_transform 设置为 parent_axes.transAxesparent_axes.figure.transFigure . 否则, parent_axes.bbox 使用。如果是元组,则可以是 [左、下、宽、高] 或 [左、下] . 如果克沃斯 宽度 和/或 高度 以相对单位指定,2元组 [左、下] 不能使用。注意,除非 bbox_transform 设置后,边界框的单位将在像素坐标中解释。使用时 bbox_to_anchor 对于tuple,还指定 bbox_transform . 这可能经常是轴变换 parent_axes.transAxes .

bbox_transformmatplotlib.transforms.Transform 可选matplotlib.transforms.transform,可选

包含插入轴的bbox的转换。如果没有,A transforms.IdentityTransform 使用。价值 bbox_to_anchor (或其get_points方法的返回值)由 bbox_transform 然后解释为像素坐标中的点(取决于dpi)。你可以提供 bbox_to_anchor 在一些标准化坐标中,并给出适当的变换(例如, parent_axes.transAxes

axes_classmatplotlib.axes.Axes 可选类型matplotlib.axles.axles类型,可选

如果指定,则创建的插入轴将使用此类的构造函数创建。

axes_kwargs可选的

要传递给插入轴的构造函数的关键字参数。有效参数包括:

财产 描述
adjustable 'box'、'datalim'
agg_filter 一种过滤函数,它接受一个(m,n,3)浮点数组和一个dpi值,并返回一个(m,n,3)数组。
alpha 浮动或无
anchor 2-浮点数或'c'、'sw'、's'、'se'、…
animated 布尔
aspect {auto}或num
autoscale_on 布尔
autoscalex_on 布尔
autoscaley_on 布尔
axes_locator 可赎回的 [[轴,渲染器]] Bbox
axisbelow 布尔或“线”
box_aspect 没有,或者是一个数字
clip_box Bbox
clip_on 布尔
clip_path 面片或(路径、变换)或无
contains 未知的
facecolor 或fc 颜色
figure Figure
frame_on 布尔
gid STR
in_layout 布尔
label 对象
navigate 布尔
navigate_mode 未知的
path_effects AbstractPathEffect
picker 无、布尔或可呼叫
position [左、下、宽、高] 或 Bbox
prop_cycle 未知的
rasterization_zorder 浮动或无
rasterized 布尔或无
sketch_params (比例:浮动,长度:浮动,随机性:浮动)
snap 布尔或无
title STR
transform Transform
url STR
visible 布尔
xbound 未知的
xlabel STR
xlim (底部:浮动,顶部:浮动)
xmargin 浮动大于-0.5
xscale “Linear”,“Log”,“SymLog”,“Logit”,…
xticklabels 未知的
xticks 未知的
ybound 未知的
ylabel STR
ylim (底部:浮动,顶部:浮动)
ymargin 浮动大于-0.5
yscale “Linear”,“Log”,“SymLog”,“Logit”,…
yticklabels 未知的
yticks 未知的
zorder 浮动
borderpad浮动,默认值:0.5

插入轴和bbox到锚之间的填充。单位为轴字体大小,即默认字体大小为10点 borderpad = 0.5 相当于填充5个点。

返回:
inset_axesaxes_classaxes_class

已创建插入轴对象。

笔记

意义 bbox_to_anchorbbox_to_transform 与传说的解释不同。bbox_to_anchor的值(或其get_points方法的返回值;默认值为 parent_axes.bbox )由bbox_转换(默认为标识转换)转换,然后解释为像素坐标中的点(取决于dpi)。

因此,以下三个调用是相同的,并创建一个关于 parent_axes ::

axins = inset_axes(parent_axes, "30%", "40%")
axins = inset_axes(parent_axes, "30%", "40%",
                   bbox_to_anchor=parent_axes.bbox)
axins = inset_axes(parent_axes, "30%", "40%",
                   bbox_to_anchor=(0, 0, 1, 1),
                   bbox_transform=parent_axes.transAxes)