Spec-Zone.ru › Matplotlib 2.0

mpl_toolkits.axes_grid1.inset_locator

Набор функций и объектов для создания или размещения вставных осей.

class mpl_toolkits.axes_grid1.inset_locator.AnchoredLocatorBase(bbox_to_anchor, offsetbox, loc, borderpad=0.5, bbox_transform=None)

Основывается на: matplotlib.offsetbox.AnchoredOffsetbox

draw(renderer)
class mpl_toolkits.axes_grid1.inset_locator.AnchoredSizeLocator(bbox_to_anchor, x_size, y_size, loc, borderpad=0.5, bbox_transform=None)

Основывается на: mpl_toolkits.axes_grid1.inset_locator.AnchoredLocatorBase

get_extent(renderer)
class mpl_toolkits.axes_grid1.inset_locator.AnchoredZoomLocator(parent_axes, zoom, loc, borderpad=0.5, bbox_to_anchor=None, bbox_transform=None)

Основывается на: mpl_toolkits.axes_grid1.inset_locator.AnchoredLocatorBase

get_extent(renderer)
class mpl_toolkits.axes_grid1.inset_locator.BboxConnector(bbox1, bbox2, loc1, loc2=None, **kwargs)

Основывается на matplotlib.patches.Patch

Соединяет два прямоугольника с помощью прямой линии.

Параметры:

bbox1, bbox2 : matplotlib.transforms.Bbox

Прямоугольники для соединения.

loc1 : {1, 2, 3, 4}

Угол bbox1 для рисования линии. Допустимые значения:

'upper right'  : 1,
'upper left'   : 2,
'lower left'   : 3,
'lower right'  : 4

loc2 : {1, 2, 3, 4}, необязательно

Угол bbox2 для рисования линии. Если None, по умолчанию используется loc1. Допустимые значения:

'upper right'  : 1,
'upper left'   : 2,
'lower left'   : 3,
'lower right'  : 4

**kwargs

Свойства фигуры для нарисованной линии. Допустимые аргументы включают:

Свойство Описание
agg_filter неизвестно
alpha float или None
animated [True | False]
antialiased или aa [True | False] или None по умолчанию
axes экземпляр Axes
capstyle [‘butt’ | ‘round’ | ‘projecting’]
clip_box экземпляр matplotlib.transforms.Bbox
clip_on [True | False]
clip_path [ (Path, Transform) | Patch | None ]
color спецификация цвета matplotlib
contains функция-обработчик
edgecolor или ec спецификация цвета mpl, None, ‘none’, или ‘auto’
facecolor или fc спецификация цвета mpl, или None по умолчанию, или ‘none’ для отсутствия цвета
figure экземпляр matplotlib.figure.Figure
fill [True | False]
gid строка-идентификатор
hatch [‘/’ | ‘\’ | ‘|’ | ‘-‘ | ‘+’ | ‘x’ | ‘o’ | ‘O’ | ‘.’ | ‘*’]
joinstyle [‘miter’ | ‘round’ | ‘bevel’]
label строка или что-либо печатаемое с преобразованием ‘%s’
linestyle или ls [‘solid’ | ‘dashed’, ‘dashdot’, ‘dotted’ | (смещение, последовательность включения/выключения) | '-' | '--' | '-.' | ':' | 'None' | ' ' | '']
linewidth или lw число с плавающей точкой или None по умолчанию
path_effects неизвестно
picker [None|число с плавающей точкой|логическое значение|функция-обработчик]
rasterized [True | False | None]
sketch_params неизвестно
snap неизвестно
transform экземпляр Transform
url строка url
visible [True | False]
zorder любое число
END_OF_DOCUMENT_MARKER
static connect_bbox(bbox1, bbox2, loc1, loc2=None)

Вспомогательная функция для получения пути от одного bbox к другому.

Параметры:

bbox1, bbox2 : matplotlib.transforms.Bbox

Прямоугольные области для соединения.

loc1 : {1, 2, 3, 4}

Угол bbox1 для использования. Допустимые значения:

'upper right'  : 1,
'upper left'   : 2,
'lower left'   : 3,
'lower right'  : 4

loc2 : {1, 2, 3, 4}, необязательно

Угол bbox2 для использования. Если None, по умолчанию используется loc1. Допустимые значения:

'upper right'  : 1,
'upper left'   : 2,
'lower left'   : 3,
'lower right'  : 4
Возвращает:

path : matplotlib.path.Path

Отрезок линии от угла loc1 прямоугольной области bbox1 до угла loc2 прямоугольной области bbox2.

static get_bbox_edge_pos(bbox, loc)

Вспомогательная функция для получения положения угла bbox

Параметры:

bbox : matplotlib.transforms.Bbox

loc : {1, 2, 3, 4}

Угол bbox. Допустимые значения:

'upper right'  : 1,
'upper left'   : 2,
'lower left'   : 3,
'lower right'  : 4
Возвращает:

x, y : float

Координаты угла, указанного loc.

get_path()

Возвращает путь этого фрагмента

class mpl_toolkits.axes_grid1.inset_locator.BboxConnectorPatch(bbox1, bbox2, loc1a, loc2a, loc1b, loc2b, **kwargs)

Основы: mpl_toolkits.axes_grid1.inset_locator.BboxConnector

Подключает два прямоугольника с помощью четырёхугольника.

Четырёхугольник задаётся двумя линиями, которые начинаются и заканчиваются в углах прямоугольников. Четыре стороны четырёхугольника определяются двумя линиями, линия между двумя углами, указанными в bbox1, и линия между двумя углами, указанными в bbox2.

Параметры:

bbox1, bbox2 : matplotlib.transforms.Bbox

Прямоугольные области для подключения.

loc1a, loc2a : {1, 2, 3, 4}

Углы bbox1 и bbox2 для рисования первой линии. Допустимые значения:

'upper right'  : 1,
'upper left'   : 2,
'lower left'   : 3,
'lower right'  : 4

loc1b, loc2b : {1, 2, 3, 4}

Углы bbox1 и bbox2 для рисования второй линии. Допустимые значения:

'upper right'  : 1,
'upper left'   : 2,
'lower left'   : 3,
'lower right'  : 4

**kwargs

Свойства фигуры для нарисованной линии:

Свойство Описание
agg_filter неизвестно
alpha число с плавающей точкой или None
animated [True | False]
antialiased или aa [True | False] или None для значения по умолчанию
axes экземпляр Axes
capstyle [‘butt’ | ‘round’ | ‘projecting’]
clip_box экземпляр matplotlib.transforms.Bbox
clip_on [True | False]
clip_path [ (Path, Transform) | Patch | None ]
color спецификация цвета matplotlib
contains функция-вызов
edgecolor или ec спецификация цвета mpl, None, ‘none’ или ‘auto’
facecolor или fc спецификация цвета mpl или None для значения по умолчанию или ‘none’ для отсутствия цвета
figure экземпляр matplotlib.figure.Figure
fill [True | False]
gid строка-идентификатор
hatch [‘/’ | ‘\’ | ‘|’ | ‘-‘ | ‘+’ | ‘x’ | ‘o’ | ‘O’ | ‘.’ | ‘*’]
joinstyle [‘miter’ | ‘round’ | ‘bevel’]
label строка или что угодно, что можно распечатать с помощью преобразования ‘%s’
linestyle или ls [‘solid’ | ‘dashed’, ‘dashdot’, ‘dotted’ | (offset, on-off-dash-seq) | '-' | '--' | '-.' | ':' | 'None' | ' ' | '']
linewidth или lw число с плавающей точкой или None для значения по умолчанию
path_effects неизвестно
picker [None|число с плавающей точкой|булево значение|функция-вызов]
rasterized [True | False | None]
sketch_params неизвестно
snap неизвестно
transform экземпляр Transform
url строка URL
visible [True | False]
zorder любое число
get_path()

Возвращает путь этой фигуры

class mpl_toolkits.axes_grid1.inset_locator.BboxPatch(bbox, **kwargs)

Базы: matplotlib.patches.Patch

Объект, отображающий форму, ограниченную прямоугольником.

Параметры:

bbox : matplotlib.transforms.Bbox

Прямоугольник для использования в качестве границ этого объекта.

**kwargs

Свойства объекта. Допустимые аргументы включают:

Свойство Описание
agg_filter неизвестно
alpha число с плавающей точкой или None
animated [True | False]
antialiased или aa [True | False] или None для значения по умолчанию
axes экземпляр Axes
capstyle [‘butt’ | ‘round’ | ‘projecting’]
clip_box экземпляр matplotlib.transforms.Bbox
clip_on [True | False]
clip_path [ (Path, Transform) | Patch | None ]
color спецификация цвета matplotlib
contains функция-обработчик
edgecolor или ec спецификация цвета mpl, None, ‘none’, или ‘auto’
facecolor или fc спецификация цвета mpl или None для значения по умолчанию или ‘none’ для отсутствия цвета
figure экземпляр matplotlib.figure.Figure
fill [True | False]
gid строка-идентификатор
hatch [‘/’ | ‘\’ | ‘|’ | ‘-‘ | ‘+’ | ‘x’ | ‘o’ | ‘O’ | ‘.’ | ‘*’]
joinstyle [‘miter’ | ‘round’ | ‘bevel’]
label строка или что-либо отображаемое с преобразованием ‘%s’
linestyle или ls [‘solid’ | ‘dashed’, ‘dashdot’, ‘dotted’ | (смещение, последовательность чередования) | '-' | '--' | '-.' | ':' | 'None' | ' ' | '']
linewidth или lw число с плавающей точкой или None по умолчанию
path_effects неизвестно
picker [None|число с плавающей точкой|логическое значение|функция-обработчик]
rasterized [True | False | None]
sketch_params неизвестно
snap неизвестно
transform экземпляр Transform
url строка URL
visible [True | False]
zorder любое число
get_path()

Возвращает путь этого объекта.

END_OF_DOCUMENT_MARKER
class mpl_toolkits.axes_grid1.inset_locator.InsetPosition(parent, lbwh)

Bases: object

Объект для позиционирования вставной области.

Он создаётся путём указания нормированных координат в области, а не в фигуре.

Параметры:

parent : matplotlib.axes.Axes

Область, используемая для нормализации координат.

lbwh : итерируемый объект из четырёх чисел с плавающей точкой

Левая граница, нижняя граница, ширина и высота вставной области в единицах нормированных координат области parent.

См. также

matplotlib.axes.Axes.set_axes_locator()

Примеры

Следующий пример ограничивает вставную область прямоугольником с высотой 20% и шириной 40% области-родителя. Размер области ([0, 0, 1, 1]) гарантирует, что она полностью заполняет заданный прямоугольник:

>>> parent_axes = plt.gca()
>>> ax_ins = plt.axes([0, 0, 1, 1])
>>> ip = InsetPosition(ax, [0.5, 0.1, 0.4, 0.2])
>>> ax_ins.set_axes_locator(ip)
mpl_toolkits.axes_grid1.inset_locator.inset_axes(parent_axes, width, height, loc=1, bbox_to_anchor=None, bbox_transform=None, axes_class=None, axes_kwargs=None, borderpad=0.5)

Создайте вставную ось с заданной шириной и высотой.

Оба размера можно указать в дюймах или в процентах от родительской оси.

Параметры:

parent_axes : matplotlib.axes.Axes

Ось, на которой размещается вставная ось.

width, height : float или str

Размер создаваемой вставной оси.

loc : int или строка, необязательно, по умолчанию 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, необязательно

Прямоугольник, к которому будет привязана вставная ось. Может быть кортежем [слева, снизу, ширина, высота] или кортежем [слева, снизу].

bbox_transform : matplotlib.transforms.Transform, необязательно

Преобразование для прямоугольника. Если None, используется parent_axes.transAxes.

axes_class : matplotlib.axes.Axes тип, необязательно

Если указано, вставная ось будет создана с использованием конструктора этого класса.

axes_kwargs : dict, необязательно

Аргументы ключевого слова, передаваемые в конструктор вставной оси. Допустимые аргументы включают:

Свойство Описание
adjustable [ ‘box’ | ‘datalim’ | ‘box-forced’]
agg_filter неизвестно
alpha число с плавающей точкой (от 0.0 — прозрачный до 1.0 — непрозрачный)
anchor неизвестно
animated [True | False]
aspect неизвестно
autoscale_on неизвестно
autoscalex_on неизвестно
autoscaley_on неизвестно
axes объект Axes
axes_locator неизвестно
axisbelow [ True | False | ‘line’ ]
clip_box объект matplotlib.transforms.Bbox
clip_on [True | False]
clip_path [ (Path, Transform) | Patch | None ]
color_cycle неизвестно
contains вызываемая функция
facecolor неизвестно
fc неизвестно
figure неизвестно
frame_on [ True | False ]
gid строка идентификатора
label строка или любой печатаемый объект с преобразованием «%s»
navigate [ True | False ]
navigate_mode неизвестно
path_effects неизвестно
picker [None|число с плавающей точкой|логическое значение|вызываемая функция]
position неизвестно
rasterization_zorder неизвестно
rasterized [True | False | None]
sketch_params неизвестно
snap неизвестно
title неизвестно
transform объект Transform
url строка url
visible [True | False]
xbound неизвестно
xlabel неизвестно
xlim неизвестно
xmargin неизвестно
xscale [‘linear’ | ‘log’ | ‘logit’ | ‘symlog’]
xticklabels последовательность строк
xticks последовательность чисел с плавающей точкой
ybound неизвестно
ylabel неизвестно
ylim неизвестно
ymargin неизвестно
yscale [‘linear’ | ‘log’ | ‘logit’ | ‘symlog’]
yticklabels последовательность строк
yticks последовательность чисел с плавающей точкой
zorder любое число

borderpad : float, необязательно

Отступ между вставной осью и прямоугольником bbox_to_anchor. По умолчанию 0.5.

Возвращает:

inset_axes : axes_class

Объект вставной оси, созданный.

mpl_toolkits.axes_grid1.inset_locator.mark_inset(parent_axes, inset_axes, loc1, loc2, **kwargs)

Отрисуйте прямоугольник, чтобы отметить расположение области, представленной вставленным осями.

Эта функция рисует прямоугольник в parent_axes в пределах области отрисовки inset_axes и показывает соединение со вставленными осями, рисуя линии в углах, создавая эффект «приближения».

Параметры:

parent_axes : matplotlib.axes.Axes

Оси, содержащие область вставленных осей.

inset_axes : matplotlib.axes.Axes

Вставленные оси.

loc1, loc2 : {1, 2, 3, 4}

Углы для соединения вставленных осей и области на родительских осях.

**kwargs

Свойства области для нарисованных линий и прямоугольника:

Свойство Описание
agg_filter неизвестно
alpha число с плавающей точкой или None
animated [True | False]
antialiased или aa [True | False] или None по умолчанию
axes объект Axes
capstyle [‘butt’ | ‘round’ | ‘projecting’]
clip_box объект matplotlib.transforms.Bbox
clip_on [True | False]
clip_path [ (Path, Transform) | Patch | None ]
color спецификация цвета matplotlib
contains вызываемая функция
edgecolor или ec спецификация цвета mpl, None, ‘none’, или ‘auto’
facecolor или fc спецификация цвета mpl, или None по умолчанию, или ‘none’ для отсутствия цвета
figure объект matplotlib.figure.Figure
fill [True | False]
gid строка идентификатора
hatch [‘/’ | ‘\’ | ‘|’ | ‘-‘ | ‘+’ | ‘x’ | ‘o’ | ‘O’ | ‘.’ | ‘*’]
joinstyle [‘miter’ | ‘round’ | ‘bevel’]
label строка или любой печатаемый объект с преобразованием ‘%s’
linestyle или ls [‘solid’ | ‘dashed’, ‘dashdot’, ‘dotted’ | (смещение, последовательность чередования) | '-' | '--' | '-.' | ':' | 'None' | ' ' | '']
linewidth или lw число с плавающей точкой или None по умолчанию
path_effects неизвестно
picker [None|число с плавающей точкой|булево|вызываемая функция]
rasterized [True | False | None]
sketch_params неизвестно
snap неизвестно
transform объект Transform
url строка url
visible [True | False]
zorder любое число
Возвращаемые значения:

pp : matplotlib.patches.Patch

Область, нарисованная для представления области вставленных осей.

p1, p2 : matplotlib.patches.Patch

Области, соединяющие два угла вставленных осей и её области.

END_OF_DOCUMENT_MARKER
mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes(parent_axes, zoom, loc=1, bbox_to_anchor=None, bbox_transform=None, axes_class=None, axes_kwargs=None, borderpad=0.5)

Создать вставную ось, привязанную к родительской оси, путем масштабирования.

Параметры:

parent_axes : matplotlib.axes.Axes

Ось, на которой будет расположена вставная ось.

zoom : float

Коэффициент масштабирования осей данных. zoom > 1 увеличит координаты (т.е., приблизит), а zoom < 1 уменьшит координаты (т.е., отдалит).

loc : int или строка, необязательно, по умолчанию 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, необязательно

Область, к которой будет привязана вставная ось. Может быть кортежем из [левый, нижний, ширина, высота] или [левый, нижний].

bbox_transform : matplotlib.transforms.Transform, необязательно

Преобразование для области. Если None, используется parent_axes.transAxes.

axes_class : тип matplotlib.axes.Axes, необязательно

Если указано, вставная ось будет создана с использованием этого конструктора.

axes_kwargs : dict, необязательно

Ключевые аргументы для передачи конструктору вставной оси. Допустимые аргументы:

Свойство Описание
adjustable [‘box’ | ‘datalim’ | ‘box-forced’]
agg_filter неизвестно
alpha вещественное число (от 0.0 — прозрачный до 1.0 — непрозрачный)
anchor неизвестно
animated [True | False]
aspect неизвестно
autoscale_on неизвестно
autoscalex_on неизвестно
autoscaley_on неизвестно
axes экземпляр Axes
axes_locator неизвестно
axisbelow [ True | False | ‘line’ ]
clip_box экземпляр matplotlib.transforms.Bbox
clip_on [True | False]
clip_path [ (Path, Transform) | Patch | None ]
color_cycle неизвестно
contains вызываемая функция
facecolor неизвестно
fc неизвестно
figure неизвестно
frame_on [ True | False ]
gid строка идентификатора
label строка или что-либо, что можно распечатать с преобразованием ‘%s’
navigate [ True | False ]
navigate_mode неизвестно
path_effects неизвестно
picker [None|число|логическое значение|вызываемая функция]
position неизвестно
rasterization_zorder неизвестно
rasterized [True | False | None]
sketch_params неизвестно
snap неизвестно
title неизвестно
transform экземпляр Transform
url строка url
visible [True | False]
xbound неизвестно
xlabel неизвестно
xlim неизвестно
xmargin неизвестно
xscale [‘линейный’ | ‘логарифмический’ | ‘логит’ | ‘симлогит’]
xticklabels последовательность строк
xticks последовательность чисел с плавающей точкой
ybound неизвестно
ylabel неизвестно
ylim неизвестно
ymargin неизвестно
yscale [‘линейный’ | ‘логарифмический’ | ‘логит’ | ‘симлогит’]
yticklabels последовательность строк
yticks последовательность чисел с плавающей точкой
zorder любое число

borderpad : float, необязательно

Отступ между вставной осью и bbox_to_anchor. По умолчанию 0.5.

Возвращает:

inset_axes : axes_class

Объект вставной оси, созданный.

© 2012–2017 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
http://matplotlib.org/2.0.2/mpl_toolkits/axes_grid/api/inset_locator_api.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API