matplotlib.contour

Классы для поддержки построения контурных графиков и добавления подписей в класс Axes.

classmatplotlib.contour.ContourLabeler[исходный код]

Базовые классы: object

Примесь, предоставляющая возможность добавления подписей в ContourSet.

add_label(x, y, rotation, lev, cvalue)[исходный код]: Добавить подпись контура с учетом того, задан ли параметр use_clabeltext.

add_label_near(x, y, inline=True, inline_spacing=5, transform=None)[исходный код]

Добавить подпись рядом с точкой (x, y).

Параметры:

x, yfloat: Приблизительное расположение подписи.
inlinebool, по умолчанию: True: Если True, удалить сегмент контура под подписью.
inline_spacingint, по умолчанию: 5: Отступ в пикселях с каждой стороны подписи при размещении внутри контура. Для подписей на прямых участках контура этот отступ будет точным, а на изогнутых участках — менее точным.
transformTransform или False, по умолчанию: self.axes.transData: Преобразование, применяемое к (x, y) перед добавлением подписи. По умолчанию (x, y) интерпретируется как координаты данных. False — синоним IdentityTransform; то есть (x, y) следует интерпретировать как координаты отображения.

clabel(levels=None, *, fontsize=None, inline=True, inline_spacing=5, fmt=None, colors=None, use_clabeltext=False, manual=False, rightside_up=True, zorder=None)[исходный код]

Добавить подписи к контурному графику.

Добавляет подписи к линейным контурам в этом ContourSet (который наследует этот класс-примесь).

Параметры:

levelsмассив или подобный ему объект, необязательный

Список значений уровней, к которым следует добавить подписи. Список должен быть подмножеством cs.levels. Если не задан, подписи добавляются ко всем уровням.

fontsizestr или float, по умолчанию: rcParams["font.size"] (по умолчанию: 10.0)

Размер в пунктах или относительный размер, например 'smaller', 'x-large'. Допустимые строковые значения см. в Text.set_size.

colorsцвет или цвета, или None, по умолчанию: None

Цвета подписей:

Если задано None, цвет каждой подписи совпадает с цветом соответствующего контура.
Если задан один строковый цвет, например colors = 'r' или colors = 'red', все подписи будут отображены этим цветом.
Если задан кортеж цветов (строка, float, RGB и т. д.), разные подписи будут отображены разными цветами в указанном порядке.

inlinebool, по умолчанию: True

Если True, лежащий под подписью контур удаляется.

inline_spacingfloat, по умолчанию: 5

Отступ в пикселях с каждой стороны подписи при ее размещении внутри контура.

Для подписей на прямых участках контура этот отступ будет точным, а на изогнутых участках — менее точным.

fmtFormatter или str, или вызываемый объект, или dict, необязательный

Форматирование уровней:

Если задан Formatter, он используется для форматирования всех уровней одновременно с помощью метода Formatter.format_ticks.
Если задан str, он интерпретируется как строка форматирования в стиле %-формата.
Если задан вызываемый объект, он вызывается для каждого уровня по отдельности и должен возвращать соответствующую подпись.
Если задан dict, он должен напрямую сопоставлять уровни с подписями.

По умолчанию используется стандартный ScalarFormatter.

manualbool или итерируемый объект, по умолчанию: False

Если True, подписи контуров размещаются вручную с помощью щелчков мышью. Щелкните первой кнопкой рядом с контуром, чтобы добавить подпись, а второй кнопкой (или, возможно, обеими кнопками мыши одновременно), чтобы завершить добавление подписей. Третью кнопку можно использовать для удаления последней добавленной подписи, но только если подписи размещены не внутри контура. Также для выбора мест расположения подписей можно использовать клавиатуру (нажмите Enter, чтобы завершить размещение подписей; Delete или Backspace действуют как третья кнопка мыши, а любая другая клавиша выбирает место для подписи).

manual также может быть итерируемым объектом из кортежей (x, y). Подписи контуров будут созданы так, как если бы мышью щелкнули в каждой позиции (x, y).

rightside_upbool, по умолчанию: True

Если True, поворот подписей всегда будет составлять плюс или минус 90 градусов относительно уровня.

use_clabeltextbool, по умолчанию: False

Если True, использовать Text.set_transform_rotates_text, чтобы поворот подписи обновлялся при каждом изменении соотношения сторон Axes.

zorderfloat или None, по умолчанию: (2 + contour.get_zorder())

zorder подписей контуров.

Возвращает:

labels: Список экземпляров Text для подписей.

get_text(lev, fmt)[исходный код]: Получить текст подписи.

labels(inline, inline_spacing)[исходный код]

locate_label(linecontour, labelwidth)[исходный код]: Найти подходящее место для отрисовки подписи (относительно плоский участок контура).

pop_label(index=-1)[исходный код]: По умолчанию удаляет последнюю подпись, но можно указать любой индекс.

print_label(linecontour, labelwidth)[исходный код]: Возвращает, достаточно ли длинный контур для размещения подписи.

remove()[исходный код]

too_close(x, y, lw)[исходный код]: Возвращает, находится ли уже подпись рядом с этой точкой.

classmatplotlib.contour.ContourSet(ax, *args, levels=None, filled=False, linewidths=None, linestyles=None, hatches=(None,), alpha=None, origin=None, extent=None, cmap=None, colors=None, norm=None, vmin=None, vmax=None, colorizer=None, extend='neither', antialiased=None, nchunk=0, locator=None, transform=None, negative_linestyles=None, clip_path=None, **kwargs)[исходный код]

Базовые классы: ContourLabeler, Collection

Хранит набор линий уровня или закрашенных областей.

Вызываемый пользователем метод: clabel

Параметры:

axAxes

levels[level0, level1, ..., leveln]

Список чисел с плавающей точкой, задающих уровни контура.

allsegs[level0segs, level1segs, ...]

Список всех сегментов полигонов для всех уровней. Для линий уровня len(allsegs) == len(levels), а для закрашенных областей контура len(allsegs) = len(levels)-1. Списки должны иметь вид

level0segs = [polygon0, polygon1, ...]
polygon0 = [[x0, y0], [x1, y1], ...]

allkindsNone или [level0kinds, level1kinds, ...]

Необязательный список типов вершин полигонов (типов кодов), описанных и используемых в Path. Он позволяет задавать пути с несколькими компонентами, например отверстия внутри закрашенных полигонов. Если не None, len(allkinds) == len(allsegs). Списки должны иметь вид

level0kinds = [polygon0kinds, ...]
polygon0kinds = [vertexcode0, vertexcode1, ...]

Если allkinds не None, обычно все полигоны для определённого уровня контура группируются вместе, так что level0segs = [polygon0] и level0kinds = [polygon0kinds].

**kwargs

Именованные аргументы описаны в строке документации contour.

Атрибуты:

levelsarray: Значения уровней контура.
layersarray: Для линейных контуров совпадает с уровнями; для закрашенных контуров — находится посередине между уровнями. См. ContourSet._process_colors.

Рисует линии уровня или закрашенные области в зависимости от того, задан ли именованный аргумент filled как False (по умолчанию) или True.

Сигнатура вызова:

ContourSet(ax, levels, allsegs, [allkinds], **kwargs)

Параметры:

axAxes

Объект Axes, на котором будет выполнено рисование.

levels[level0, level1, ..., leveln]

Список чисел с плавающей точкой, задающих уровни контура.

allsegs[level0segs, level1segs, ...]

level0segs = [polygon0, polygon1, ...]
polygon0 = [[x0, y0], [x1, y1], ...]

allkinds[level0kinds, level1kinds, ...], optional

level0kinds = [polygon0kinds, ...]
polygon0kinds = [vertexcode0, vertexcode1, ...]

**kwargs

Именованные аргументы описаны в строке документации contour.

propertyallkinds

propertyallsegs

propertyalpha

changed()[исходный код]: Вызывайте этот метод при каждом изменении отображаемого объекта, чтобы уведомить всех слушателей callbackSM о сигнале 'changed'.

draw(renderer)[исходный код]

Рисует Artist (и его дочерние элементы) с помощью указанного средства визуализации.

Не оказывает эффекта, если художник не виден (метод Artist.get_visible возвращает False).

Параметры:

rendererподкласс RendererBase.

Примечания

Этот метод переопределяется в подклассах Artist.

find_nearest_contour(x, y, indices=None, pixel=True)[исходный код]

Находит точку на графике контуров, ближайшую к (x, y).

Этот метод не поддерживает закрашенные контуры.

Параметры:

x, yfloat: Опорная точка.
indiceslist of int or None, default: None: Индексы учитываемых уровней контура. Если значение равно None (по умолчанию), учитываются все уровни.
pixelbool, default: True: Если значение равно True, расстояние измеряется в пиксельном (экранном) пространстве, что удобно для ручной разметки контуров; в противном случае расстояние измеряется в пространстве координат осей.

Возвращает:

pathint: Индекс пути, ближайшего к (x, y). Каждый путь соответствует одному уровню контура.
subpathint: Индекс подпути в ближайшем пути, который ближе всего к (x, y). Каждый подпуть соответствует одной непрерывной линии контура.
indexint: Индекс вершин в этом подпути, ближайших к (x, y).
xmin, yminfloat: Точка на графике контуров, ближайшая к (x, y).
d2float: Квадрат расстояния от (xmin, ymin) до (x, y).

get_transform()[исходный код]: Возвращает экземпляр Transform, используемый этим ContourSet.

legend_elements(variable_name='x', str_format=<class 'str'>)[исходный код]

Возвращает список художников и подписей, подходящий для передачи в legend и представляющий этот ContourSet.

Подписи имеют вид "0 < x <= 1" и указывают диапазоны данных, представленные художниками.

Параметры:

variable_namestr: Строка, используемая в неравенстве в подписях.
str_formatfunction: float -> str: Функция для форматирования чисел в подписях.

Возвращает:

artistslist[Artist]: Список художников.
labelslist[str]: Список подписей.

propertylinestyles

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, hatch_linewidth=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[исходный код]

Задаёт несколько свойств одновременно.

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, принимающая массив чисел с плавающей точкой формы (m, n, 3) и значение dpi и возвращающая массив формы (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	array-like или float или None
`animated`	bool
`antialiased` or `aa` or `antialiaseds`	bool или список значений bool
`array`	array-like или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`cmap`	`Colormap` или str или None
`color`	цвет или список кортежей RGBA
`edgecolor` или `ec` или `edgecolors`	цвет или список значений цвета или 'face'
`facecolor` или `facecolors` или `fc`	цвет или список значений цвета
`figure`	`Figure` или `SubFigure`
`gid`	str
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`hatch_linewidth`	неизвестно
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	object
`linestyle` или `dashes` или `linestyles` или `ls`	str или tuple, или список таких значений
`linewidth` или `linewidths` или `lw`	float или список значений float
`mouseover`	bool
`norm`	`Normalize` или str или None
`offset_transform` или `transOffset`	`Transform`
`offsets`	array-like формы (N, 2) или (2,)
`path_effects`	список объектов `AbstractPathEffect`
`paths`	неизвестно
`picker`	None или bool или float или вызываемый объект
`pickradius`	float
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	str
`urls`	список значений str или None
`visible`	bool
`zorder`	float

classmatplotlib.contour.QuadContourSet(ax, *args, levels=None, filled=False, linewidths=None, linestyles=None, hatches=(None,), alpha=None, origin=None, extent=None, cmap=None, colors=None, norm=None, vmin=None, vmax=None, colorizer=None, extend='neither', antialiased=None, nchunk=0, locator=None, transform=None, negative_linestyles=None, clip_path=None, **kwargs)[исходный код]

Базовые классы: ContourSet

Создаёт и хранит набор контурных линий или залитых областей.

Обычно пользователь не создаёт экземпляр этого класса напрямую; это делают contour и contourf.

Атрибуты:

levelsмассив: Значения уровней контуров.
layersмассив: Для линейных контуров совпадает с уровнями; для залитых контуров — значения посередине между уровнями. См. ContourSet._process_colors.

Рисует контурные линии или залитые области в зависимости от того, имеет ли именованный аргумент filled значение False (по умолчанию) или True.

Сигнатура вызова:

ContourSet(ax, levels, allsegs, [allkinds], **kwargs)

Параметры:

axAxes

Объект Axes, на котором выполняется рисование.

levels[level0, level1, ..., leveln]

Список чисел с плавающей точкой, задающих уровни контуров.

allsegs[level0segs, level1segs, ...]

Список всех сегментов многоугольников для всех уровней. Для контурных линий len(allsegs) == len(levels), а для залитых областей контура len(allsegs) = len(levels)-1. Списки должны иметь следующий вид:

level0segs = [polygon0, polygon1, ...]
polygon0 = [[x0, y0], [x1, y1], ...]

allkinds[level0kinds, level1kinds, ...], необязательный

Необязательный список типов вершин всех многоугольников (типы кодов), описанных и используемых в Path. Он позволяет использовать пути с несколькими связными компонентами, например отверстия внутри залитых многоугольников. Если значение не None, len(allkinds) == len(allsegs). Списки должны иметь следующий вид:

level0kinds = [polygon0kinds, ...]
polygon0kinds = [vertexcode0, vertexcode1, ...]

Если allkinds не None, обычно все многоугольники для определённого уровня контура объединяются, чтобы level0segs = [polygon0] и level0kinds = [polygon0kinds].

**kwargs

Именованные аргументы описаны в строке документации contour.

Задаёт несколько свойств одновременно.

Поддерживаются следующие свойства:

Свойство	Описание
`agg_filter`	функция фильтрации, принимающая массив чисел с плавающей точкой формы (m, n, 3) и значение dpi и возвращающая массив формы (m, n, 3) и два смещения относительно нижнего левого угла изображения
`alpha`	массивоподобный объект, float или None
`animated`	bool
`antialiased` или `aa` или `antialiaseds`	bool или список значений bool
`array`	массивоподобный объект или None
`capstyle`	`CapStyle` или {'butt', 'projecting', 'round'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`cmap`	`Colormap` или str или None
`color`	цвет или список кортежей RGBA
`edgecolor` или `ec` или `edgecolors`	цвет или список цветов или 'face'
`facecolor` или `facecolors` или `fc`	цвет или список цветов
`figure`	`Figure` или `SubFigure`
`gid`	str
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`hatch_linewidth`	неизвестно
`in_layout`	bool
`joinstyle`	`JoinStyle` или {'miter', 'round', 'bevel'}
`label`	объект
`linestyle` или `dashes` или `linestyles` или `ls`	str, кортеж или список таких значений
`linewidth` или `linewidths` или `lw`	float или список значений float
`mouseover`	bool
`norm`	`Normalize` или str или None
`offset_transform` или `transOffset`	`Transform`
`offsets`	массивоподобный объект формы (N, 2) или (2,)
`path_effects`	список объектов `AbstractPathEffect`
`paths`	неизвестно
`picker`	None, bool, float или вызываемый объект
`pickradius`	float
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`transform`	`Transform`
`url`	str
`urls`	список значений str или None
`visible`	bool
`zorder`	float