mpl_toolkits.axes_grid1.colorbar

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

ColorbarBase

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

Colorbar

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

make_axes()

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

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

class mpl_toolkits.axes_grid1.colorbar.CbarAxesLocator(locator=None, extend='neither', orientation='vertical') [source]

CbarAxesLocator — это locator осей для цветовой шкалы. Он корректирует положение оси, чтобы освободить место для расширенных концов, то есть расширенные концы расположены за пределами области оси.

locatorthe bbox returned from the locator is used as a

начальное положение оси. Если None, используется axes.bbox.

extend : то же, что и в ColorbarBase orientation : то же, что и в ColorbarBase

get_end_vertices(self) [source]

Возвращает кортеж из двух вершин для расширенных концов цветовой шкалы.

Первая вершина — для минимального конца, вторая — для максимального конца.

get_original_position(self, axes, renderer) [source]

Возвращает исходное положение оси.

get_path_ends(self) [source]

Возвращает пути для расширенных концов.

get_path_patch(self) [source]

Возвращает путь для области оси.

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

Параметры:	normmatplotlib.colors.Normalize (or subclass thereof) Объект нормализации, который масштабирует данные, обычно в интервал [0, 1]. Если None, norm по умолчанию устанавливается как объект colors.Normalize, который инициализирует масштабирование на основе первых обработанных данных. cmapstr or Colormap Цветовая карта, используемая для сопоставления нормализованных значений данных с RGBA-цветами.

add_lines(self, CS) [source]

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

update_bruteforce(self, mappable) [source]

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

update_normal(self, mappable) [source]

Обновляет залитые области, линии и т.д.

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

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

class mpl_toolkits.axes_grid1.colorbar.ColorbarBase(ax, cmap=None, norm=None, alpha=1.0, values=None, boundaries=None, orientation='vertical', extend='neither', spacing='uniform', ticks=None, format=None, drawedges=False, filled=True) [source]

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

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

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

colors.Normalize(clip=False)

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

norm=colors.NoNorm.

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

ax

экземпляр Axes, на котором отрисовывается цветовая шкала

lines

LineCollection, если были нарисованы линии, иначе None

dividers

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

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

Параметры:	normmatplotlib.colors.Normalize (or subclass thereof) Объект нормализации, который масштабирует данные, обычно в интервал [0, 1]. Если None, norm по умолчанию устанавливается как объект colors.Normalize, который инициализирует масштабирование на основе первых обработанных данных. cmapstr or Colormap Цветовая карта, используемая для сопоставления нормализованных значений данных с RGBA-цветами.

add_lines(self, levels, colors, linewidths) [source]

Рисует линии на цветовой шкале. Удаляет существующие линии.

set_alpha(self, alpha) [source]

Устанавливает значение альфа для прозрачности.

set_label_text(self, label, **kw) [source]

Подписывает длинную ось цветовой шкалы.

update_artists(self) [source]

Обновляет элементы цветовой шкалы, filled и ends. Обратите внимание, что lines не обновляются. Это нужно вызывать всякий раз, когда изменяется clim связанного изображения.

mpl_toolkits.axes_grid1.colorbar.colorbar(mappable, cax=None, ax=None, **kw) [source]

Создать шкалу цветовых значений для объекта ScalarMappable.

Документация для тонкого обертки pyplot:

Добавить шкалу цветовых значений к графику.

Подписи функций для интерфейса pyplot; все, кроме первой, также являются подписями методов для метода colorbar():

colorbar(**kwargs)
colorbar(mappable, **kwargs)
colorbar(mappable, cax=cax, **kwargs)
colorbar(mappable, ax=ax, **kwargs)

аргументы:

mappable

объект Image, ContourSet и т.д., к которому относится шкала цветовых значений; этот аргумент обязателен для метода colorbar(), но необязателен для функции colorbar(), которая устанавливает значение по умолчанию для текущего изображения.

ключевые аргументы:

cax

None | объект осей, в который будет нарисована шкала цветовых значений

ax

None | родительский объект осей, из которого будет взято место для новых осей шкалы цветовых значений

Дополнительные ключевые аргументы двух типов:

свойства осей:

Свойство	Описание
orientation	вертикальное или горизонтальное
fraction	0.15; доля исходных осей для шкалы цветовых значений
pad	0.05 при вертикальном расположении, 0.15 при горизонтальном; доля исходных осей между шкалой цветовых значений и новыми осями изображения
shrink	1.0; доля, на которую необходимо уменьшить шкалу цветовых значений
aspect	20; отношение длинных и коротких размеров

свойства шкалы цветовых значений:

Свойство	Описание
extend	[ 'neither' | 'both' | 'min' | 'max' ] Если не 'neither', добавляются стрелки для значений, выходящих за пределы диапазона. Эти значения устанавливаются для заданной цветовой карты с помощью методов colormap set_under и set_over.
spacing	[ 'uniform' | 'proportional' ] Равномерное распределение обеспечивает одинаковое пространство для каждого дискретного цвета; пропорциональное распределение делает пространство пропорциональным интервалу данных.
ticks	[ None | список отметок | объект Locator ] Если None, отметки определяются автоматически из входных данных.
format	[ None | строка форматирования | объект Formatter ] Если None, используется ScalarFormatter. Если задана строка форматирования, например, '%.3f', она используется. Вместо этого может быть задан альтернативный объект Formatter.
drawedges	bool Отображать ли линии на границах цветов.

Следующие свойства, вероятно, будут полезны только в контексте индексированных цветов (то есть, когда у mappable есть norm=NoNorm()) или в других необычных ситуациях.

Свойство	Описание
boundaries	None или последовательность
values	None или последовательность, длина которой на 1 меньше длины последовательности boundaries. Для каждого региона, ограниченного смежными элементами в boundaries, используется цвет, сопоставленный соответствующему значению в values.

Если mappable — ContourSet, его ключевой аргумент extend включается автоматически.

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

Для более точного контроля вы можете вручную указать позиции объектов осей, в которых отображаются mappable и шкала цветовых значений. В этом случае не используйте ни один из ключевых аргументов свойств осей.

Известно, что некоторые просмотрщики векторной графики (svg и pdf) отображают белые пробелы между сегментами шкалы цветовых значений. Это связано с ошибками в просмотрщиках, а не в matplotlib. В качестве обходного решения шкала цветовых значений может быть отображена с наложением сегментов:

cbar = colorbar()
cbar.solids.set_edgecolor("face")
draw()

Однако это имеет негативные последствия в других случаях. В частности, с полупрозрачными изображениями (alpha < 1) и расширениями шкалы цветовых значений, и по умолчанию это отключено (см. вопрос #1188).

возвращает:

Colorbar экземпляр; также см. его базовый класс ColorbarBase. Вызовите метод set_label() для подписи шкалы цветовых значений.

transData объекта cax корректируется таким образом, что пределы в самой длинной оси фактически соответствуют пределам диапазона шкалы цветовых значений. С другой стороны, самая короткая ось имеет пределы данных [1,2], чье нестандартное значение предназначено для предотвращения переполнения при использовании логарифмической шкалы.

mpl_toolkits.axes_grid1.colorbar.make_axes(parent, *, fraction=0.15, shrink=1.0, aspect=20, **kw) [source]

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

cax, kw = make_axes(parent, **kw)

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

orientation

'вертикальное' или 'горизонтальное'

Свойство	Описание
orientation	вертикальное или горизонтальное
fraction	0.15; доля исходных осей для шкалы цветовых значений
pad	0.05 при вертикальном расположении, 0.15 при горизонтальном; доля исходных осей между шкалой цветовых значений и новыми осями изображения
shrink	1.0; доля, на которую необходимо уменьшить шкалу цветовых значений
aspect	20; отношение длинных и коротких размеров

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

Возвращает (cax, kw), дочерние оси и уменьшенный словарь kw.