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(self, CS, erase=True) [source]

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

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

on_mappable_changed(self, mappable) [source]

Обновляет этот цветовой бар, чтобы соответствовать свойствам отображаемого объекта.

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

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

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

update_normal(self, mappable) [source]

Обновить твёрдые области, линии и т. д.

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

Если норма отображаемого объекта отличается от предыдущей, это сбрасывает локализующую и форматирующую функцию для оси, поэтому, если они были настраиваемы, их необходимо настроить снова. Однако, если норма изменяет только значения vmin, vmax или cmap, то старые форматирующие и локализующие функции будут сохранены.

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]

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

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

Это базовый класс для класса 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(self, levels, colors, linewidths, erase=True) [source]

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

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

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

ax = None: Оси, в которых находится цветовая шкала.

config_axis(self) [source]

draw_all(self) [source]: Вычисление любых свободных параметров на основе текущей цветовой карты и нормы, и выполнение всего рисования.

get_ticks(self, minor=False) [source]: Возвращает метки x осей в виде списка положений.

minorticks_off(self) [source]: Отключает вспомогательные метки на цветовой шкале.

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

n_rasterize = 50

remove(self) [source]: Удаление цветовой шкалы из рисунка

set_alpha(self, alpha) [source]

set_label(self, label, **kw) [source]: Подпись длинной оси цветовой шкалы.

set_ticklabels(self, ticklabels, update_ticks=True) [source]

Установка меток делений.

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

set_ticks(self, ticks, update_ticks=True) [source]

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

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

update_ticks(self) [source]: Принудительное обновление меток делений. Это необходимо каждый раз, когда изменяется локатор меток и/или форматтер меток.

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

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

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

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

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

Создает цветовой бар на заданных осях для заданного mappable.

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

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