Панель цветовой шкалы

matplotlib.colorbar

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

ColorbarBase: базовый класс с полным функционалом построения цветовой панели. Его можно использовать непосредственно для создания цветовой панели для заданной цветовой карты; объект mappable (например, изображение) не требуется.
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, если эти линии следует добавить к любым существующим линиям.

minorticks_off() [source]: Отключает второстепенные деления на цветовой панели.

minorticks_on() [source]: Включает второстепенные деления на цветовой панели без выхода за пределы областей расширения.

on_mappable_changed(mappable) [source]

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

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

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

update_bruteforce(mappable) [source]: Уничтожает и перестраивает цветовую панель. Предполагается, что это станет устаревшим, и, вероятно, будет исключено из использования. Оно не вызывается при использовании функций pyplot.colorbar или метода Figure.colorbar для создания цветовой панели.

update_normal(mappable) [source]: Обновляет твердые линии и т. д. В отличие от 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='') [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` Экземпляр осей, на котором отображается полоса цвета. `lines : list` Список линий, если были нарисованы линии, иначе пустой список. `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]: Вычисляет свободные параметры на основе текущей цветовой карты и нормализации и выполняет все отрисовки.

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']: Положение относительно родителей, где должны быть созданы оси полосы цвета. Если 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, *, fraction=0.15, shrink=1.0, aspect=20, **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, который необходимо передать при создании экземпляра цветовой шкалы.