colorbar

matplotlib.colorbar

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

ColorbarBase

базовый класс с полным функционалом рисования цветовой шкалы. Его можно использовать напрямую для создания цветовой шкалы для заданной цветовой карты; объект mappable (например, изображение) не требуется.

Colorbar

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

make_axes()

функция для изменения размера области и добавления второй области, подходящей для цветовой шкалы

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

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

Базовые классы: matplotlib.colorbar.ColorbarBase

Этот класс подключает ColorbarBase к ScalarMappable, такому как AxesImage, созданный с помощью imshow().

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

add_lines(CS, erase=True)

Добавляет линии из не заполненного ContourSet в цветовую шкалу.

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

on_mappable_changed(mappable)

Обновляет эту цветовую шкалу, чтобы она соответствовала свойствам mappable.

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

remove()

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

update_bruteforce(mappable)

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

update_normal(mappable)

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

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='')

Базовые классы: matplotlib.cm.ScalarMappable

Отображает цветовую шкалу в существующей области.

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

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

colors.Normalize(clip=False)

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

norm=colors.NoNorm.

Полезные атрибуты:

ax

экземпляр Axes, в котором отображается цветовая шкала

lines

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

dividers

LineCollection, если drawedges True, иначе None

Полезные публичные методы — set_label() и add_lines().

add_lines(levels, colors, linewidths, erase=True)

Рисует линии на цветовой шкале.

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

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

ax = None

Область, в которой находится цветовая шкала.

config_axis()

draw_all()

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

get_ticks(minor=False)

Возвращает метки x в виде списка позиций.

n_rasterize = 50

remove()

Удаляет эту цветовую шкалу с рисунка.

set_alpha(alpha)

set_label(label, **kw)

Назначает метку к длинной оси цветовой шкалы.

set_ticklabels(ticklabels, update_ticks=True)

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

set_ticks(ticks, update_ticks=True)

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

Параметры:	ticks : {None, последовательность, экземпляр Locator} Если None, будет использован локатор по умолчанию. update_ticks : {True, False}, необязательно Если True, расположения делений обновляются немедленно. Если False, используйте update_ticks() для обновления меток вручную.

update_ticks()

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

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

Базовые классы: matplotlib.colorbar.Colorbar

Цветовая шкала, созданная с помощью Patch вместо стандартного pcolor().

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

matplotlib.colorbar.colorbar_factory(cax, mappable, **kwargs)

Создаёт цветовую шкалу в заданной области для заданного mappable.

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

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

Изменение размера и перепозиционирование родительских осей и возвращение дочерних осей, подходящих для цветовой шкалы.

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

location : [None|’left’|’right’|’top’|’bottom’]

Положение, относительно родительских осей, где должны быть созданы оси цветовой шкалы. Если None, значение будет взято из предоставленного orientation, иначе по умолчанию будет «справа».

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, который будет передан при создании экземпляра цветовой шкалы.

matplotlib.colorbar.make_axes_gridspec(parent, **kw)

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

• make_axes_gridspec обрабатывает только ключевой аргумент orientation и не может обрабатывать ключевой аргумент «location».
• make_axes_gridspec следует использовать только с родительскими осями subplot.

• make_axes создает экземпляр Axes. make_axes_gridspec

  создает экземпляр Subplot.

• make_axes обновляет положение

  родителя. make_axes_gridspec заменяет атрибут grid_spec родителя новым.

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

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

orientation

‘vertical’ или ‘horizontal’

Свойство	Описание
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, который будет передан при создании экземпляра цветовой шкалы.