Spec-Zone.ru › Matplotlib 2.2

панель_цветов

matplotlib.colorbar

Инструментарий для создания цветовых панелей с двумя классами и функцией:

ColorbarBase
базовый класс с полным функционалом для построения цветовой панели. Он может быть использован напрямую для создания цветовой панели для заданной цветовой карты; объект отображения (например, изображение) не требуется.
Colorbar
производный класс для использования с изображениями или контурными диаграммами.
make_axes()
функция для изменения размера осей и добавления второй оси, подходящей для цветовой панели

Метод colorbar() использует make_axes() и Colorbar; функция colorbar() является тонким оболочкой над colorbar().

class matplotlib.colorbar.Colorbar(ax, mappable, **kw) [source]

Базируется на matplotlib.colorbar.ColorbarBase

Этот класс подключает ColorbarBase к ScalarMappable, например, к AxesImage, сгенерированному с помощью imshow().

Не предназначен для прямого экземплярирования; вместо этого используйте colorbar() или colorbar() для создания цветовой панели.

add_lines(CS, erase=True) [source]

Добавить линии из не залитой ContourSet в цветовую панель.

Установите erase в значение False, если эти линии нужно добавить к любым существующим линиям.

on_mappable_changed(mappable) [source]

Обновляет цветовую панель в соответствии с свойствами отображаемого объекта.

Обычно это автоматически регистрируется как обработчик событий функцией colorbar_factory() и не должно вызываться вручную.

remove() [source]

Удаляет эту цветовую панель из фигуры. Если цветовая панель была создана с use_gridspec=True, восстановите gridspec к его предыдущему значению.

update_bruteforce(mappable) [source]

Уничтожает и перестраивает цветовую панель. Это должно устареть, и, вероятно, будет устаревшим, а затем удалено. Оно не вызывается при использовании функции pyplot.colorbar или метода Figure.colorbar для создания цветовой панели.

update_normal(mappable) [source]

Обновляет твердые элементы, линии и т. д. В отличие от update_bruteforce, оно не очищает оси. Это предназначено для вызова, когда изменяется изображение или контурная диаграмма, к которой принадлежит эта цветовая панель.

END_OF_DOCUMENT_MARKER
class matplotlib.colorbar.ColorbarBase(ax, cmap=None, norm=None, alpha=None, values=None, boundaries=None, orientation='vertical', ticklocation='auto', extend='neither', spacing='uniform', ticks=None, format=None, drawedges=False, filled=True, extendfrac=None, extendrect=False, label='') [source]

Bases: matplotlib.cm.ScalarMappable

Отображает цветовой бар в существующей системе координат.

Это базовый класс для класса Colorbar, который является основой для функции colorbar() и метода colorbar(), которые являются обычными способами создания цветового бара.

Он также полезен сам по себе для отображения цветовой карты. Если передан параметр cmap, но boundaries и values оставлены как None, то цветовая карта будет отображаться в масштабе 0-1. Чтобы отобразить цвета для значений меньше и больше, укажите norm как:

colors.Normalize(clip=False)

Чтобы отобразить цвета по индексу вместо масштаба 0-1, используйте:

norm=colors.NoNorm.

Полезными общедоступными методами являются set_label() и add_lines().

Атрибуты:
ax : Axes

Экземпляр Axes, в котором нарисован цветовой бар.

lines : list

Список LineCollection , если линии были нарисованы, в противном случае пустой список.

dividers : LineCollection

LineCollection, если drawedges — True, в противном случае None.

add_lines(levels, colors, linewidths, erase=True) [source]

Рисует линии на цветовом баре.

colors и linewidths должны быть скалярами или последовательностями той же длины, что и levels.

Установите erase в False, чтобы добавить линии без предварительного удаления ранее добавленных линий.

ax = None

Система координат, в которой находится этот цветовой бар.

config_axis() [source]
draw_all() [source]

Вычисляет любые свободные параметры на основе текущей cmap и norm и выполняет всю отрисовку.

get_ticks(minor=False) [source]

Возвращает метки x как список местоположений.

n_rasterize = 50
remove() [source]

Удаляет этот цветовой бар из фигуры

set_alpha(alpha) [source]
set_label(label, **kw) [source]

Подписывает длинную ось цветового бара

set_ticklabels(ticklabels, update_ticks=True) [source]

Устанавливает метки делений. Метки делений обновляются немедленно, если update_ticks не равно False. Чтобы вручную обновить деления, вызовите метод update_ticks явно.

set_ticks(ticks, update_ticks=True) [source]

Устанавливает расположение делений.

Параметры:
ticks : {None, sequence, Locator instance}

Если None, будет использован локатор по умолчанию.

update_ticks : {True, False}, optional

Если True, расположение делений обновляется немедленно. Если False, используйте update_ticks() для ручного обновления делений.

update_ticks() [source]

Вынуждает обновление делений и меток делений. Это необходимо вызывать всякий раз, когда изменяется локатор делений и/или форматтер меток делений.

class matplotlib.colorbar.ColorbarPatch(ax, mappable, **kw) [source]

Bases: matplotlib.colorbar.Colorbar

Цветовой бар, созданный с помощью Patch вместо стандартного pcolor().

Он использует список экземпляров Patch вместо PatchCollection, потому что последний не позволяет изменять узор штриховки среди элементов коллекции.

matplotlib.colorbar.colorbar_factory(cax, mappable, **kwargs) [source]

Создает цветовой бар на заданной системе координат для заданного отображаемого объекта.

Обычно для автоматического размещения цветового бара, заданного только отображаемым объектом, используйте colorbar().

matplotlib.colorbar.make_axes(parents, location=None, orientation=None, fraction=0.15, shrink=1.0, aspect=20, **kw) [source]

Изменяет размер и расположение родительских осей и возвращает дочернюю систему координат, подходящую для цветового бара.

Ключевые аргументы могут включать следующее (с значениями по умолчанию):

location : [None|'left'|'right'|'top'|'bottom']
Положение, относительное к parents, где должны быть созданы оси цветового бара. Если None, значение будет взято из данного orientation, иначе по умолчанию будет 'right'.
orientation : [None|'vertical'|'horizontal']
Ориентация цветового бара. Обычно этот ключевой аргумент не следует использовать, поскольку он может быть выведен из ключевого аргумента location.
Свойство Описание
orientation вертикальный или горизонтальный
fraction 0.15; доля исходной системы координат, используемая для цветового бара
pad 0.05, если вертикальный, 0.15, если горизонтальный; доля исходной системы координат между цветовым баром и новыми осями изображения
shrink 1.0; доля, на которую умножается размер цветового бара
aspect 20; отношение длинной к короткой стороне
anchor (0.0, 0.5), если вертикальный; (0.5, 1.0), если горизонтальный; точка привязки осей цветового бара
panchor (1.0, 0.5), если вертикальный; (0.5, 0.0), если горизонтальный; точка привязки родительских осей цветового бара. Если False, точка привязки родительских осей не изменится

Возвращает (cax, kw), дочерние оси и изменённый словарь kw, который нужно передать при создании экземпляра цветового бара.

END_OF_DOCUMENT_MARKER
matplotlib.colorbar.make_axes_gridspec(parent, **kw) [source]

Изменение размера и расположения родительских осей и возврат дочерних осей, подходящих для цветовой шкалы. Эта функция похожа на make_axes. Основные различия:

  • make_axes_gridspec обрабатывает только ключевое слово orientation и не может обрабатывать ключевое слово "location".
  • make_axes_gridspec следует использовать только с родительским подграфиком.
  • make_axes создаёт экземпляр Axes. make_axes_gridspec
    создаёт экземпляр Subplot.
  • make_axes обновляет положение
    родителя. make_axes_gridspec заменяет атрибут grid_spec родителя новым.

Хотя эта функция предназначена для совместимости с make_axes, могут быть небольшие различия.

Ключевые аргументы могут включать следующие (с значениями по умолчанию):

orientation
'вертикальный' или 'горизонтальный'
Свойство Описание
orientation вертикальный или горизонтальный
fraction 0,15; доля исходных осей для использования в цветовой шкале
pad 0,05, если вертикальный, 0,15, если горизонтальный; доля исходных осей между цветовой шкалой и новыми осями изображения
shrink 1,0; доля, на которую нужно умножить размер цветовой шкалы
aspect 20; отношение длинной к короткой сторонам
anchor (0,0, 0,5), если вертикальный; (0,5, 1,0), если горизонтальный; точка привязки осей цветовой шкалы
panchor (1,0, 0,5), если вертикальный; (0,5, 0,0), если горизонтальный; точка привязки родительских осей цветовой шкалы. Если False, точка привязки родительских осей не изменится

Все, кроме первого из них, удаляются из входного набора kw.

Возвращает (cax, kw), дочерние оси и уменьшенный словарь kw, который необходимо передать при создании экземпляра цветовой шкалы.

© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/2.2.3/api/colorbar_api.html

Spec-Zone.ru

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